elasticsearch 8.17.1__py3-none-any.whl → 8.17.2__py3-none-any.whl

elasticsearch/_async/client/shutdown.py

@@ -42,13 +42,16 @@ class ShutdownClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Cancel node shutdown preparations. Remove a node from the shutdown list so it
-        can resume normal operations. You must explicitly clear the shutdown request
-        when a node rejoins the cluster or when a node has permanently left the cluster.
-        Shutdown requests are never removed automatically by Elasticsearch. NOTE: This
-        feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise,
-        and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator
-        privileges feature is enabled, you must be an operator to use this API.
+        .. raw:: html
+
+          <p>Cancel node shutdown preparations.
+          Remove a node from the shutdown list so it can resume normal operations.
+          You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.
+          Shutdown requests are never removed automatically by Elasticsearch.</p>
+          <p>NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
+          Direct use is not supported.</p>
+          <p>If the operator privileges feature is enabled, you must be an operator to use this API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-shutdown.html>`_
 
@@ -103,13 +106,14 @@ class ShutdownClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get the shutdown status. Get information about nodes that are ready to be shut
-        down, have shut down preparations still in progress, or have stalled. The API
-        returns status information for each part of the shut down process. NOTE: This
-        feature is designed for indirect use by Elasticsearch Service, Elastic Cloud
-        Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If
-        the operator privileges feature is enabled, you must be an operator to use this
-        API.
+        .. raw:: html
+
+          <p>Get the shutdown status.</p>
+          <p>Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.
+          The API returns status information for each part of the shut down process.</p>
+          <p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
+          <p>If the operator privileges feature is enabled, you must be an operator to use this API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-shutdown.html>`_
 
@@ -176,18 +180,19 @@ class ShutdownClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Prepare a node to be shut down. NOTE: This feature is designed for indirect use
-        by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
-        Direct use is not supported. If you specify a node that is offline, it will be
-        prepared for shut down when it rejoins the cluster. If the operator privileges
-        feature is enabled, you must be an operator to use this API. The API migrates
-        ongoing tasks and index shards to other nodes as needed to prepare a node to
-        be restarted or shut down and removed from the cluster. This ensures that Elasticsearch
-        can be stopped safely with minimal disruption to the cluster. You must specify
-        the type of shutdown: `restart`, `remove`, or `replace`. If a node is already
-        being prepared for shutdown, you can use this API to change the shutdown type.
-        IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the
-        node shutdown status to determine when it is safe to stop Elasticsearch.
+        .. raw:: html
+
+          <p>Prepare a node to be shut down.</p>
+          <p>NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
+          <p>If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.</p>
+          <p>If the operator privileges feature is enabled, you must be an operator to use this API.</p>
+          <p>The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.
+          This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.</p>
+          <p>You must specify the type of shutdown: <code>restart</code>, <code>remove</code>, or <code>replace</code>.
+          If a node is already being prepared for shutdown, you can use this API to change the shutdown type.</p>
+          <p>IMPORTANT: This API does NOT terminate the Elasticsearch process.
+          Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-shutdown.html>`_
 

elasticsearch/_async/client/simulate.py

@@ -64,28 +64,22 @@ class SimulateClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Simulate data ingestion. Run ingest pipelines against a set of provided documents,
-        optionally with substitute pipeline definitions, to simulate ingesting data into
-        an index. This API is meant to be used for troubleshooting or pipeline development,
-        as it does not actually index any data into Elasticsearch. 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. No data is indexed into Elasticsearch.
-        Instead, the transformed document is returned, along with the list of pipelines
-        that have been run and the name of the index where the document would have been
-        indexed if this were not a simulation. The transformed document is validated
-        against the mappings that would apply to this index, and any validation error
-        is reported in the result. This API differs from the simulate pipeline API in
-        that you specify a single pipeline for that API, and it runs only that one pipeline.
-        The simulate pipeline API is more useful for developing a single pipeline, while
-        the simulate ingest API is more useful for troubleshooting the interaction of
-        the various pipelines that get applied when ingesting into an index. By default,
-        the pipeline definitions that are currently in the system are used. However,
-        you can supply substitute pipeline definitions in the body of the request. These
-        will be used in place of the pipeline definitions that are already in the system.
-        This can be used to replace existing pipeline definitions or to create new ones.
-        The pipeline substitutions are used only within this request.
+        .. 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>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.
+          No data is indexed into Elasticsearch.
+          Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.
+          The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.</p>
+          <p>This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.
+          The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.</p>
+          <p>By default, the pipeline definitions that are currently in the system are used.
+          However, you can supply substitute pipeline definitions in the body of the request.
+          These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/simulate-ingest-api.html>`_
 

elasticsearch/_async/client/slm.py

@@ -38,9 +38,12 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a policy. 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.
+        .. raw:: html
+
+          <p>Delete a policy.
+          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>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-delete-policy.html>`_
 
@@ -91,10 +94,12 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Run a policy. 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.
+        .. raw:: html
+
+          <p>Run a policy.
+          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>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-execute-lifecycle.html>`_
 
@@ -144,9 +149,12 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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. The retention policy is normally applied according to its schedule.
+        .. 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.
+          The retention policy is normally applied according to its schedule.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-execute-retention.html>`_
 
@@ -194,8 +202,11 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get policy information. Get snapshot lifecycle policy definitions and information
-        about the latest snapshot attempts.
+        .. raw:: html
+
+          <p>Get policy information.
+          Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-policy.html>`_
 
@@ -248,8 +259,11 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get snapshot lifecycle management statistics. Get global and policy-level statistics
-        about actions taken by snapshot lifecycle management.
+        .. raw:: html
+
+          <p>Get snapshot lifecycle management statistics.
+          Get global and policy-level statistics about actions taken by snapshot lifecycle management.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-stats.html>`_
 
@@ -296,7 +310,10 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get the snapshot lifecycle management status.
+        .. raw:: html
+
+          <p>Get the snapshot lifecycle management status.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-status.html>`_
 
@@ -354,9 +371,13 @@ class SlmClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a policy. 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.
+        .. raw:: html
+
+          <p>Create or update a policy.
+          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>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-put-policy.html>`_
 
@@ -437,9 +458,12 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start snapshot lifecycle management. 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.
+        .. raw:: html
+
+          <p>Start snapshot lifecycle management.
+          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>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-start.html>`_
 
@@ -488,15 +512,16 @@ class SlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stop snapshot lifecycle management. 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. The API returns a response as soon as the request is
-        acknowledged, but the plugin might continue to run until in-progress operations
-        complete and it can be safely stopped. Use the get snapshot lifecycle management
-        status API to see if SLM is running.
+        .. raw:: html
+
+          <p>Stop snapshot lifecycle management.
+          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>
+          <p>The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.
+          Use the get snapshot lifecycle management status API to see if SLM is running.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-stop.html>`_