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

elasticsearch/_sync/client/transform.py

@@ -41,7 +41,7 @@ class TransformClient(NamespacedClient):
         """
         Delete a transform. Deletes a transform.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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):
         """
         Get transforms. Retrieves configuration information for transforms.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -170,7 +170,7 @@ class TransformClient(NamespacedClient):
         """
         Get transform stats. Retrieves usage information for transforms.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-transform-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -256,7 +256,7 @@ class TransformClient(NamespacedClient):
         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.16/preview-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -393,7 +393,7 @@ class TransformClient(NamespacedClient):
         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.16/put-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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.
@@ -495,7 +495,7 @@ class TransformClient(NamespacedClient):
         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.16/reset-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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.
@@ -547,7 +547,7 @@ class TransformClient(NamespacedClient):
         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.16/schedule-now-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/schedule-now-transform.html>`_
 
         :param transform_id: Identifier for the transform.
         :param timeout: Controls the time to wait for the scheduling to take place
@@ -611,7 +611,7 @@ class TransformClient(NamespacedClient):
         privileges on the source and destination indices, the transform fails when it
         attempts unauthorized operations.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/start-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-transform.html>`_
 
         :param transform_id: Identifier for the transform.
         :param from_: Restricts the set of transformed entities to those changed after
@@ -665,7 +665,7 @@ class TransformClient(NamespacedClient):
         """
         Stop transforms. Stops one or more transforms.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/stop-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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,
@@ -765,7 +765,7 @@ class TransformClient(NamespacedClient):
         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.16/update-transform.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-transform.html>`_
 
         :param transform_id: Identifier for the transform.
         :param defer_validation: When true, deferrable validations are not run. This
@@ -844,15 +844,22 @@ class TransformClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Upgrades all transforms. This API identifies transforms that have a legacy configuration
+        Upgrade all transforms. Transforms are compatible across minor versions and between
+        supported major versions. However, over time, the format of transform configuration
+        information may change. 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.16/upgrade-transforms.html>`_
+        unchanged. If a transform upgrade step fails, the upgrade stops and an error
+        is returned about the underlying issue. Resolve the issue then re-run the process
+        again. A summary is returned when the upgrade is finished. To ensure continuous
+        transforms remain running during a major version upgrade of the cluster – for
+        example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading
+        the cluster. You may want to perform a recent cluster backup prior to the upgrade.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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/_sync/client/watcher.py

@@ -37,12 +37,20 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Acknowledges a watch, manually throttling the execution of the watch's actions.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-ack-watch.html>`_
-
-        :param watch_id: Watch ID
-        :param action_id: A comma-separated list of the action ids to be acked
+        Acknowledge a watch. Acknowledging a watch enables you to manually throttle the
+        execution of the watch's actions. The acknowledgement state of an action is stored
+        in the `status.actions.<id>.ack.state` structure. IMPORTANT: If the specified
+        watch is currently being executed, this API will return an error The reason for
+        this behavior is to prevent overwriting the watch status from a watch execution.
+        Acknowledging an action throttles further executions of that action until its
+        `ack.state` is reset to `awaits_successful_execution`. This happens when the
+        condition of the watch is not met (the condition evaluates to false).
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-ack-watch.html>`_
+
+        :param watch_id: The watch identifier.
+        :param action_id: A comma-separated list of the action identifiers to acknowledge.
+            If you omit this parameter, all of the actions of the watch are acknowledged.
         """
         if watch_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'watch_id'")
@@ -88,11 +96,11 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Activates a currently inactive watch.
+        Activate a watch. A watch can be either active or inactive.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-activate-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-activate-watch.html>`_
 
-        :param watch_id: Watch ID
+        :param watch_id: The watch identifier.
         """
         if watch_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'watch_id'")
@@ -128,11 +136,11 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deactivates a currently active watch.
+        Deactivate a watch. A watch can be either active or inactive.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-deactivate-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-deactivate-watch.html>`_
 
-        :param watch_id: Watch ID
+        :param watch_id: The watch identifier.
         """
         if watch_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'watch_id'")
@@ -168,11 +176,17 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Removes a watch from Watcher.
+        Delete a watch. When the watch is removed, the document representing the watch
+        in the `.watches` index is gone and it will never be run again. Deleting a watch
+        does not delete any watch execution records related to this watch from the watch
+        history. IMPORTANT: Deleting a watch must be done by using only this API. Do
+        not delete the watch directly from the `.watches` index using the Elasticsearch
+        delete document API When Elasticsearch security features are enabled, make sure
+        no write privileges are granted to anyone for the `.watches` index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-delete-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-delete-watch.html>`_
 
-        :param id: Watch ID
+        :param id: The watch identifier.
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
@@ -237,17 +251,25 @@ class WatcherClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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
+        Run a 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 run the watch without running 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.16/watcher-api-execute-watch.html>`_
-
-        :param id: Identifier for the watch.
+        it runs. You can use the run watch API to run watches that are not yet registered
+        by specifying the watch definition inline. This serves as great tool for testing
+        and debugging your watches prior to adding them to Watcher. When Elasticsearch
+        security features are enabled on your cluster, watches are run with the privileges
+        of the user that stored the watches. If your user is allowed to read index `a`,
+        but not index `b`, then the exact same set of rules will apply during execution
+        of a watch. When using the run watch API, the authorization data of the user
+        that called the API will be used as a base, instead of the information who stored
+        the watch.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-execute-watch.html>`_
+
+        :param id: The watch identifier.
         :param action_modes: Determines how to handle the watch actions as part of the
             watch execution.
         :param alternative_input: When present, the watch uses this object as a payload
@@ -258,12 +280,12 @@ class WatcherClient(NamespacedClient):
         :param record_execution: When set to `true`, the watch record representing the
             watch execution result is persisted to the `.watcher-history` index for the
             current time. In addition, the status of the watch is updated, possibly throttling
-            subsequent executions. This can also be specified as an HTTP parameter.
+            subsequent runs. This can also be specified as an HTTP parameter.
         :param simulated_actions:
         :param trigger_data: This structure is parsed as the data of the trigger event
-            that will be used during the watch execution
+            that will be used during the watch execution.
         :param watch: When present, this watch is used instead of the one specified in
-            the request. This watch is not persisted to the index and record_execution
+            the request. This watch is not persisted to the index and `record_execution`
             cannot be set.
         """
         __path_parts: t.Dict[str, str]
@@ -315,6 +337,50 @@ class WatcherClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters()
+    def get_settings(
+        self,
+        *,
+        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[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Get Watcher index settings. Get settings for the Watcher internal index (`.watches`).
+        Only a subset of settings are shown, for example `index.auto_expand_replicas`
+        and `index.number_of_replicas`.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-settings.html>`_
+
+        :param master_timeout: The period to wait for a connection to the master node.
+            If no response is received before the timeout expires, the request fails
+            and returns an error.
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_watcher/settings"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="watcher.get_settings",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     def get_watch(
         self,
@@ -326,11 +392,11 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves a watch by its ID.
+        Get a watch.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-get-watch.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-watch.html>`_
 
-        :param id: Watch ID
+        :param id: The watch identifier.
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
@@ -362,6 +428,7 @@ class WatcherClient(NamespacedClient):
             "input",
             "metadata",
             "throttle_period",
+            "throttle_period_in_millis",
             "transform",
             "trigger",
         ),
@@ -381,30 +448,50 @@ class WatcherClient(NamespacedClient):
         input: t.Optional[t.Mapping[str, t.Any]] = None,
         metadata: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
-        throttle_period: t.Optional[str] = None,
+        throttle_period: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+        throttle_period_in_millis: t.Optional[t.Any] = None,
         transform: t.Optional[t.Mapping[str, t.Any]] = None,
         trigger: t.Optional[t.Mapping[str, t.Any]] = None,
         version: t.Optional[int] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates a new watch, or updates an existing one.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-put-watch.html>`_
-
-        :param id: Watch ID
-        :param actions:
-        :param active: Specify whether the watch is in/active by default
-        :param condition:
+        Create or update a watch. When a watch is registered, a new document that represents
+        the watch is added to the `.watches` index and its trigger is immediately registered
+        with the relevant trigger engine. Typically for the `schedule` trigger, the scheduler
+        is the trigger engine. IMPORTANT: You must use Kibana or this API to create a
+        watch. Do not add a watch directly to the `.watches` index by using the Elasticsearch
+        index API. If Elasticsearch security features are enabled, do not give users
+        write privileges on the `.watches` index. When you add a watch you can also define
+        its initial active state by setting the *active* parameter. When Elasticsearch
+        security features are enabled, your watch can index or search only on indices
+        for which the user that stored the watch has privileges. If the user is able
+        to read index `a`, but not index `b`, the same will apply when the watch runs.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-put-watch.html>`_
+
+        :param id: The identifier for the watch.
+        :param actions: The list of actions that will be run if the condition matches.
+        :param active: The initial state of the watch. The default value is `true`, which
+            means the watch is active by default.
+        :param condition: The condition that defines if the actions should be run.
         :param if_primary_term: only update the watch if the last operation that has
             changed the watch has the specified primary term
         :param if_seq_no: only update the watch if the last operation that has changed
             the watch has the specified sequence number
-        :param input:
-        :param metadata:
-        :param throttle_period:
-        :param transform:
-        :param trigger:
+        :param input: The input that defines the input that loads the data for the watch.
+        :param metadata: Metadata JSON that will be copied into the history entries.
+        :param throttle_period: The minimum time between actions being run. The default
+            is 5 seconds. This default can be changed in the config file with the setting
+            `xpack.watcher.throttle.period.default_period`. If both this value and the
+            `throttle_period_in_millis` parameter are specified, Watcher uses the last
+            parameter included in the request.
+        :param throttle_period_in_millis: Minimum time in milliseconds between actions
+            being run. Defaults to 5000. If both this value and the throttle_period parameter
+            are specified, Watcher uses the last parameter included in the request.
+        :param transform: The transform that processes the watch payload to prepare it
+            for the watch actions.
+        :param trigger: The trigger that defines when the watch should run.
         :param version: Explicit version number for concurrency control
         """
         if id in SKIP_IN_PATH:
@@ -440,6 +527,8 @@ class WatcherClient(NamespacedClient):
                 __body["metadata"] = metadata
             if throttle_period is not None:
                 __body["throttle_period"] = throttle_period
+            if throttle_period_in_millis is not None:
+                __body["throttle_period_in_millis"] = throttle_period_in_millis
             if transform is not None:
                 __body["transform"] = transform
             if trigger is not None:
@@ -485,16 +574,18 @@ class WatcherClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves stored watches.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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.
-        :param search_after: Optional search After to do pagination using last hit’s
-            sort values.
-        :param size: The number of hits to return. Needs to be non-negative.
-        :param sort: Optional sort definition.
+        Query watches. Get all registered watches in a paginated manner and optionally
+        filter watches by a query. Note that only the `_id` and `metadata.*` fields are
+        queryable or sortable.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-query-watches.html>`_
+
+        :param from_: The offset from the first result to fetch. It must be non-negative.
+        :param query: A query that filters the watches to be returned.
+        :param search_after: Retrieve the next page of hits using a set of sort values
+            from the previous page.
+        :param size: The number of hits to return. It must be non-negative.
+        :param sort: One or more fields used to sort the search results.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_watcher/_query/watches"
@@ -555,9 +646,9 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Starts Watcher if it is not already running.
+        Start the watch service. Start the Watcher service if it is not already running.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-start.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-start.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_watcher/_start"
@@ -612,9 +703,10 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves the current Watcher metrics.
+        Get Watcher statistics. This API always returns basic metrics. You retrieve more
+        metrics by using the metric parameter.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -655,12 +747,17 @@ class WatcherClient(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[str, t.Literal[-1], t.Literal[0]]] = None,
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stops Watcher if it is running.
+        Stop the watch service. Stop the Watcher service if it is running.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stop.html>`_
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-stop.html>`_
+        :param master_timeout: The period to wait for the master node. If the master
+            node is not available before the timeout expires, the request fails and returns
+            an error. To indicate that the request should never timeout, set it to `-1`.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_watcher/_stop"
@@ -671,6 +768,8 @@ class WatcherClient(NamespacedClient):
             __query["filter_path"] = filter_path
         if human is not None:
             __query["human"] = human
+        if master_timeout is not None:
+            __query["master_timeout"] = master_timeout
         if pretty is not None:
             __query["pretty"] = pretty
         __headers = {"accept": "application/json"}
@@ -682,3 +781,70 @@ class WatcherClient(NamespacedClient):
             endpoint_id="watcher.stop",
             path_parts=__path_parts,
         )
+
+    @_rewrite_parameters(
+        body_fields=("index_auto_expand_replicas", "index_number_of_replicas"),
+        parameter_aliases={
+            "index.auto_expand_replicas": "index_auto_expand_replicas",
+            "index.number_of_replicas": "index_number_of_replicas",
+        },
+    )
+    def update_settings(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        index_auto_expand_replicas: t.Optional[str] = None,
+        index_number_of_replicas: t.Optional[int] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = 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]:
+        """
+        Update Watcher index settings. Update settings for the Watcher internal index
+        (`.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`
+        and `index.number_of_replicas`.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-update-settings.html>`_
+
+        :param index_auto_expand_replicas:
+        :param index_number_of_replicas:
+        :param master_timeout: The period to wait for a connection to the master node.
+            If no response is received before the timeout expires, the request fails
+            and returns an error.
+        :param timeout: The period to wait for a response. If no response is received
+            before the timeout expires, the request fails and returns an error.
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_watcher/settings"
+        __query: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        if timeout is not None:
+            __query["timeout"] = timeout
+        if not __body:
+            if index_auto_expand_replicas is not None:
+                __body["index.auto_expand_replicas"] = index_auto_expand_replicas
+            if index_number_of_replicas is not None:
+                __body["index.number_of_replicas"] = index_number_of_replicas
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="watcher.update_settings",
+            path_parts=__path_parts,
+        )

elasticsearch/_sync/client/xpack.py

@@ -43,9 +43,12 @@ class XPackClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Provides general information about the installed X-Pack features.
+        Get information. The information provided by the API includes: * Build information
+        including the build number and timestamp. * License information about the currently
+        installed license. * Feature information for the features that are currently
+        enabled and available under the current license.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/info-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -87,14 +90,16 @@ class XPackClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        This API provides information about which features are currently enabled and
-        available under the current license and some usage statistics.
+        Get usage information. Get information about the features that are currently
+        enabled and available under the current license. The API also provides some usage
+        statistics.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/usage-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
-            returns an error.
+        :param master_timeout: The period to wait for a connection to the master node.
+            If no response is received before the timeout expires, the request fails
+            and returns an error. To indicate that the request should never timeout,
+            set it to `-1`.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_xpack/usage"

elasticsearch/_version.py

@@ -15,4 +15,4 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-__versionstr__ = "8.16.0"
+__versionstr__ = "8.17.1"

elasticsearch/client.py

@@ -57,6 +57,7 @@ from ._sync.client.searchable_snapshots import (  # noqa: F401
 )
 from ._sync.client.security import SecurityClient as SecurityClient  # noqa: F401
 from ._sync.client.shutdown import ShutdownClient as ShutdownClient  # noqa: F401
+from ._sync.client.simulate import SimulateClient as SimulateClient  # noqa: F401
 from ._sync.client.slm import SlmClient as SlmClient  # noqa: F401
 from ._sync.client.snapshot import SnapshotClient as SnapshotClient  # noqa: F401
 from ._sync.client.sql import SqlClient as SqlClient  # noqa: F401
@@ -107,6 +108,7 @@ __all__ = [
     "SearchableSnapshotsClient",
     "SecurityClient",
     "ShutdownClient",
+    "SimulateClient",
     "SlmClient",
     "SnapshotClient",
     "SqlClient",

{elasticsearch-8.16.0.dist-info → elasticsearch-8.17.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: elasticsearch
-Version: 8.16.0
+Version: 8.17.1
 Summary: Python client for Elasticsearch
 Project-URL: Documentation, https://elasticsearch-py.readthedocs.io/
 Project-URL: Homepage, https://github.com/elastic/elasticsearch-py
@@ -8,7 +8,9 @@ Project-URL: Issue Tracker, https://github.com/elastic/elasticsearch-py/issues
 Project-URL: Source Code, https://github.com/elastic/elasticsearch-py
 Author-email: Elastic Client Library Maintainers <client-libs@elastic.co>
 Maintainer-email: Elastic Client Library Maintainers <client-libs@elastic.co>
-License: Apache-2.0
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
 Keywords: REST,client,elastic,elasticsearch,index,kibana,mapping,search
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -47,7 +49,7 @@ Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: python-dateutil; extra == 'dev'
 Requires-Dist: pyyaml>=5.4; extra == 'dev'
 Requires-Dist: requests<3,>=2; extra == 'dev'
-Requires-Dist: simsimd; (python_version < '3.13') and extra == 'dev'
+Requires-Dist: simsimd; extra == 'dev'
 Requires-Dist: twine; extra == 'dev'
 Requires-Dist: unasync; extra == 'dev'
 Provides-Extra: docs