BaseElasticSearchClientOptions
Home > @backstage/plugin-search-backend-module-elasticsearch > BaseElasticSearchClientOptions
Base client options that are shared across @opensearch-project/opensearch and @elastic/elasticsearch clients.
Signature:
export interface BaseElasticSearchClientOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| agent? | ElasticSearchAgentOptions | ((opts?: any) => unknown) | false | (Optional) | |
| compression? | 'gzip' | (Optional) | |
| disablePrototypePoisoningProtection? | boolean | 'proto' | 'constructor' | (Optional) | |
| enableMetaHeader? | boolean | (Optional) | |
| headers? | Record<string, any> | (Optional) | |
| maxRetries? | number | (Optional) | |
| name? | string | symbol | (Optional) | |
| nodeFilter? | (connection: any) => boolean | (Optional) | |
| nodeSelector? | ((connections: any[]) => any) | string | (Optional) | |
| opaqueIdPrefix? | string | (Optional) | |
| pingTimeout? | number | (Optional) | |
| proxy? | string | URL | (Optional) | |
| requestTimeout? | number | (Optional) | |
| resurrectStrategy? | 'ping' | 'optimistic' | 'none' | (Optional) | |
| sniffEndpoint? | string | (Optional) | |
| sniffInterval? | number | boolean | (Optional) | |
| sniffOnConnectionFault? | boolean | (Optional) | |
| sniffOnStart? | boolean | (Optional) | |
| ssl? | TLSConnectionOptions | (Optional) | |
| suggestCompression? | boolean | (Optional) | |
| Transport? | ElasticSearchTransportConstructor | (Optional) |