Skip to main content

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

client/method-helpers/indicesPutMapping

Functions​

convertIndicesPutMappingParams()​

convertIndicesPutMappingParams(params, distributionMeta): { allow_no_indices?: boolean; body?: { all_field?: MappingAllField; date_detection?: boolean; dynamic?: boolean | MappingDynamicMapping; dynamic_date_formats?: string[]; dynamic_templates?: Record<string, MappingDynamicTemplate> | Record<string, MappingDynamicTemplate>[]; field_names_field?: MappingFieldNamesField; index_field?: MappingIndexField; meta?: Record<string, any>; numeric_detection?: boolean; properties?: Record<string, MappingProperty>; routing_field?: MappingRoutingField; runtime?: MappingRuntimeFields; size_field?: MappingSizeField; source_field?: MappingSourceField; }; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; index?: string | string[]; master_timeout?: string | number; timeout?: string | number; write_index_only?: boolean; } | { allow_no_indices?: boolean; body?: { all_field?: MappingAllField; date_detection?: boolean; dynamic?: boolean | MappingDynamicMapping; dynamic_date_formats?: string[]; dynamic_templates?: Record<string, MappingDynamicTemplate> | Record<string, MappingDynamicTemplate>[]; field_names_field?: MappingFieldNamesField; index_field?: MappingIndexField; meta?: Record<string, any>; numeric_detection?: boolean; properties?: Record<string, MappingProperty>; routing_field?: MappingRoutingField; runtime?: MappingRuntimeFields; size_field?: MappingSizeField; source_field?: MappingSourceField; }; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; include_type_name: boolean; index?: string | string[]; master_timeout?: string | number; timeout?: string | number; type: string; write_index_only?: boolean; }

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

Parameters​

ParameterType
paramsIndicesPutMappingParams
distributionMetaClientMetadata

Returns​

{ allow_no_indices?: boolean; body?: { all_field?: MappingAllField; date_detection?: boolean; dynamic?: boolean | MappingDynamicMapping; dynamic_date_formats?: string[]; dynamic_templates?: Record<string, MappingDynamicTemplate> | Record<string, MappingDynamicTemplate>[]; field_names_field?: MappingFieldNamesField; index_field?: MappingIndexField; meta?: Record<string, any>; numeric_detection?: boolean; properties?: Record<string, MappingProperty>; routing_field?: MappingRoutingField; runtime?: MappingRuntimeFields; size_field?: MappingSizeField; source_field?: MappingSourceField; }; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; index?: string | string[]; master_timeout?: string | number; timeout?: string | number; write_index_only?: boolean; } | { allow_no_indices?: boolean; body?: { all_field?: MappingAllField; date_detection?: boolean; dynamic?: boolean | MappingDynamicMapping; dynamic_date_formats?: string[]; dynamic_templates?: Record<string, MappingDynamicTemplate> | Record<string, MappingDynamicTemplate>[]; field_names_field?: MappingFieldNamesField; index_field?: MappingIndexField; meta?: Record<string, any>; numeric_detection?: boolean; properties?: Record<string, MappingProperty>; routing_field?: MappingRoutingField; runtime?: MappingRuntimeFields; size_field?: MappingSizeField; source_field?: MappingSourceField; }; expand_wildcards?: ExpandWildcards; ignore_unavailable?: boolean; include_type_name: boolean; index?: string | string[]; master_timeout?: string | number; timeout?: string | number; type: string; write_index_only?: boolean; }