Elasticsearch Store: `Elasticsearch Client Interfaces Client Config`
elasticsearch-client/interfaces.ClientConfig
Hierarchy
ClientOptions
↳
ClientConfig
Table of contents
Properties
- agent
- auth
- cloud
- compression
- enableMetaHeader
- headers
- maxRetries
- memoryCircuitBreaker
- name
- node
- nodes
- opaqueIdPrefix
- password
- pingTimeout
- proxy
- requestTimeout
- resurrectStrategy
- sniffEndpoint
- sniffInterval
- sniffOnConnectionFault
- sniffOnStart
- ssl
- suggestCompression
- username
Properties
agent
• Optional
agent: false
| AgentOptions
Inherited from
ClientOptions.agent
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:39
auth
• Optional
auth: Object
Type declaration
Name | Type |
---|---|
password | string |
username | string |
Inherited from
ClientOptions.auth
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:43
cloud
• Optional
cloud: Object
Type declaration
Name | Type |
---|---|
id | string |
password? | string |
username? | string |
Inherited from
ClientOptions.cloud
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:49
compression
• Optional
compression: "gzip"
Inherited from
ClientOptions.compression
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:37
enableMetaHeader
• Optional
enableMetaHeader: boolean
Inherited from
ClientOptions.enableMetaHeader
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:48
headers
• Optional
headers: Record
<string
, any
>
Inherited from
ClientOptions.headers
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:40
maxRetries
• Optional
maxRetries: number
Inherited from
ClientOptions.maxRetries
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:28
memoryCircuitBreaker
• Optional
memoryCircuitBreaker: Object
Type declaration
Name | Type |
---|---|
enabled | boolean |
maxPercentage | number |
Inherited from
ClientOptions.memoryCircuitBreaker
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:55
name
• Optional
name: string
| symbol
Inherited from
ClientOptions.name
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:42
node
• Optional
node: string
| string
[] | NodeOptions
| NodeOptions
[]
Inherited from
ClientOptions.node
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:26
nodes
• Optional
nodes: string
| string
[] | NodeOptions
| NodeOptions
[]
Inherited from
ClientOptions.nodes
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:27
opaqueIdPrefix
• Optional
opaqueIdPrefix: string
Inherited from
ClientOptions.opaqueIdPrefix
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:41
password
• Optional
password: string
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:62
pingTimeout
• Optional
pingTimeout: number
Inherited from
ClientOptions.pingTimeout
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:30
proxy
• Optional
proxy: string
| URL
Inherited from
ClientOptions.proxy
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:47
requestTimeout
• Optional
requestTimeout: number
Inherited from
ClientOptions.requestTimeout
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:29
resurrectStrategy
• Optional
resurrectStrategy: "none"
| "ping"
| "optimistic"
Inherited from
ClientOptions.resurrectStrategy
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:35
sniffEndpoint
• Optional
sniffEndpoint: string
Inherited from
ClientOptions.sniffEndpoint
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:33
sniffInterval
• Optional
sniffInterval: number
| boolean
Inherited from
ClientOptions.sniffInterval
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:31
sniffOnConnectionFault
• Optional
sniffOnConnectionFault: boolean
Inherited from
ClientOptions.sniffOnConnectionFault
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:34
sniffOnStart
• Optional
sniffOnStart: boolean
Inherited from
ClientOptions.sniffOnStart
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:32
ssl
• Optional
ssl: ConnectionOptions
Inherited from
ClientOptions.ssl
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:38
suggestCompression
• Optional
suggestCompression: boolean
Inherited from
ClientOptions.suggestCompression
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:36
username
• Optional
username: string
Defined in
elasticsearch-store/src/elasticsearch-client/interfaces.ts:63