Skip to main content

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

client/method-helpers/indicesGetFieldMapping

Functions​

convertIndicesGetFieldMappingParams()​

convertIndicesGetFieldMappingParams(params, distributionMeta): { allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; fields: string | string[]; ignore_unavailable?: boolean; include_defaults?: boolean; index?: string | string[]; local?: boolean; } | { allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; fields: string | string[]; ignore_unavailable?: boolean; include_defaults?: boolean; index?: string | string[]; local?: boolean; type: string | string[]; }

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

Parameters​

ParameterType
paramsIndicesGetFieldMappingParams
distributionMetaClientMetadata

Returns​

{ allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; fields: string | string[]; ignore_unavailable?: boolean; include_defaults?: boolean; index?: string | string[]; local?: boolean; } | { allow_no_indices?: boolean; expand_wildcards?: ExpandWildcards; fields: string | string[]; ignore_unavailable?: boolean; include_defaults?: boolean; index?: string | string[]; local?: boolean; type: string | string[]; }