Skip to main content

@terascope/types / opensearch-client / ClientConfig

Interface: ClientConfig

Defined in: packages/types/src/opensearch-client.ts:61

Extends

  • ClientOptions

Properties

PropertyTypeInherited fromDefined in
agent?false | AgentOptionsClientOptions.agentpackages/types/src/opensearch-client.ts:39
auth?objectClientOptions.authpackages/types/src/opensearch-client.ts:43
auth.passwordstring-packages/types/src/opensearch-client.ts:45
auth.usernamestring-packages/types/src/opensearch-client.ts:44
caCertificate?string-packages/types/src/opensearch-client.ts:64
cloud?objectClientOptions.cloudpackages/types/src/opensearch-client.ts:49
cloud.idstring-packages/types/src/opensearch-client.ts:50
cloud.password?string-packages/types/src/opensearch-client.ts:53
cloud.username?string-packages/types/src/opensearch-client.ts:52
compression?"gzip"ClientOptions.compressionpackages/types/src/opensearch-client.ts:37
enableMetaHeader?booleanClientOptions.enableMetaHeaderpackages/types/src/opensearch-client.ts:48
headers?Record<string, any>ClientOptions.headerspackages/types/src/opensearch-client.ts:40
maxRetries?numberClientOptions.maxRetriespackages/types/src/opensearch-client.ts:28
memoryCircuitBreaker?objectClientOptions.memoryCircuitBreakerpackages/types/src/opensearch-client.ts:55
memoryCircuitBreaker.enabledboolean-packages/types/src/opensearch-client.ts:56
memoryCircuitBreaker.maxPercentagenumber-packages/types/src/opensearch-client.ts:57
name?string | symbolClientOptions.namepackages/types/src/opensearch-client.ts:42
node?string | string[] | NodeOptions | NodeOptions[]ClientOptions.nodepackages/types/src/opensearch-client.ts:26
nodes?string | string[] | NodeOptions | NodeOptions[]ClientOptions.nodespackages/types/src/opensearch-client.ts:27
opaqueIdPrefix?stringClientOptions.opaqueIdPrefixpackages/types/src/opensearch-client.ts:41
password?string-packages/types/src/opensearch-client.ts:62
pingTimeout?numberClientOptions.pingTimeoutpackages/types/src/opensearch-client.ts:30
proxy?string | URLClientOptions.proxypackages/types/src/opensearch-client.ts:47
requestTimeout?numberClientOptions.requestTimeoutpackages/types/src/opensearch-client.ts:29
resurrectStrategy?"none" | "ping" | "optimistic"ClientOptions.resurrectStrategypackages/types/src/opensearch-client.ts:35
sniffEndpoint?stringClientOptions.sniffEndpointpackages/types/src/opensearch-client.ts:33
sniffInterval?number | booleanClientOptions.sniffIntervalpackages/types/src/opensearch-client.ts:31
sniffOnConnectionFault?booleanClientOptions.sniffOnConnectionFaultpackages/types/src/opensearch-client.ts:34
sniffOnStart?booleanClientOptions.sniffOnStartpackages/types/src/opensearch-client.ts:32
ssl?ConnectionOptionsClientOptions.sslpackages/types/src/opensearch-client.ts:38
suggestCompression?booleanClientOptions.suggestCompressionpackages/types/src/opensearch-client.ts:36
username?string-packages/types/src/opensearch-client.ts:63