elasticsearch9 9.1.1__py3-none-any.whl → 9.1.3__py3-none-any.whl

elasticsearch9/_async/client/simulate.py

@@ -23,9 +23,9 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
@@ -40,7 +40,7 @@ class SimulateClient(NamespacedClient):
             "pipeline_substitutions",
         ),
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def ingest(
         self,
         *,
@@ -66,8 +66,8 @@ class SimulateClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Simulate data ingestion.
-          Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.</p>
+          <p>Simulate data ingestion.</p>
+          <p>Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.</p>
           <p>This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.</p>
           <p>The API runs the default and final pipeline for that index against a set of documents provided in the body of the request.
           If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.

elasticsearch9/_async/client/slm.py

@@ -40,8 +40,8 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a policy.
-          Delete a snapshot lifecycle policy definition.
+          <p>Delete a policy.</p>
+          <p>Delete a snapshot lifecycle policy definition.
           This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.</p>
 
 
@@ -96,8 +96,8 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run a policy.
-          Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.
+          <p>Run a policy.</p>
+          <p>Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.
           The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.</p>
 
 
@@ -151,8 +151,8 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run a retention policy.
-          Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.
+          <p>Run a retention policy.</p>
+          <p>Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.
           The retention policy is normally applied according to its schedule.</p>
 
 
@@ -204,13 +204,13 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get policy information.
-          Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.</p>
+          <p>Get policy information.</p>
+          <p>Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle>`_
 
-        :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve
+        :param policy_id: A comma-separated list of snapshot lifecycle policy identifiers.
         :param master_timeout: The 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.
@@ -261,8 +261,8 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get snapshot lifecycle management statistics.
-          Get global and policy-level statistics about actions taken by snapshot lifecycle management.</p>
+          <p>Get snapshot lifecycle management statistics.</p>
+          <p>Get global and policy-level statistics about actions taken by snapshot lifecycle management.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats>`_
@@ -373,8 +373,8 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a policy.
-          Create or update a snapshot lifecycle policy.
+          <p>Create or update a policy.</p>
+          <p>Create or update a snapshot lifecycle policy.
           If the policy already exists, this request increments the policy version.
           Only the latest version of a policy is stored.</p>
 
@@ -431,11 +431,7 @@ class SlmClient(NamespacedClient):
                 __body["retention"] = retention
             if schedule is not None:
                 __body["schedule"] = schedule
-        if not __body:
-            __body = None  # type: ignore[assignment]
-        __headers = {"accept": "application/json"}
-        if __body is not None:
-            __headers["content-type"] = "application/json"
+        __headers = {"accept": "application/json", "content-type": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
             "PUT",
             __path,
@@ -460,8 +456,8 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Start snapshot lifecycle management.
-          Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.
+          <p>Start snapshot lifecycle management.</p>
+          <p>Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.
           Manually starting SLM is necessary only if it has been stopped using the stop SLM API.</p>
 
 
@@ -514,8 +510,8 @@ class SlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Stop snapshot lifecycle management.
-          Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.
+          <p>Stop snapshot lifecycle management.</p>
+          <p>Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.
           This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.
           Stopping SLM does not stop any snapshots that are in progress.
           You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.</p>

elasticsearch9/_async/client/snapshot.py

@@ -23,9 +23,9 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
@@ -46,8 +46,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Clean up the snapshot repository.
-          Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.</p>
+          <p>Clean up the snapshot repository.</p>
+          <p>Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository>`_
@@ -110,8 +110,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Clone a snapshot.
-          Clone part of all of a snapshot into another snapshot in the same repository.</p>
+          <p>Clone a snapshot.</p>
+          <p>Clone part of all of a snapshot into another snapshot in the same repository.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone>`_
@@ -207,8 +207,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create a snapshot.
-          Take a snapshot of a cluster or of data streams and indices.</p>
+          <p>Create a snapshot.</p>
+          <p>Take a snapshot of a cluster or of data streams and indices.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create>`_
@@ -330,8 +330,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a snapshot repository.
-          IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.
+          <p>Create or update a snapshot repository.</p>
+          <p>IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.
           To register a snapshot repository, the cluster's global metadata must be writeable.
           Ensure there are no cluster blocks (for example, <code>cluster.blocks.read_only</code> and <code>clsuter.blocks.read_only_allow_delete</code> settings) that prevent write access.</p>
           <p>Several options for this API can be specified using a query parameter or a request body parameter.
@@ -470,8 +470,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete snapshot repositories.
-          When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.
+          <p>Delete snapshot repositories.</p>
+          <p>When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.
           The snapshots themselves are left untouched and in place.</p>
 
 
@@ -950,7 +950,7 @@ class SnapshotClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def repository_verify_integrity(
         self,
         *,
@@ -971,8 +971,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Verify the repository integrity.
-          Verify the integrity of the contents of a snapshot repository.</p>
+          <p>Verify the repository integrity.</p>
+          <p>Verify the integrity of the contents of a snapshot repository.</p>
           <p>This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.</p>
           <p>If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its <code>read_only</code> option to <code>true</code>, and use this API to verify its integrity.
           Until you do so:</p>
@@ -1110,8 +1110,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Restore a snapshot.
-          Restore a snapshot of a cluster or data streams and indices.</p>
+          <p>Restore a snapshot.</p>
+          <p>Restore a snapshot of a cluster or data streams and indices.</p>
           <p>You can restore a snapshot only to a running cluster with an elected master node.
           The snapshot repository must be registered and available to the cluster.
           The snapshot and cluster versions must be compatible.</p>
@@ -1259,8 +1259,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the snapshot status.
-          Get a detailed description of the current state for each shard participating in the snapshot.</p>
+          <p>Get the snapshot status.</p>
+          <p>Get a detailed description of the current state for each shard participating in the snapshot.</p>
           <p>Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots.
           If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.</p>
           <p>If you omit the <code>&lt;snapshot&gt;</code> request path parameter, the request retrieves information only for currently running snapshots.
@@ -1337,8 +1337,8 @@ class SnapshotClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Verify a snapshot repository.
-          Check for common misconfigurations in a snapshot repository.</p>
+          <p>Verify a snapshot repository.</p>
+          <p>Check for common misconfigurations in a snapshot repository.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository>`_

elasticsearch9/_async/client/sql.py

@@ -89,8 +89,8 @@ class SqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete an async SQL search.
-          Delete an async SQL search or a stored synchronous SQL search.
+          <p>Delete an async SQL search.</p>
+          <p>Delete an async SQL search or a stored synchronous SQL search.
           If the search is still running, the API cancels it.</p>
           <p>If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:</p>
           <ul>
@@ -145,8 +145,8 @@ class SqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get async SQL search results.
-          Get the current status and available results for an async SQL search or stored synchronous SQL search.</p>
+          <p>Get async SQL search results.</p>
+          <p>Get the current status and available results for an async SQL search or stored synchronous SQL search.</p>
           <p>If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.</p>
 
 
@@ -208,8 +208,8 @@ class SqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the async SQL search status.
-          Get the current status of an async SQL search or a stored synchronous SQL search.</p>
+          <p>Get the async SQL search status.</p>
+          <p>Get the current status of an async SQL search or a stored synchronous SQL search.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status>`_
@@ -297,8 +297,8 @@ class SqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get SQL search results.
-          Run an SQL request.</p>
+          <p>Get SQL search results.</p>
+          <p>Run an SQL request.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query>`_
@@ -422,8 +422,8 @@ class SqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Translate SQL into Elasticsearch queries.
-          Translate an SQL search into a search API request containing Query DSL.
+          <p>Translate SQL into Elasticsearch queries.</p>
+          <p>Translate an SQL search into a search API request containing Query DSL.
           It accepts the same request body parameters as the SQL search API, excluding <code>cursor</code>.</p>
 
 

elasticsearch9/_async/client/streams.py

@@ -0,0 +1,186 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+import typing as t
+
+from elastic_transport import ObjectApiResponse, TextApiResponse
+
+from ._base import NamespacedClient
+from .utils import (
+    Stability,
+    _availability_warning,
+    _rewrite_parameters,
+)
+
+
+class StreamsClient(NamespacedClient):
+
+    @_rewrite_parameters()
+    @_availability_warning(Stability.EXPERIMENTAL)
+    async def logs_disable(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+    ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
+        """
+        .. raw:: html
+
+          <p>Disable logs stream.</p>
+          <p>Turn off the logs stream feature for this cluster.</p>
+
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch#TODO>`_
+
+        :param master_timeout: The 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.
+        :param timeout: The period to wait for a response. If no response is received
+            before the timeout expires, the request fails and returns an error.
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_streams/logs/_disable"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        if timeout is not None:
+            __query["timeout"] = timeout
+        __headers = {"accept": "text/plain,application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="streams.logs_disable",
+            path_parts=__path_parts,
+        )
+
+    @_rewrite_parameters()
+    @_availability_warning(Stability.EXPERIMENTAL)
+    async def logs_enable(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+    ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
+        """
+        .. raw:: html
+
+          <p>Enable logs stream.</p>
+          <p>Turn on the logs stream feature for this cluster.</p>
+          <p>NOTE: To protect existing data, this feature can be turned on only if the
+          cluster does not have existing indices or data streams that match the pattern <code>logs|logs.*</code>.
+          If those indices or data streams exist, a <code>409 - Conflict</code> response and error is returned.</p>
+
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch#TODO>`_
+
+        :param master_timeout: The 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.
+        :param timeout: The period to wait for a response. If no response is received
+            before the timeout expires, the request fails and returns an error.
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_streams/logs/_enable"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        if timeout is not None:
+            __query["timeout"] = timeout
+        __headers = {"accept": "text/plain,application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="streams.logs_enable",
+            path_parts=__path_parts,
+        )
+
+    @_rewrite_parameters()
+    @_availability_warning(Stability.EXPERIMENTAL)
+    async def status(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        master_timeout: t.Optional[
+            t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
+        ] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Get the status of streams.</p>
+          <p>Get the current status for all types of streams.</p>
+
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch#TODO>`_
+
+        :param 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.
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_streams/status"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="streams.status",
+            path_parts=__path_parts,
+        )

elasticsearch9/_async/client/synonyms.py

@@ -95,8 +95,8 @@ class SynonymsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a synonym rule.
-          Delete a synonym rule from a synonym set.</p>
+          <p>Delete a synonym rule.</p>
+          <p>Delete a synonym rule from a synonym set.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule>`_
@@ -204,8 +204,8 @@ class SynonymsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get a synonym rule.
-          Get a synonym rule from a synonym set.</p>
+          <p>Get a synonym rule.</p>
+          <p>Get a synonym rule from a synonym set.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule>`_
@@ -257,8 +257,8 @@ class SynonymsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get all synonym sets.
-          Get a summary of all defined synonym sets.</p>
+          <p>Get all synonym sets.</p>
+          <p>Get a summary of all defined synonym sets.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym>`_
@@ -311,8 +311,8 @@ class SynonymsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a synonym set.
-          Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
+          <p>Create or update a synonym set.</p>
+          <p>Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
           If you need to manage more synonym rules, you can create multiple synonym sets.</p>
           <p>When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.
           This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.</p>
@@ -378,8 +378,8 @@ class SynonymsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a synonym rule.
-          Create or update a synonym rule in a synonym set.</p>
+          <p>Create or update a synonym rule.</p>
+          <p>Create or update a synonym rule in a synonym set.</p>
           <p>If any of the synonym rules included is invalid, the API returns an error.</p>
           <p>When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.</p>
 

elasticsearch9/_async/client/tasks.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class TasksClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def cancel(
         self,
         *,
@@ -106,7 +106,7 @@ class TasksClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def get(
         self,
         *,
@@ -121,8 +121,8 @@ class TasksClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get task information.
-          Get information about a task currently running in the cluster.</p>
+          <p>Get task information.</p>
+          <p>Get information about a task currently running in the cluster.</p>
           <p>WARNING: The task management API is new and should still be considered a beta feature.
           The API may change in ways that are not backwards compatible.</p>
           <p>If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.</p>
@@ -164,7 +164,7 @@ class TasksClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def list(
         self,
         *,
@@ -185,8 +185,8 @@ class TasksClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get all tasks.
-          Get information about the tasks currently running on one or more nodes in the cluster.</p>
+          <p>Get all tasks.</p>
+          <p>Get information about the tasks currently running on one or more nodes in the cluster.</p>
           <p>WARNING: The task management API is new and should still be considered a beta feature.
           The API may change in ways that are not backwards compatible.</p>
           <p><strong>Identifying running tasks</strong></p>

elasticsearch9/_async/client/text_structure.py

@@ -55,8 +55,8 @@ class TextStructureClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Find the structure of a text field.
-          Find the structure of a text field in an Elasticsearch index.</p>
+          <p>Find the structure of a text field.</p>
+          <p>Find the structure of a text field in an Elasticsearch index.</p>
           <p>This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.
           For example, if you have ingested data into a very simple index that has just <code>@timestamp</code> and message fields, you can use this API to see what common structure exists in the message field.</p>
           <p>The response from the API contains:</p>
@@ -241,8 +241,8 @@ class TextStructureClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Find the structure of text messages.
-          Find the structure of a list of text messages.
+          <p>Find the structure of text messages.</p>
+          <p>Find the structure of a list of text messages.
           The messages must contain data that is suitable to be ingested into Elasticsearch.</p>
           <p>This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
           Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.</p>
@@ -402,7 +402,11 @@ class TextStructureClient(NamespacedClient):
         delimiter: t.Optional[str] = None,
         ecs_compatibility: t.Optional[str] = None,
         explain: t.Optional[bool] = None,
-        format: t.Optional[str] = None,
+        format: t.Optional[
+            t.Union[
+                str, t.Literal["delimited", "ndjson", "semi_structured_text", "xml"]
+            ]
+        ] = None,
         grok_pattern: t.Optional[str] = None,
         has_header_row: t.Optional[bool] = None,
         line_merge_size_limit: t.Optional[int] = None,
@@ -416,8 +420,8 @@ class TextStructureClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Find the structure of a text file.
-          The text file must contain data that is suitable to be ingested into Elasticsearch.</p>
+          <p>Find the structure of a text file.</p>
+          <p>The text file must contain data that is suitable to be ingested into Elasticsearch.</p>
           <p>This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
           Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.
           It must, however, be text; binary text formats are not currently supported.
@@ -615,8 +619,8 @@ class TextStructureClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Test a Grok pattern.
-          Test a Grok pattern on one or more lines of text.
+          <p>Test a Grok pattern.</p>
+          <p>Test a Grok pattern on one or more lines of text.
           The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.</p>