Files
elasticsearch-js/docs/reference-indices-simulate_template.asciidoc

88 lines
4.5 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]]
=== 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
[pass]
++++
<pre>
++++
interface IndicesSimulateTemplateRequest extends <<RequestBase>> {
name?: <<Name>>
create?: boolean
master_timeout?: <<Duration>>
include_defaults?: boolean
allow_auto_create?: boolean
index_patterns?: <<Indices>>
composed_of?: <<Name>>[]
template?: IndicesPutIndexTemplateIndexTemplateMapping
data_stream?: <<IndicesDataStreamVisibility>>
priority?: <<long>>
version?: <<VersionNumber>>
_meta?: <<Metadata>>
ignore_missing_component_templates?: string[]
deprecated?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== IndicesSimulateTemplateResponse
[pass]
++++
<pre>
++++
interface IndicesSimulateTemplateResponse {
overlapping?: IndicesSimulateTemplateOverlapping[]
template: IndicesSimulateTemplateTemplate
}
[pass]
++++
</pre>
++++