70 lines
4.3 KiB
Plaintext
70 lines
4.3 KiB
Plaintext
[[reference-indices-put_template]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
=== client.indices.putTemplate
|
|
|
|
Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
|
|
|
|
{ref}/indices-templates-v1.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(IndicesPutTemplateRequest, options?): Promise<IndicesPutTemplateResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `IndicesPutTemplateRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface IndicesPutTemplateRequest extends <<shared-type-request-base, RequestBase>> {
|
|
name: <<shared-type-name, Name>>
|
|
create?: boolean
|
|
master_timeout?: <<shared-type-duration, Duration>>
|
|
cause?: string
|
|
aliases?: Record<<<shared-type-index-name, IndexName>>, IndicesAlias>
|
|
index_patterns?: string | string[]
|
|
mappings?: MappingTypeMapping
|
|
order?: <<shared-type-integer, integer>>
|
|
settings?: IndicesIndexSettings
|
|
version?: <<shared-type-version-number, VersionNumber>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `IndicesPutTemplateResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
type IndicesPutTemplateResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
|
|
----
|
|
|