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

elasticsearch/_async/client/eql.py

@@ -36,10 +36,10 @@ class EqlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes an async EQL search or a stored synchronous EQL search. The API also
-        deletes results for the search.
+        Delete an async EQL search. Delete an async EQL search or a stored synchronous
+        EQL search. The API also deletes results for the search.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/eql-search-api.html>`_
 
         :param id: Identifier for the search to delete. A search ID is provided in the
             EQL search API's response for an async search. A search ID is also provided
@@ -83,10 +83,10 @@ class EqlClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the current status and available results for an async EQL search or a
-        stored synchronous EQL search.
+        Get async EQL search results. Get the current status and available results for
+        an async EQL search or a stored synchronous EQL search.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-search-api.html>`_
 
         :param id: Identifier for the search.
         :param keep_alive: Period for which the search and its results are stored on
@@ -134,10 +134,10 @@ class EqlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the current status for an async EQL search or a stored synchronous EQL
-        search without returning results.
+        Get the async EQL status. Get the current status for an async EQL search or a
+        stored synchronous EQL search without returning results.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-eql-status-api.html>`_
 
         :param id: Identifier for the search.
         """
@@ -223,9 +223,11 @@ class EqlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns results matching a query expressed in Event Query Language (EQL)
+        Get EQL search results. Returns search results for an Event Query Language (EQL)
+        query. EQL assumes each document in a data stream or index corresponds to an
+        event.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/eql-search-api.html>`_
 
         :param index: The name of the index to scope the operation
         :param query: EQL query you wish to run.

elasticsearch/_async/client/esql.py

@@ -68,9 +68,10 @@ class EsqlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Executes an ES|QL request
+        Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language)
+        query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/esql-rest.html>`_
 
         :param query: The ES|QL query API accepts an ES|QL query string in the query
             parameter, runs it, and returns the results.

elasticsearch/_async/client/features.py

@@ -35,10 +35,19 @@ class FeaturesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Gets a list of features which can be included in snapshots using the feature_states
-        field when creating a snapshot
+        Get the features. Get a list of features that can be included in snapshots using
+        the `feature_states` 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. A feature state includes one or more system indices
+        necessary for a given feature to function. In order to ensure data integrity,
+        all system indices that comprise a feature state are snapshotted and restored
+        together. The features listed by this API are a combination of built-in features
+        and features defined by plugins. In order for a feature state to be listed in
+        this API and recognized as a valid feature state by the create snapshot API,
+        the plugin that defines that feature must be installed on the master node.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-features-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-features-api.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_features"
@@ -72,9 +81,22 @@ class FeaturesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Resets the internal state of features, usually by deleting system indices
+        Reset the features. Clear all of the state information stored in system indices
+        by Elasticsearch features, including the security and machine learning indices.
+        WARNING: Intended for development and testing use only. Do not reset features
+        on a production cluster. 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. The response code is HTTP 200 if
+        the state is successfully reset for all features. It is HTTP 500 if the reset
+        operation failed for any feature. Note that select features might provide a way
+        to reset particular system indices. Using this API resets all features, both
+        those that are built-in and implemented as plugins. To list the features that
+        will be affected, use the get features API. IMPORTANT: The features installed
+        on the node you submit this request to are the features that will be reset. Run
+        on the master node if you have any doubts about which plugins are installed on
+        individual nodes.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_features/_reset"

elasticsearch/_async/client/fleet.py

@@ -49,7 +49,7 @@ class FleetClient(NamespacedClient):
         Returns the current global checkpoints for an index. This API is design for internal
         use by the fleet server project.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-global-checkpoints.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-global-checkpoints.html>`_
 
         :param index: A single index or index alias that resolves to a single index.
         :param checkpoints: A comma separated list of previous global checkpoints. When

elasticsearch/_async/client/graph.py

@@ -45,10 +45,16 @@ class GraphClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Extracts and summarizes information about the documents and terms in an Elasticsearch
-        data stream or index.
+        Explore graph analytics. 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 `_explore` 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. You can exclude vertices that have already
+        been returned.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/graph-explore-api.html>`_
 
         :param index: Name of the index.
         :param connections: Specifies or more fields from which you want to extract terms

elasticsearch/_async/client/ilm.py

@@ -38,11 +38,11 @@ class IlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes the specified lifecycle policy definition. 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.
+        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.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-delete-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-delete-lifecycle.html>`_
 
         :param name: Identifier for the policy.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -93,11 +93,13 @@ class IlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves information about the index’s current lifecycle state, such as the
-        currently executing phase, action, and step. Shows when the index entered each
-        one, the definition of the running phase, and information about any failures.
+        Explain the lifecycle state. 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. The response indicates when the index entered each
+        lifecycle state, provides the definition of the running phase, and information
+        about any failures.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-explain-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-explain-lifecycle.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to target.
             Supports wildcards (`*`). To target all data streams and indices, use `*`
@@ -157,9 +159,9 @@ class IlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves a lifecycle policy.
+        Get lifecycle policies.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-get-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-get-lifecycle.html>`_
 
         :param name: Identifier for the policy.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -208,9 +210,9 @@ class IlmClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves the current index lifecycle management (ILM) status.
+        Get the ILM status. Get the current index lifecycle management status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-get-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-get-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ilm/status"
@@ -249,12 +251,20 @@ class IlmClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Switches the indices, ILM policies, and legacy, composable and component templates
-        from using custom node attributes and attribute-based allocation filters to using
-        data tiers, and optionally deletes one legacy index template.+ Using node roles
-        enables ILM to automatically move the indices between data tiers.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-migrate-to-data-tiers.html>`_
+        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. Optionally, delete one legacy index template.
+        Using node roles enables ILM to automatically move the indices between data tiers.
+        Migrating away from custom node attributes routing can be manually performed.
+        This API provides an automated way of performing three out of the four manual
+        steps listed in the migration guide: 1. Stop setting the custom hot attribute
+        on new indices. 1. Remove custom allocation settings from existing ILM policies.
+        1. Replace custom allocation settings from existing indices with the corresponding
+        tier preference. ILM must be stopped before performing the migration. Use the
+        stop ILM and get ILM status APIs to wait until the reported operation mode is
+        `STOPPED`.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-migrate-to-data-tiers.html>`_
 
         :param dry_run: If true, simulates the migration from node attributes based allocation
             filters to data tiers, but does not perform the migration. This provides
@@ -312,13 +322,27 @@ class IlmClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Manually moves an index into the specified step and executes that step.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-move-to-step.html>`_
+        Move to a lifecycle step. Manually move an index into a specific step in the
+        lifecycle policy and run that step. 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. 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
+        This is to prevent the index from being moved from an unexpected step into the
+        next step. When specifying the target (`next_step`) to which the index will be
+        moved, either the name or both the action and name fields are optional. If only
+        the phase is specified, the index will move to the first step of the first action
+        in the target phase. If the phase and action are specified, the index will move
+        to the first step of the specified action in the specified phase. Only actions
+        specified in the ILM policy are considered valid. An index cannot move to a step
+        that is not part of its policy.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-move-to-step.html>`_
 
         :param index: The name of the index whose lifecycle step is to change
-        :param current_step:
-        :param next_step:
+        :param current_step: The step that the index is expected to be in.
+        :param next_step: The step that you want to run.
         """
         if index in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'index'")
@@ -375,10 +399,11 @@ class IlmClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates a lifecycle policy. If the specified policy exists, the policy is replaced
-        and the policy version is incremented.
+        Create or update a lifecycle policy. If the specified policy exists, it is replaced
+        and the policy version is incremented. NOTE: Only the latest version of the policy
+        is stored, you cannot revert to previous versions.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-put-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-put-lifecycle.html>`_
 
         :param name: Identifier for the policy.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -435,9 +460,10 @@ class IlmClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Removes the assigned lifecycle policy and stops managing the specified index
+        Remove policies from an index. Remove the assigned lifecycle policies from an
+        index or a data stream's backing indices. It also stops managing the indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-remove-policy.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-remove-policy.html>`_
 
         :param index: The name of the index to remove policy on
         """
@@ -475,9 +501,12 @@ class IlmClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retries executing the policy for an index that is in the ERROR step.
+        Retry a policy. 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.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-retry-policy.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-retry-policy.html>`_
 
         :param index: The name of the indices (comma-separated) whose failed lifecycle
             step is to be retry
@@ -517,12 +546,14 @@ class IlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start the index lifecycle management (ILM) plugin.
+        Start the ILM plugin. 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.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-start.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-start.html>`_
 
-        :param master_timeout:
-        :param timeout:
+        :param master_timeout: Explicit operation timeout for connection to master node
+        :param timeout: Explicit operation timeout
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ilm/start"
@@ -561,13 +592,17 @@ class IlmClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Halts all lifecycle management operations and stops the index lifecycle management
-        (ILM) plugin
+        Stop the ILM plugin. 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.
+        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.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-stop.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-stop.html>`_
 
-        :param master_timeout:
-        :param timeout:
+        :param master_timeout: Explicit operation timeout for connection to master node
+        :param timeout: Explicit operation timeout
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ilm/stop"