Files
elasticsearch-js/docs/reference-indices-simulate_index_template.asciidoc
2024-12-05 14:46:52 -06:00

77 lines
4.1 KiB
Plaintext

[[reference-indices-simulate_index_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.simulateIndexTemplate]]
=== client.indices.simulateIndexTemplate
Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template.
{ref}/indices-simulate-index.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesSimulateIndexTemplateRequest, options?): Promise<IndicesSimulateIndexTemplateResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface IndicesSimulateIndexTemplateRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
include_defaults?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface IndicesSimulateIndexTemplateResponse {
overlapping?: IndicesSimulateTemplateOverlapping[]
template: IndicesSimulateTemplateTemplate
}
[pass]
++++
</pre>
++++