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

client/method-helpers/indicesPutMapping

Functions

convertIndicesPutMappingParams()

convertIndicesPutMappingParams(params, distributionMeta): object

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

Parameters

Parameter	Type
params	IndicesPutMappingParams
distributionMeta	ClientMetadata

Returns

object

allow_no_indices?

optional allow_no_indices: boolean

body?

optional body: object

body.all_field?

optional all_field: MappingAllField

body.date_detection?

optional date_detection: boolean

body.dynamic?

optional dynamic: boolean | MappingDynamicMapping

body.dynamic_date_formats?

optional dynamic_date_formats: string[]

body.dynamic_templates?

optional dynamic_templates: Record<string, MappingDynamicTemplate> | Record<string, MappingDynamicTemplate>[]

body.field_names_field?

optional field_names_field: MappingFieldNamesField

body.index_field?

optional index_field: MappingIndexField

body.meta?

optional meta: Record<string, any>

body.numeric_detection?

optional numeric_detection: boolean

body.properties?

optional properties: Record<string, MappingProperty>

body.routing_field?

optional routing_field: MappingRoutingField

body.runtime?

optional runtime: MappingRuntimeFields

body.size_field?

optional size_field: MappingSizeField

body.source_field?

optional source_field: MappingSourceField

cluster_manager_timeout?

optional cluster_manager_timeout: string | number = master_timeout

expand_wildcards?

optional expand_wildcards: ExpandWildcards

ignore_unavailable?

optional ignore_unavailable: boolean

index?

optional index: string | string[]

timeout?

optional timeout: string | number

write_index_only?

optional write_index_only: boolean