Cluster

class elasticsearch_serverless.client.ClusterClient(client: BaseClient)
delete_component_template(*, name: str | Sequence[str], error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, pretty: bool | None = None, timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None) → ObjectApiResponse[Any]

Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

Parameters:

  • name – Comma-separated list or wildcard expression of component template names used to limit the request.

  • master_timeout – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  • timeout – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

exists_component_template(*, name: str | Sequence[str], error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, local: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, pretty: bool | None = None) → HeadApiResponse

Check component templates. Returns information about whether a particular component template exists.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

Parameters:

  • name – Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.

  • local – If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

  • master_timeout – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

get_component_template(*, name: str | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, flat_settings: bool | None = None, human: bool | None = None, include_defaults: bool | None = None, local: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Get component templates. Get information about component templates.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

Parameters:

  • name – Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.

  • flat_settings – If true, returns settings in flat format.

  • include_defaults – Return all default configurations for the component template (default: false)

  • local – If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

  • master_timeout – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

info(*, target: Sequence[str | Literal['_all', 'http', 'ingest', 'script', 'thread_pool']] | str | Literal['_all', 'http', 'ingest', 'script', 'thread_pool'], error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None) → ObjectApiResponse[Any]

Get cluster info. Returns basic information about the cluster.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info

Parameters:

target – Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.

put_component_template(*, name: str, template: Mapping[str, Any] | None = None, create: bool | None = None, deprecated: bool | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, master_timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, meta: Mapping[str, Any] | None = None, pretty: bool | None = None, version: int | None = None, body: Dict[str, Any] | None = None) → ObjectApiResponse[Any]

Create or update a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s composed_of list. Component templates are only applied to new data streams and indices as part of a matching index template.

Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.

Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.

You can use C-style /* *\/ block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.

Applying component templates

You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template's composed_of list.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

Parameters:

  • name – Name of the component template to create. Elasticsearch includes the following built-in component templates: logs-mappings; logs-settings; metrics-mappings; metrics-settings;`synthetics-mapping`; synthetics-settings. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the version for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set stack.templates.enabled to false using the cluster update settings API.

  • template – The template to be applied which includes mappings, settings, or aliases configuration.

  • create – If true, this request cannot replace or update existing component templates.

  • deprecated – Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

  • master_timeout – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  • meta – Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset _meta, replace the template without specifying this information.

  • version – Version number used to manage component templates externally. This number isn’t automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version.