Skip to main content

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

client/method-helpers/indicesPutTemplate

Functions​

convertIndicesPutTemplateParams()​

convertIndicesPutTemplateParams(params, distributionMeta): IndicesPutTemplateParams | { aliases: undefined | {[alias: string]: Alias; }; create?: boolean; index_patterns: undefined | string | string[]; mappings: Record<string, any>; master_timeout?: `${number}d` | `${number}h` | `${number}m` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`; name: string; order?: number; settings: undefined | Record<string, any>; version?: undefined; } | { body: undefined | IndexTemplateProperties; create?: boolean; include_type_name: boolean; master_timeout?: `${number}d` | `${number}h` | `${number}m` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`; name: string; order?: number; }

Defined in: opensearch-client/src/client/method-helpers/indicesPutTemplate.ts:5

Parameters​

ParameterType
paramsIndicesPutTemplateParams
distributionMetaClientMetadata

Returns​

IndicesPutTemplateParams | { aliases: undefined | {[alias: string]: Alias; }; create?: boolean; index_patterns: undefined | string | string[]; mappings: Record<string, any>; master_timeout?: `${number}d` | `${number}h` | `${number}m` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`; name: string; order?: number; settings: undefined | Record<string, any>; version?: undefined; } | { body: undefined | IndexTemplateProperties; create?: boolean; include_type_name: boolean; master_timeout?: `${number}d` | `${number}h` | `${number}m` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`; name: string; order?: number; }