Files
elasticsearch-js/docs/reference-cluster-get_component_template.asciidoc
2024-12-05 14:46:46 -06:00

67 lines
4.1 KiB
Plaintext

[[reference-cluster-get_component_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.cluster.getComponentTemplate
Get component templates. Retrieves information about component templates.
{ref}/indices-component-template.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ClusterGetComponentTemplateRequest, options?): Promise<ClusterGetComponentTemplateResponse>
----
[discrete]
===== `ClusterGetComponentTemplateRequest`
[source,ts]
----
interface ClusterGetComponentTemplateRequest extends <<shared-type-request-base, RequestBase>> {
name?: <<shared-type-name, Name>>
flat_settings?: boolean
include_defaults?: boolean
local?: boolean
master_timeout?: <<shared-type-duration, Duration>>
}
----
[discrete]
===== `ClusterGetComponentTemplateResponse`
[source,ts]
----
interface ClusterGetComponentTemplateResponse {
component_templates: ClusterComponentTemplate[]
}
----