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

elasticsearch/_async/client/eql.py

@@ -39,7 +39,7 @@ class EqlClient(NamespacedClient):
         Deletes 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.15/eql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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
@@ -86,7 +86,7 @@ class EqlClient(NamespacedClient):
         Returns 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.15/get-async-eql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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
@@ -137,7 +137,7 @@ class EqlClient(NamespacedClient):
         Returns 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.15/get-async-eql-status-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html>`_
 
         :param id: Identifier for the search.
         """
@@ -225,7 +225,7 @@ class EqlClient(NamespacedClient):
         """
         Returns results matching a query expressed in Event Query Language (EQL)
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/eql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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

@@ -26,7 +26,15 @@ from .utils import _rewrite_parameters
 class EsqlClient(NamespacedClient):
 
     @_rewrite_parameters(
-        body_fields=("query", "columnar", "filter", "locale", "params"),
+        body_fields=(
+            "query",
+            "columnar",
+            "filter",
+            "locale",
+            "params",
+            "profile",
+            "tables",
+        ),
         ignore_deprecated_options={"params"},
     )
     async def query(
@@ -35,20 +43,34 @@ class EsqlClient(NamespacedClient):
         query: t.Optional[str] = None,
         columnar: t.Optional[bool] = None,
         delimiter: t.Optional[str] = None,
+        drop_null_columns: t.Optional[bool] = None,
         error_trace: t.Optional[bool] = None,
         filter: t.Optional[t.Mapping[str, t.Any]] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        format: t.Optional[str] = None,
+        format: t.Optional[
+            t.Union[
+                str,
+                t.Literal[
+                    "arrow", "cbor", "csv", "json", "smile", "tsv", "txt", "yaml"
+                ],
+            ]
+        ] = None,
         human: t.Optional[bool] = None,
         locale: t.Optional[str] = None,
-        params: t.Optional[t.Sequence[t.Union[None, bool, float, int, str]]] = None,
+        params: t.Optional[
+            t.Sequence[t.Union[None, bool, float, int, str, t.Any]]
+        ] = None,
         pretty: t.Optional[bool] = None,
+        profile: t.Optional[bool] = None,
+        tables: t.Optional[
+            t.Mapping[str, t.Mapping[str, t.Mapping[str, t.Any]]]
+        ] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Executes an ES|QL request
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/esql-rest.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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.
@@ -58,6 +80,10 @@ class EsqlClient(NamespacedClient):
             row represents all the values of a certain column in the results.
         :param delimiter: The character to use between values within a CSV row. Only
             valid for the CSV format.
+        :param drop_null_columns: Should columns that are entirely `null` be removed
+            from the `columns` and `values` portion of the results? Defaults to `false`.
+            If `true` then the response will include an extra section under the name
+            `all_columns` which has the name of all columns.
         :param filter: Specify a Query DSL query in the filter parameter to filter the
             set of documents that an ES|QL query runs on.
         :param format: A short version of the Accept header, e.g. json, yaml.
@@ -65,6 +91,12 @@ class EsqlClient(NamespacedClient):
         :param params: To avoid any attempts of hacking or code injection, extract the
             values in a separate list of parameters. Use question mark placeholders (?)
             in the query string for each of the parameters.
+        :param profile: If provided and `true` the response will include an extra `profile`
+            object with information on how the query was executed. This information is
+            for human debugging and its format can change at any time but it can give
+            some insight into the performance of each part of the query.
+        :param tables: Tables to use with the LOOKUP operation. The top level key is
+            the table name and the next level key is the column name.
         """
         if query is None and body is None:
             raise ValueError("Empty value passed for parameter 'query'")
@@ -74,6 +106,8 @@ class EsqlClient(NamespacedClient):
         __body: t.Dict[str, t.Any] = body if body is not None else {}
         if delimiter is not None:
             __query["delimiter"] = delimiter
+        if drop_null_columns is not None:
+            __query["drop_null_columns"] = drop_null_columns
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
@@ -95,6 +129,10 @@ class EsqlClient(NamespacedClient):
                 __body["locale"] = locale
             if params is not None:
                 __body["params"] = params
+            if profile is not None:
+                __body["profile"] = profile
+            if tables is not None:
+                __body["tables"] = tables
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
             "POST",

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 _rewrite_parameters
+from .utils import Stability, _rewrite_parameters, _stability_warning
 
 
 class FeaturesClient(NamespacedClient):
@@ -38,7 +38,7 @@ class FeaturesClient(NamespacedClient):
         Gets a list of features which can be included in snapshots using the feature_states
         field when creating a snapshot
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-features-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-features-api.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_features"
@@ -62,6 +62,7 @@ class FeaturesClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def reset_features(
         self,
         *,
@@ -73,7 +74,7 @@ class FeaturesClient(NamespacedClient):
         """
         Resets the internal state of features, usually by deleting system indices
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/modules-snapshots.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_features/_reset"

elasticsearch/_async/client/fleet.py

@@ -20,7 +20,13 @@ import typing as t
 from elastic_transport import ObjectApiResponse
 
 from ._base import NamespacedClient
-from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
+from .utils import (
+    SKIP_IN_PATH,
+    Stability,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class FleetClient(NamespacedClient):
@@ -43,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.15/get-global-checkpoints.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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
@@ -91,6 +97,7 @@ class FleetClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="searches",
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def msearch(
         self,
         *,
@@ -277,6 +284,7 @@ class FleetClient(NamespacedClient):
             "from": "from_",
         },
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def search(
         self,
         *,

elasticsearch/_async/client/graph.py

@@ -48,7 +48,7 @@ class GraphClient(NamespacedClient):
         Extracts and summarizes information about the documents and terms in an Elasticsearch
         data stream or index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/graph-explore-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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

@@ -42,7 +42,7 @@ class IlmClient(NamespacedClient):
         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.15/ilm-delete-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-delete-lifecycle.html>`_
 
         :param name: Identifier for the policy.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -97,7 +97,7 @@ class IlmClient(NamespacedClient):
         currently executing phase, action, and step. Shows when the index entered each
         one, the definition of the running phase, and information about any failures.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-explain-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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 `*`
@@ -159,7 +159,7 @@ class IlmClient(NamespacedClient):
         """
         Retrieves a lifecycle policy.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-get-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-get-lifecycle.html>`_
 
         :param name: Identifier for the policy.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -210,7 +210,7 @@ class IlmClient(NamespacedClient):
         """
         Retrieves the current index lifecycle management (ILM) status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-get-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-get-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ilm/status"
@@ -254,7 +254,7 @@ class IlmClient(NamespacedClient):
         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.15/ilm-migrate-to-data-tiers.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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
@@ -304,17 +304,17 @@ class IlmClient(NamespacedClient):
         *,
         index: str,
         current_step: t.Optional[t.Mapping[str, t.Any]] = None,
+        next_step: t.Optional[t.Mapping[str, t.Any]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
-        next_step: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
         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.15/ilm-move-to-step.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-move-to-step.html>`_
 
         :param index: The name of the index whose lifecycle step is to change
         :param current_step:
@@ -322,6 +322,10 @@ class IlmClient(NamespacedClient):
         """
         if index in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'index'")
+        if current_step is None and body is None:
+            raise ValueError("Empty value passed for parameter 'current_step'")
+        if next_step is None and body is None:
+            raise ValueError("Empty value passed for parameter 'next_step'")
         __path_parts: t.Dict[str, str] = {"index": _quote(index)}
         __path = f'/_ilm/move/{__path_parts["index"]}'
         __query: t.Dict[str, t.Any] = {}
@@ -374,7 +378,7 @@ class IlmClient(NamespacedClient):
         Creates a lifecycle policy. If the specified policy exists, the policy is replaced
         and the policy version is incremented.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-put-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-put-lifecycle.html>`_
 
         :param name: Identifier for the policy.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -433,7 +437,7 @@ class IlmClient(NamespacedClient):
         """
         Removes the assigned lifecycle policy and stops managing the specified index
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-remove-policy.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-remove-policy.html>`_
 
         :param index: The name of the index to remove policy on
         """
@@ -473,7 +477,7 @@ class IlmClient(NamespacedClient):
         """
         Retries executing the policy for an index that is in the ERROR step.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-retry-policy.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-retry-policy.html>`_
 
         :param index: The name of the indices (comma-separated) whose failed lifecycle
             step is to be retry
@@ -515,7 +519,7 @@ class IlmClient(NamespacedClient):
         """
         Start the index lifecycle management (ILM) plugin.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-start.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-start.html>`_
 
         :param master_timeout:
         :param timeout:
@@ -560,7 +564,7 @@ class IlmClient(NamespacedClient):
         Halts all lifecycle management operations and stops the index lifecycle management
         (ILM) plugin
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-stop.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-stop.html>`_
 
         :param master_timeout:
         :param timeout: