77 lines
4.6 KiB
Plaintext
77 lines
4.6 KiB
Plaintext
[[reference-indices-simulate_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.simulateTemplate
|
|
|
|
Simulate an index template. Returns the index configuration that would be applied by a particular index template.
|
|
|
|
{ref}/indices-simulate-template.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(IndicesSimulateTemplateRequest, options?): Promise<IndicesSimulateTemplateResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `IndicesSimulateTemplateRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface IndicesSimulateTemplateRequest extends <<shared-type-request-base, RequestBase>> {
|
|
name?: <<shared-type-name, Name>>
|
|
create?: boolean
|
|
master_timeout?: <<shared-type-duration, Duration>>
|
|
include_defaults?: boolean
|
|
allow_auto_create?: boolean
|
|
index_patterns?: <<shared-type-indices, Indices>>
|
|
composed_of?: <<shared-type-name, Name>>[]
|
|
template?: IndicesPutIndexTemplateIndexTemplateMapping
|
|
data_stream?: IndicesDataStreamVisibility
|
|
priority?: <<shared-type-long, long>>
|
|
version?: <<shared-type-version-number, VersionNumber>>
|
|
_meta?: <<shared-type-metadata, Metadata>>
|
|
ignore_missing_component_templates?: string[]
|
|
deprecated?: boolean
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `IndicesSimulateTemplateResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface IndicesSimulateTemplateResponse {
|
|
overlapping?: IndicesSimulateTemplateOverlapping[]
|
|
template: IndicesSimulateTemplateTemplate
|
|
}
|
|
----
|
|
|