@terascope/opensearch-client / client/method-helpers/clusterHealth

client/method-helpers/clusterHealth

Functions

convertClusterHealthParams()

convertClusterHealthParams(params, distributionMeta): object

Defined in: opensearch-client/src/client/method-helpers/clusterHealth.ts:3

Parameters

Parameter	Type
params	ClusterHealthParams
distributionMeta	ClientMetadata

Returns

object

index?

optional index: string | string[]

level?

optional level: "cluster" | "indices" | "shards"

local?

optional local: boolean

timeout?

optional timeout: string

wait_for_active_shards?

optional wait_for_active_shards: string

wait_for_events?

optional wait_for_events: "immediate" | "urgent" | "high" | "normal" | "low" | "languid"

wait_for_no_initializing_shards?

optional wait_for_no_initializing_shards: boolean

wait_for_no_relocating_shards?

optional wait_for_no_relocating_shards: boolean

wait_for_nodes?

optional wait_for_nodes: string

wait_for_status?

optional wait_for_status: Health