elasticsearch 9.2.0__py3-none-any.whl → 9.2.1__py3-none-any.whl

elasticsearch/_async/client/eql.py

@@ -38,8 +38,8 @@ class EqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete an async EQL search.
-          Delete an async EQL search or a stored synchronous EQL search.
+          <p>Delete an async EQL search.</p>
+          <p>Delete an async EQL search or a stored synchronous EQL search.
           The API also deletes results for the search.</p>
 
 
@@ -89,8 +89,8 @@ class EqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get async EQL search results.
-          Get the current status and available results for an async EQL search or a stored synchronous EQL search.</p>
+          <p>Get async EQL search results.</p>
+          <p>Get the current status and available results for an async EQL search or a stored synchronous EQL search.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get>`_
@@ -143,8 +143,8 @@ class EqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the async EQL status.
-          Get the current status for an async EQL search or a stored synchronous EQL search without returning results.</p>
+          <p>Get the async EQL status.</p>
+          <p>Get the current status for an async EQL search or a stored synchronous EQL search without returning results.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status>`_
@@ -243,14 +243,14 @@ class EqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get EQL search results.
-          Returns search results for an Event Query Language (EQL) query.
+          <p>Get EQL search results.</p>
+          <p>Returns search results for an Event Query Language (EQL) query.
           EQL assumes each document in a data stream or index corresponds to an event.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search>`_
 
-        :param index: The name of the index to scope the operation
+        :param index: Comma-separated list of index names to scope the operation
         :param query: EQL query you wish to run.
         :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
             into no concrete indices. (This includes `_all` string or when no indices
@@ -296,7 +296,7 @@ class EqlClient(NamespacedClient):
             Defaults to 10
         :param tiebreaker_field: Field used to sort hits with the same timestamp in ascending
             order
-        :param timestamp_field: Field containing event timestamp. Default "@timestamp"
+        :param timestamp_field: Field containing event timestamp.
         :param wait_for_completion_timeout:
         """
         if index in SKIP_IN_PATH:

elasticsearch/_async/client/esql.py

@@ -23,13 +23,13 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 if t.TYPE_CHECKING:
-    from elasticsearch.esql import ESQLBase
+    from ...esql import ESQLBase
 
 
 class EsqlClient(NamespacedClient):
@@ -90,8 +90,8 @@ class EsqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run an async ES|QL query.
-          Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.</p>
+          <p>Run an async ES|QL query.</p>
+          <p>Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.</p>
           <p>The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.</p>
 
 
@@ -226,8 +226,8 @@ class EsqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete an async ES|QL query.
-          If the query is still running, it is cancelled.
+          <p>Delete an async ES|QL query.</p>
+          <p>If the query is still running, it is cancelled.
           Otherwise, the stored results are deleted.</p>
           <p>If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:</p>
           <ul>
@@ -292,8 +292,8 @@ class EsqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get async ES|QL query results.
-          Get the current status and available results or stored results for an ES|QL asynchronous query.
+          <p>Get async ES|QL query results.</p>
+          <p>Get the current status and available results or stored results for an ES|QL asynchronous query.
           If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.</p>
 
 
@@ -404,7 +404,7 @@ class EsqlClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def get_query(
         self,
         *,
@@ -417,8 +417,8 @@ class EsqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get a specific running ES|QL query information.
-          Returns an object extended information about a running ES|QL query.</p>
+          <p>Get a specific running ES|QL query information.</p>
+          <p>Returns an object extended information about a running ES|QL query.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-get-query>`_
@@ -449,7 +449,7 @@ class EsqlClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def list_queries(
         self,
         *,
@@ -461,8 +461,8 @@ class EsqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get running ES|QL queries information.
-          Returns an object containing IDs and other information about the running ES|QL queries.</p>
+          <p>Get running ES|QL queries information.</p>
+          <p>Returns an object containing IDs and other information about the running ES|QL queries.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-list-queries>`_
@@ -543,8 +543,8 @@ class EsqlClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run an ES|QL query.
-          Get search results for an ES|QL (Elasticsearch query language) query.</p>
+          <p>Run an ES|QL query.</p>
+          <p>Get search results for an ES|QL (Elasticsearch query language) query.</p>
 
 
         `<https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest>`_

elasticsearch/_async/client/features.py

@@ -20,7 +20,7 @@ import typing as t
 from elastic_transport import ObjectApiResponse
 
 from ._base import NamespacedClient
-from .utils import Stability, _rewrite_parameters, _stability_warning
+from .utils import Stability, _availability_warning, _rewrite_parameters
 
 
 class FeaturesClient(NamespacedClient):
@@ -38,8 +38,8 @@ class FeaturesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the features.
-          Get a list of features that can be included in snapshots using the <code>feature_states</code> field when creating a snapshot.
+          <p>Get the features.</p>
+          <p>Get a list of features that can be included in snapshots using the <code>feature_states</code> field when creating a snapshot.
           You can use this API to determine which feature states to include when taking a snapshot.
           By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.</p>
           <p>A feature state includes one or more system indices necessary for a given feature to function.
@@ -76,7 +76,7 @@ class FeaturesClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def reset_features(
         self,
         *,
@@ -89,8 +89,8 @@ class FeaturesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Reset the features.
-          Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.</p>
+          <p>Reset the features.</p>
+          <p>Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.</p>
           <p>WARNING: Intended for development and testing use only. Do not reset features on a production cluster.</p>
           <p>Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.
           This deletes all state information stored in system indices.</p>

elasticsearch/_async/client/fleet.py

@@ -23,9 +23,9 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
@@ -101,7 +101,7 @@ class FleetClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="searches",
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def msearch(
         self,
         *,
@@ -138,8 +138,8 @@ class FleetClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run multiple Fleet searches.
-          Run several Fleet searches with a single API request.
+          <p>Run multiple Fleet searches.</p>
+          <p>Run several Fleet searches with a single API request.
           The API follows the same structure as the multi search API.
           However, similar to the Fleet search API, it supports the <code>wait_for_checkpoints</code> parameter.</p>
 
@@ -293,7 +293,7 @@ class FleetClient(NamespacedClient):
             "from": "from_",
         },
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def search(
         self,
         *,
@@ -388,8 +388,8 @@ class FleetClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run a Fleet search.
-          The purpose of the Fleet search API is to provide an API where the search will be run only
+          <p>Run a Fleet search.</p>
+          <p>The purpose of the Fleet search API is to provide an API where the search will be run only
           after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.</p>
 
 

elasticsearch/_async/client/graph.py

@@ -47,8 +47,8 @@ class GraphClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Explore graph analytics.
-          Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
+          <p>Explore graph analytics.</p>
+          <p>Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
           The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
           An initial request to the <code>_explore</code> API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
           Subsequent requests enable you to spider out from one more vertices of interest.

elasticsearch/_async/client/ilm.py

@@ -40,8 +40,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a lifecycle policy.
-          You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.</p>
+          <p>Delete a lifecycle policy.</p>
+          <p>You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-delete-lifecycle>`_
@@ -96,8 +96,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Explain the lifecycle state.
-          Get the current lifecycle status for one or more indices.
+          <p>Explain the lifecycle state.</p>
+          <p>Get the current lifecycle status for one or more indices.
           For data streams, the API retrieves the current lifecycle status for the stream's backing indices.</p>
           <p>The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.</p>
 
@@ -260,8 +260,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Migrate to data tiers routing.
-          Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.
+          <p>Migrate to data tiers routing.</p>
+          <p>Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.
           Optionally, delete one legacy index template.
           Using node roles enables ILM to automatically move the indices between data tiers.</p>
           <p>Migrating away from custom node attributes routing can be manually performed.
@@ -341,8 +341,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Move to a lifecycle step.
-          Manually move an index into a specific step in the lifecycle policy and run that step.</p>
+          <p>Move to a lifecycle step.</p>
+          <p>Manually move an index into a specific step in the lifecycle policy and run that step.</p>
           <p>WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.</p>
           <p>You must specify both the current step and the step to be executed in the body of the request.
           The request will fail if the current step does not match the step currently running for the index
@@ -413,8 +413,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a lifecycle policy.
-          If the specified policy exists, it is replaced and the policy version is incremented.</p>
+          <p>Create or update a lifecycle policy.</p>
+          <p>If the specified policy exists, it is replaced and the policy version is incremented.</p>
           <p>NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.</p>
 
 
@@ -473,8 +473,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Remove policies from an index.
-          Remove the assigned lifecycle policies from an index or a data stream's backing indices.
+          <p>Remove policies from an index.</p>
+          <p>Remove the assigned lifecycle policies from an index or a data stream's backing indices.
           It also stops managing the indices.</p>
 
 
@@ -518,8 +518,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Retry a policy.
-          Retry running the lifecycle policy for an index that is in the ERROR step.
+          <p>Retry a policy.</p>
+          <p>Retry running the lifecycle policy for an index that is in the ERROR step.
           The API sets the policy back to the step where the error occurred and runs the step.
           Use the explain lifecycle state API to determine whether an index is in the ERROR step.</p>
 
@@ -566,8 +566,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Start the ILM plugin.
-          Start the index lifecycle management plugin if it is currently stopped.
+          <p>Start the ILM plugin.</p>
+          <p>Start the index lifecycle management plugin if it is currently stopped.
           ILM is started automatically when the cluster is formed.
           Restarting ILM is necessary only when it has been stopped using the stop ILM API.</p>
 
@@ -619,8 +619,8 @@ class IlmClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Stop the ILM plugin.
-          Halt all lifecycle management operations and stop the index lifecycle management plugin.
+          <p>Stop the ILM plugin.</p>
+          <p>Halt all lifecycle management operations and stop the index lifecycle management plugin.
           This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.</p>
           <p>The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.
           Use the get ILM status API to check whether ILM is running.</p>