Skip to main content

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

client/method-helpers/indicesGet

Functions

convertIndicesGetParams()

convertIndicesGetParams(params, distributionMeta): object

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

Parameters

ParameterType
paramsIndicesGetParams
distributionMetaClientMetadata

Returns

object

allow_no_indices?

optional allow_no_indices: boolean

expand_wildcards?

optional expand_wildcards: ExpandWildcards

flat_settings?

optional flat_settings: boolean

ignore_unavailable?

optional ignore_unavailable: boolean

include_defaults?

optional include_defaults: boolean

index

index: string | string[]

local?

optional local: boolean

master_timeout?

optional master_timeout: `${number}d` | `${number}h` | `${number}m` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`