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

elasticsearch/_sync/client/transform.py

@@ -39,7 +39,11 @@ class TransformClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a transform. Deletes a transform.
+        .. raw:: html
+
+          <p>Delete a transform.
+          Deletes a transform.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-transform.html>`_
 
@@ -99,7 +103,11 @@ class TransformClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get transforms. Retrieves configuration information for transforms.
+        .. raw:: html
+
+          <p>Get transforms.
+          Retrieves configuration information for transforms.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform.html>`_
 
@@ -168,7 +176,11 @@ class TransformClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get transform stats. Retrieves usage information for transforms.
+        .. raw:: html
+
+          <p>Get transform stats.
+          Retrieves usage information for transforms.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform-stats.html>`_
 
@@ -249,12 +261,14 @@ class TransformClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Preview a transform. Generates a preview of the results that you will get when
-        you create a transform with the same configuration. 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.
+        .. raw:: html
+
+          <p>Preview a transform.
+          Generates a preview of the results that you will get when you create a transform with the same configuration.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/preview-transform.html>`_
 
@@ -371,27 +385,27 @@ class TransformClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a transform. 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.
+        .. raw:: html
+
+          <p>Create a transform.
+          Creates a transform.</p>
+          <p>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.</p>
+          <p>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 <code>group_by</code> fields in
+          the pivot object. If you choose to use the latest method, the entities are defined by the <code>unique_key</code> field values
+          in the latest object.</p>
+          <p>You must have <code>create_index</code>, <code>index</code>, and <code>read</code> privileges on the destination index and <code>read</code> and
+          <code>view_index_metadata</code> 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.</p>
+          <p>NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
+          <code>.transform-internal*</code> indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
+          not give users any privileges on <code>.transform-internal*</code> indices. If you used transforms prior to 7.5, also do not
+          give users any privileges on <code>.data-frame-internal*</code> indices.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-transform.html>`_
 
@@ -491,9 +505,13 @@ class TransformClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Reset a 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.
+        .. raw:: html
+
+          <p>Reset a transform.
+          Resets a transform.
+          Before you can reset it, you must stop it; alternatively, use the <code>force</code> query parameter.
+          If the destination index was created by the transform, it is deleted.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/reset-transform.html>`_
 
@@ -541,11 +559,15 @@ class TransformClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Schedule a transform to start now. Instantly runs a transform to process data.
-        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.
+        .. raw:: html
+
+          <p>Schedule a transform to start now.
+          Instantly runs a transform to process data.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/schedule-now-transform.html>`_
 
@@ -592,24 +614,24 @@ class TransformClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start a transform. 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.
+        .. raw:: html
+
+          <p>Start a transform.
+          Starts a transform.</p>
+          <p>When you start a transform, it creates the destination index if it does not already exist. The <code>number_of_shards</code> is
+          set to <code>1</code> and the <code>auto_expand_replicas</code> is set to <code>0-1</code>. 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 <code>scripted_metric</code> or <code>bucket_script</code> 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.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-transform.html>`_
 
@@ -663,7 +685,11 @@ class TransformClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stop transforms. Stops one or more transforms.
+        .. raw:: html
+
+          <p>Stop transforms.
+          Stops one or more transforms.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-transform.html>`_
 
@@ -756,14 +782,16 @@ class TransformClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update 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.
+        .. raw:: html
+
+          <p>Update a transform.
+          Updates certain properties of a transform.</p>
+          <p>All updated properties except <code>description</code> 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 <code>read</code> and <code>view_index_metadata</code>
+          privileges for the source indices. You must also have <code>index</code> and <code>read</code> 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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-transform.html>`_
 
@@ -844,20 +872,21 @@ class TransformClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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. 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.
+        .. raw:: html
+
+          <p>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.</p>
+          <p>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.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/upgrade-transforms.html>`_
 

elasticsearch/_sync/client/utils.py

@@ -232,7 +232,7 @@ def host_mapping_to_node_config(host: Mapping[str, Union[str, int]]) -> NodeConf
         )
         options["path_prefix"] = options.pop("url_prefix")
 
-    return NodeConfig(**options)  # type: ignore
+    return NodeConfig(**options)  # type: ignore[arg-type]
 
 
 def cloud_id_to_node_configs(cloud_id: str) -> List[NodeConfig]:

elasticsearch/_sync/client/watcher.py

@@ -37,14 +37,16 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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).
+        .. raw:: html
+
+          <p>Acknowledge a watch.
+          Acknowledging a watch enables you to manually throttle the execution of the watch's actions.</p>
+          <p>The acknowledgement state of an action is stored in the <code>status.actions.&lt;id&gt;.ack.state</code> structure.</p>
+          <p>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.</p>
+          <p>Acknowledging an action throttles further executions of that action until its <code>ack.state</code> is reset to <code>awaits_successful_execution</code>.
+          This happens when the condition of the watch is not met (the condition evaluates to false).</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-ack-watch.html>`_
 
@@ -96,7 +98,11 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Activate a watch. A watch can be either active or inactive.
+        .. raw:: html
+
+          <p>Activate a watch.
+          A watch can be either active or inactive.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-activate-watch.html>`_
 
@@ -136,7 +142,11 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deactivate a watch. A watch can be either active or inactive.
+        .. raw:: html
+
+          <p>Deactivate a watch.
+          A watch can be either active or inactive.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-deactivate-watch.html>`_
 
@@ -176,13 +186,15 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.
+        .. raw:: html
+
+          <p>Delete a watch.
+          When the watch is removed, the document representing the watch in the <code>.watches</code> index is gone and it will never be run again.</p>
+          <p>Deleting a watch does not delete any watch execution records related to this watch from the watch history.</p>
+          <p>IMPORTANT: Deleting a watch must be done by using only this API.
+          Do not delete the watch directly from the <code>.watches</code> index using the Elasticsearch delete document API
+          When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the <code>.watches</code> index.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-delete-watch.html>`_
 
@@ -251,21 +263,19 @@ class WatcherClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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
-        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.
+        .. raw:: html
+
+          <p>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.</p>
+          <p>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 it runs.</p>
+          <p>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.</p>
+          <p>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 <code>a</code>, but not index <code>b</code>, then the exact same set of rules will apply during execution of a watch.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-execute-watch.html>`_
 
@@ -348,9 +358,12 @@ class WatcherClient(NamespacedClient):
         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`.
+        .. raw:: html
+
+          <p>Get Watcher index settings.
+          Get settings for the Watcher internal index (<code>.watches</code>).
+          Only a subset of settings are shown, for example <code>index.auto_expand_replicas</code> and <code>index.number_of_replicas</code>.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-settings.html>`_
 
@@ -392,7 +405,10 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get a watch.
+        .. raw:: html
+
+          <p>Get a watch.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-watch.html>`_
 
@@ -456,17 +472,18 @@ class WatcherClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.
+        .. raw:: html
+
+          <p>Create or update a watch.
+          When a watch is registered, a new document that represents the watch is added to the <code>.watches</code> index and its trigger is immediately registered with the relevant trigger engine.
+          Typically for the <code>schedule</code> trigger, the scheduler is the trigger engine.</p>
+          <p>IMPORTANT: You must use Kibana or this API to create a watch.
+          Do not add a watch directly to the <code>.watches</code> index by using the Elasticsearch index API.
+          If Elasticsearch security features are enabled, do not give users write privileges on the <code>.watches</code> index.</p>
+          <p>When you add a watch you can also define its initial active state by setting the <em>active</em> parameter.</p>
+          <p>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 <code>a</code>, but not index <code>b</code>, the same will apply when the watch runs.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-put-watch.html>`_
 
@@ -574,9 +591,12 @@ class WatcherClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.
+        .. raw:: html
+
+          <p>Query watches.
+          Get all registered watches in a paginated manner and optionally filter watches by a query.</p>
+          <p>Note that only the <code>_id</code> and <code>metadata.*</code> fields are queryable or sortable.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-query-watches.html>`_
 
@@ -646,7 +666,11 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start the watch service. Start the Watcher service if it is not already running.
+        .. raw:: html
+
+          <p>Start the watch service.
+          Start the Watcher service if it is not already running.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-start.html>`_
         """
@@ -703,8 +727,12 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get Watcher statistics. This API always returns basic metrics. You retrieve more
-        metrics by using the metric parameter.
+        .. raw:: html
+
+          <p>Get Watcher statistics.
+          This API always returns basic metrics.
+          You retrieve more metrics by using the metric parameter.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stats.html>`_
 
@@ -751,7 +779,11 @@ class WatcherClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stop the watch service. Stop the Watcher service if it is running.
+        .. raw:: html
+
+          <p>Stop the watch service.
+          Stop the Watcher service if it is running.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stop.html>`_
 
@@ -803,9 +835,13 @@ class WatcherClient(NamespacedClient):
         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`.
+        .. raw:: html
+
+          <p>Update Watcher index settings.
+          Update settings for the Watcher internal index (<code>.watches</code>).
+          Only a subset of settings can be modified.
+          This includes <code>index.auto_expand_replicas</code> and <code>index.number_of_replicas</code>.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-update-settings.html>`_
 

elasticsearch/_sync/client/xpack.py

@@ -43,10 +43,16 @@ class XPackClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.
+        .. raw:: html
+
+          <p>Get information.
+          The information provided by the API includes:</p>
+          <ul>
+          <li>Build information including the build number and timestamp.</li>
+          <li>License information about the currently installed license.</li>
+          <li>Feature information for the features that are currently enabled and available under the current license.</li>
+          </ul>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/info-api.html>`_
 
@@ -90,9 +96,12 @@ class XPackClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.
+        .. raw:: html
+
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/usage-api.html>`_
 

elasticsearch/_version.py

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

elasticsearch/client.py

@@ -73,6 +73,8 @@ from ._sync.client.xpack import XPackClient as XPackClient  # noqa: F401
 from ._utils import fixup_module_metadata
 
 # This file exists for backwards compatibility.
+# We can't remove it as we use it for the Sphinx docs which show the full page, and we'd
+# rather show `elasticsearch.client.FooClient` than `elasticsearch._sync.client.FooClient`.
 warnings.warn(
     "Importing from the 'elasticsearch.client' module is deprecated. "
     "Instead use 'elasticsearch' module for importing the client.",

elasticsearch/helpers/actions.py

@@ -593,7 +593,7 @@ def parallel_bulk(
 
     class BlockingPool(ThreadPool):
         def _setup_queues(self) -> None:
-            super()._setup_queues()  # type: ignore
+            super()._setup_queues()  # type: ignore[misc]
             # The queue must be at least the size of the number of threads to
             # prevent hanging when inserting sentinel values during teardown.
             self._inqueue: Queue[

elasticsearch/helpers/vectorstore/_sync/vectorstore.py

@@ -22,7 +22,10 @@ from typing import Any, Callable, Dict, List, Optional
 from elasticsearch import Elasticsearch
 from elasticsearch._version import __versionstr__ as lib_version
 from elasticsearch.helpers import BulkIndexError, bulk
-from elasticsearch.helpers.vectorstore import EmbeddingService, RetrievalStrategy
+from elasticsearch.helpers.vectorstore import (
+    EmbeddingService,
+    RetrievalStrategy,
+)
 from elasticsearch.helpers.vectorstore._utils import maximal_marginal_relevance
 
 logger = logging.getLogger(__name__)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elasticsearch
-Version: 8.17.1
+Version: 8.17.2
 Summary: Python client for Elasticsearch
 Project-URL: Documentation, https://elasticsearch-py.readthedocs.io/
 Project-URL: Homepage, https://github.com/elastic/elasticsearch-py