elasticsearch 8.13.2__py3-none-any.whl → 8.15.0__py3-none-any.whl

elasticsearch/_async/client/transform.py

@@ -36,12 +36,12 @@ class TransformClient(NamespacedClient):
         force: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes an existing transform.
+        Deletes a transform.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-transform.html>`_
 
         :param transform_id: Identifier for the transform.
         :param delete_dest_index: If this value is true, the destination index is deleted
@@ -101,7 +101,7 @@ class TransformClient(NamespacedClient):
         """
         Retrieves configuration information for transforms.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-transform.html>`_
 
         :param transform_id: Identifier for the transform. It can be a transform identifier
             or a wildcard expression. You can get information for all transforms by using
@@ -165,12 +165,12 @@ class TransformClient(NamespacedClient):
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
         size: t.Optional[int] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Retrieves usage information for transforms.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-transform-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-transform-stats.html>`_
 
         :param transform_id: Identifier for the transform. It can be a transform identifier
             or a wildcard expression. You can get information for all transforms by using
@@ -236,7 +236,7 @@ class TransformClient(NamespacedClient):
         dest: 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,
-        frequency: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        frequency: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         human: t.Optional[bool] = None,
         latest: t.Optional[t.Mapping[str, t.Any]] = None,
         pivot: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -245,13 +245,16 @@ class TransformClient(NamespacedClient):
         settings: t.Optional[t.Mapping[str, t.Any]] = None,
         source: t.Optional[t.Mapping[str, t.Any]] = None,
         sync: t.Optional[t.Mapping[str, t.Any]] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Previews a transform.
+        Previews a transform. It returns a maximum of 100 results. The calculations are
+        based on all the current data in the source index. It also generates a list of
+        mappings and settings for the destination index. These values are determined
+        based on the field types of the source index and the transform aggregations.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/preview-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/preview-transform.html>`_
 
         :param transform_id: Identifier for the transform to preview. If you specify
             this path parameter, you cannot provide transform configuration details in
@@ -353,7 +356,7 @@ class TransformClient(NamespacedClient):
         description: t.Optional[str] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        frequency: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        frequency: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         human: t.Optional[bool] = None,
         latest: t.Optional[t.Mapping[str, t.Any]] = None,
         meta: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -362,13 +365,32 @@ class TransformClient(NamespacedClient):
         retention_policy: t.Optional[t.Mapping[str, t.Any]] = None,
         settings: t.Optional[t.Mapping[str, t.Any]] = None,
         sync: t.Optional[t.Mapping[str, t.Any]] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Instantiates a transform.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/put-transform.html>`_
+        Creates a transform. A transform copies data from source indices, transforms
+        it, and persists it into an entity-centric destination index. You can also think
+        of the destination index as a two-dimensional tabular data structure (known as
+        a data frame). The ID for each document in the data frame is generated from a
+        hash of the entity, so there is a unique row per entity. You must choose either
+        the latest or pivot method for your transform; you cannot use both in a single
+        transform. If you choose to use the pivot method for your transform, the entities
+        are defined by the set of `group_by` fields in the pivot object. If you choose
+        to use the latest method, the entities are defined by the `unique_key` field
+        values in the latest object. You must have `create_index`, `index`, and `read`
+        privileges on the destination index and `read` and `view_index_metadata` privileges
+        on the source indices. When Elasticsearch security features are enabled, the
+        transform remembers which roles the user that created it had at the time of creation
+        and uses those same roles. If those roles do not have the required privileges
+        on the source and destination indices, the transform fails when it attempts unauthorized
+        operations. NOTE: You must use Kibana or this API to create a transform. Do not
+        add a transform directly into any `.transform-internal*` indices using the Elasticsearch
+        index API. If Elasticsearch security features are enabled, do not give users
+        any privileges on `.transform-internal*` indices. If you used transforms prior
+        to 7.5, also do not give users any privileges on `.data-frame-internal*` indices.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-transform.html>`_
 
         :param transform_id: Identifier for the transform. This identifier can contain
             lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
@@ -466,9 +488,11 @@ class TransformClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Resets an existing transform.
+        Resets a transform. Before you can reset it, you must stop it; alternatively,
+        use the `force` query parameter. If the destination index was created by the
+        transform, it is deleted.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/reset-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/reset-transform.html>`_
 
         :param transform_id: Identifier for the transform. This identifier can contain
             lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
@@ -511,12 +535,15 @@ class TransformClient(NamespacedClient):
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Schedules now a transform.
+        Schedules now a transform. If you _schedule_now a transform, it will process
+        the new data instantly, without waiting for the configured frequency interval.
+        After _schedule_now API is called, the transform will be processed again at now
+        + frequency unless _schedule_now API is called again in the meantime.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/schedule-now-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/schedule-now-transform.html>`_
 
         :param transform_id: Identifier for the transform.
         :param timeout: Controls the time to wait for the scheduling to take place
@@ -558,12 +585,28 @@ class TransformClient(NamespacedClient):
         from_: t.Optional[str] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Starts one or more transforms.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/start-transform.html>`_
+        Starts a transform. When you start a transform, it creates the destination index
+        if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas`
+        is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions
+        for the destination index from the source indices and the transform aggregations.
+        If fields in the destination index are derived from scripts (as in the case of
+        `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic
+        mappings unless an index template exists. If it is a latest transform, it does
+        not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings,
+        create the destination index before you start the transform. Alternatively, you
+        can create an index template, though it does not affect the deduced mappings
+        in a pivot transform. When the transform starts, a series of validations occur
+        to ensure its success. If you deferred validation when you created the transform,
+        they occur when you start the transform—​with the exception of privilege checks.
+        When Elasticsearch security features are enabled, the transform remembers which
+        roles the user that created it had at the time of creation and uses those same
+        roles. If those roles do not have the required privileges on the source and destination
+        indices, the transform fails when it attempts unauthorized operations.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-transform.html>`_
 
         :param transform_id: Identifier for the transform.
         :param from_: Restricts the set of transformed entities to those changed after
@@ -610,14 +653,14 @@ class TransformClient(NamespacedClient):
         force: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         wait_for_checkpoint: t.Optional[bool] = None,
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Stops one or more transforms.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/stop-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/stop-transform.html>`_
 
         :param transform_id: Identifier for the transform. To stop multiple transforms,
             use a comma-separated list or a wildcard expression. To stop all transforms,
@@ -696,7 +739,7 @@ class TransformClient(NamespacedClient):
         dest: 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,
-        frequency: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        frequency: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         human: t.Optional[bool] = None,
         meta: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
@@ -704,13 +747,19 @@ class TransformClient(NamespacedClient):
         settings: t.Optional[t.Mapping[str, t.Any]] = None,
         source: t.Optional[t.Mapping[str, t.Any]] = None,
         sync: t.Optional[t.Mapping[str, t.Any]] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates certain properties of a transform.
+        Updates certain properties of a transform. All updated properties except `description`
+        do not take effect until after the transform starts the next checkpoint, thus
+        there is data consistency in each checkpoint. To use this API, you must have
+        `read` and `view_index_metadata` privileges for the source indices. You must
+        also have `index` and `read` privileges for the destination index. When Elasticsearch
+        security features are enabled, the transform remembers which roles the user who
+        updated it had at the time of update and runs with those privileges.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/update-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-transform.html>`_
 
         :param transform_id: Identifier for the transform.
         :param defer_validation: When true, deferrable validations are not run. This
@@ -786,12 +835,18 @@ class TransformClient(NamespacedClient):
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Upgrades all transforms.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/upgrade-transforms.html>`_
+        Upgrades all transforms. This API identifies transforms that have a legacy configuration
+        format and upgrades them to the latest version. It also cleans up the internal
+        data structures that store the transform state and checkpoints. The upgrade does
+        not affect the source and destination indices. The upgrade also does not affect
+        the roles that transforms use when Elasticsearch security features are enabled;
+        the role used to read source data and write to the destination index remains
+        unchanged.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/upgrade-transforms.html>`_
 
         :param dry_run: When true, the request checks for updates but does not run them.
         :param timeout: Period to wait for a response. If no response is received before

elasticsearch/_async/client/watcher.py

@@ -39,7 +39,7 @@ class WatcherClient(NamespacedClient):
         """
         Acknowledges a watch, manually throttling the execution of the watch's actions.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-ack-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-ack-watch.html>`_
 
         :param watch_id: Watch ID
         :param action_id: A comma-separated list of the action ids to be acked
@@ -90,7 +90,7 @@ class WatcherClient(NamespacedClient):
         """
         Activates a currently inactive watch.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-activate-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-activate-watch.html>`_
 
         :param watch_id: Watch ID
         """
@@ -130,7 +130,7 @@ class WatcherClient(NamespacedClient):
         """
         Deactivates a currently active watch.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-deactivate-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-deactivate-watch.html>`_
 
         :param watch_id: Watch ID
         """
@@ -170,7 +170,7 @@ class WatcherClient(NamespacedClient):
         """
         Removes a watch from Watcher.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-delete-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-delete-watch.html>`_
 
         :param id: Watch ID
         """
@@ -216,8 +216,10 @@ class WatcherClient(NamespacedClient):
             t.Mapping[
                 str,
                 t.Union[
-                    "t.Literal['execute', 'force_execute', 'force_simulate', 'simulate', 'skip']",
                     str,
+                    t.Literal[
+                        "execute", "force_execute", "force_simulate", "simulate", "skip"
+                    ],
                 ],
             ]
         ] = None,
@@ -235,9 +237,15 @@ class WatcherClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Forces the execution of a stored watch.
+        This API can be used to force execution of the watch outside of its triggering
+        logic or to simulate the watch execution for debugging purposes. For testing
+        and debugging purposes, you also have fine-grained control on how the watch runs.
+        You can execute the watch without executing all of its actions or alternatively
+        by simulating them. You can also force execution by ignoring the watch condition
+        and control whether a watch record would be written to the watch history after
+        execution.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-execute-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-execute-watch.html>`_
 
         :param id: Identifier for the watch.
         :param action_modes: Determines how to handle the watch actions as part of the
@@ -320,7 +328,7 @@ class WatcherClient(NamespacedClient):
         """
         Retrieves a watch by its ID.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-get-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-get-watch.html>`_
 
         :param id: Watch ID
         """
@@ -382,7 +390,7 @@ class WatcherClient(NamespacedClient):
         """
         Creates a new watch, or updates an existing one.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-put-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-put-watch.html>`_
 
         :param id: Watch ID
         :param actions:
@@ -479,7 +487,7 @@ class WatcherClient(NamespacedClient):
         """
         Retrieves stored watches.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-query-watches.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-query-watches.html>`_
 
         :param from_: The offset from the first result to fetch. Needs to be non-negative.
         :param query: Optional, query filter watches to be returned.
@@ -549,7 +557,7 @@ class WatcherClient(NamespacedClient):
         """
         Starts Watcher if it is not already running.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-start.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-start.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_watcher/_start"
@@ -580,13 +588,20 @@ class WatcherClient(NamespacedClient):
             t.Union[
                 t.Sequence[
                     t.Union[
-                        "t.Literal['_all', 'current_watches', 'pending_watches', 'queued_watches']",
                         str,
+                        t.Literal[
+                            "_all",
+                            "current_watches",
+                            "pending_watches",
+                            "queued_watches",
+                        ],
                     ]
                 ],
                 t.Union[
-                    "t.Literal['_all', 'current_watches', 'pending_watches', 'queued_watches']",
                     str,
+                    t.Literal[
+                        "_all", "current_watches", "pending_watches", "queued_watches"
+                    ],
                 ],
             ]
         ] = None,
@@ -599,7 +614,7 @@ class WatcherClient(NamespacedClient):
         """
         Retrieves the current Watcher metrics.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-stats.html>`_
 
         :param metric: Defines which additional metrics are included in the response.
         :param emit_stacktraces: Defines whether stack traces are generated for each
@@ -645,7 +660,7 @@ class WatcherClient(NamespacedClient):
         """
         Stops Watcher if it is running.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/watcher-api-stop.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/watcher-api-stop.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_watcher/_stop"

elasticsearch/_async/client/xpack.py

@@ -41,9 +41,9 @@ class XPackClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves information about the installed X-Pack features.
+        Provides general information about the installed X-Pack features.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/info-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/info-api.html>`_
 
         :param accept_enterprise: If this param is used it must be set to true
         :param categories: A comma-separated list of the information categories to include
@@ -81,15 +81,14 @@ class XPackClient(NamespacedClient):
         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["t.Literal[-1]", "t.Literal[0]", str]
-        ] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves usage information about the installed X-Pack features.
+        This API provides information about which features are currently enabled and
+        available under the current license and some usage statistics.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/usage-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/usage-api.html>`_
 
         :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

elasticsearch/_otel.py

@@ -19,10 +19,7 @@ from __future__ import annotations
 
 import contextlib
 import os
-from typing import TYPE_CHECKING, Generator, Mapping
-
-if TYPE_CHECKING:
-    from typing import Literal
+from typing import Generator, Literal, Mapping
 
 try:
     from opentelemetry import trace
@@ -48,8 +45,7 @@ class OpenTelemetry:
         self,
         enabled: bool | None = None,
         tracer: trace.Tracer | None = None,
-        # TODO import Literal at the top-level when dropping Python 3.7
-        body_strategy: 'Literal["omit", "raw"]' | None = None,
+        body_strategy: Literal["omit", "raw"] | None = None,
     ):
         if enabled is None:
             enabled = os.environ.get(ENABLED_ENV_VAR, "true") == "true"