Auto-generated code for 8.x

elasticsearch/_async/client/async_search.py

@@ -42,7 +42,7 @@ async def delete(
         the authenticated user that submitted the original search request; users that
         have the `cancel_task` cluster privilege.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param id: A unique identifier for the async search.
         """
@@ -90,7 +90,7 @@ async def get(
         the results of a specific async search is restricted to the user or API key that
         submitted it.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param id: A unique identifier for the async search.
         :param keep_alive: Specifies how long the async search should be available in
@@ -154,7 +154,7 @@ async def status(
         security features are enabled, use of this API is restricted to the `monitoring_user`
         role.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param id: A unique identifier for the async search.
         :param keep_alive: Specifies how long the async search needs to be available.
@@ -336,7 +336,7 @@ async def submit(
         can be set by changing the `search.max_async_search_response_size` cluster level
         setting.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param index: A comma-separated list of index names to search; use `_all` or
             empty string to perform the operation on all indices

elasticsearch/_async/client/autoscaling.py

@@ -42,7 +42,7 @@ async def delete_autoscaling_policy(
         by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
         Direct use is not supported.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-delete-autoscaling-policy.html>`_
 
         :param name: the name of the autoscaling policy
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -102,7 +102,7 @@ async def get_autoscaling_capacity(
         capacity was required. This information is provided for diagnosis only. Do not
         use this information to make autoscaling decisions.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.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
@@ -147,7 +147,7 @@ async def get_autoscaling_policy(
         Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
         Direct use is not supported.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html>`_
 
         :param name: the name of the autoscaling policy
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -200,7 +200,7 @@ async def put_autoscaling_policy(
         use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on
         Kubernetes. Direct use is not supported.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html>`_
 
         :param name: the name of the autoscaling policy
         :param policy:

elasticsearch/_async/client/ccr.py

@@ -40,7 +40,7 @@ async def delete_auto_follow_pattern(
         Delete auto-follow patterns. Delete a collection of cross-cluster replication
         auto-follow patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-delete-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern.
         :param master_timeout: Period to wait for a connection to the master node.
@@ -122,7 +122,7 @@ async def follow(
         cross-cluster replication starts replicating operations from the leader index
         to the follower index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html>`_
 
         :param index: The name of the follower index.
         :param leader_index: The name of the index in the leader cluster to follow.
@@ -249,7 +249,7 @@ async def follow_info(
         index names, replication options, and whether the follower indices are active
         or paused.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html>`_
 
         :param index: A comma-separated list of index patterns; use `_all` to perform
             the operation on all indices
@@ -296,7 +296,7 @@ async def follow_stats(
         shard-level stats about the "following tasks" associated with each shard for
         the specified indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html>`_
 
         :param index: A comma-separated list of index patterns; use `_all` to perform
             the operation on all indices
@@ -370,7 +370,7 @@ async def forget_follower(
         API is to handle the case of failure to remove the following retention leases
         after the unfollow API is invoked.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-forget-follower.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html>`_
 
         :param index: the name of the leader index for which specified follower retention
             leases should be removed
@@ -431,7 +431,7 @@ async def get_auto_follow_pattern(
         """
         Get auto-follow patterns. Get cross-cluster replication auto-follow patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html>`_
 
         :param name: Specifies the auto-follow pattern collection that you want to retrieve.
             If you do not specify a name, the API returns information for all collections.
@@ -486,7 +486,7 @@ async def pause_auto_follow_pattern(
         patterns. Remote indices that were created while the pattern was paused will
         also be followed, unless they have been deleted or closed in the interim.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-pause-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern that should pause discovering
             new indices to follow.
@@ -534,7 +534,7 @@ async def pause_follow(
         resume following with the resume follower API. You can pause and resume a follower
         index to change the configuration of the following task.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-pause-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html>`_
 
         :param index: The name of the follower index that should pause following its
             leader index.
@@ -620,7 +620,7 @@ async def put_auto_follow_pattern(
         that were configured automatically before updating an auto-follow pattern will
         remain unchanged even if they do not match against the new patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html>`_
 
         :param name: The name of the collection of auto-follow patterns.
         :param remote_cluster: The remote cluster containing the leader indices to match
@@ -752,7 +752,7 @@ async def resume_auto_follow_pattern(
         Remote indices created while the pattern was paused will also be followed unless
         they have been deleted or closed in the interim.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-resume-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-resume-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern to resume discovering new indices
             to follow.
@@ -825,7 +825,7 @@ async def resume_follow(
         to failures during following tasks. When this API returns, the follower index
         will resume fetching operations from the leader index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-resume-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-resume-follow.html>`_
 
         :param index: The name of the follow index to resume following.
         :param master_timeout: Period to wait for a connection to the master node.
@@ -913,7 +913,7 @@ async def stats(
         Get cross-cluster replication stats. This API returns stats about auto-following
         and the same shard-level stats as the get follower stats API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-stats.html>`_
 
         :param master_timeout: Period to wait for a connection to the master node.
         :param timeout: Period to wait for a response. If no response is received before
@@ -964,7 +964,7 @@ async def unfollow(
         regular index to a follower index. Converting a follower index to a regular index
         is an irreversible operation.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-unfollow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-unfollow.html>`_
 
         :param index: The name of the follower index that should be turned into a regular
             index.

elasticsearch/_async/client/cluster.py

@@ -53,7 +53,7 @@ async def allocation_explain(
         or why a shard continues to remain on its current node when you might expect
         otherwise.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html>`_
 
         :param current_node: Specifies the node ID or the name of the node to only explain
             a shard that is currently located on the specified node.
@@ -126,7 +126,7 @@ async def delete_component_template(
         Delete component templates. Component templates are building blocks for constructing
         index templates that specify index mappings, settings, and aliases.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Comma-separated list or wildcard expression of component template
             names used to limit the request.
@@ -178,7 +178,7 @@ async def delete_voting_config_exclusions(
         Clear cluster voting config exclusions. Remove master-eligible nodes from the
         voting configuration exclusion list.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html>`_
 
         :param master_timeout: Period to wait for a connection to the master node.
         :param wait_for_removal: Specifies whether to wait for all excluded nodes to
@@ -229,7 +229,7 @@ async def exists_component_template(
         Check component templates. Returns information about whether a particular component
         template exists.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Comma-separated list of component template names used to limit the
             request. Wildcard (*) expressions are supported.
@@ -284,7 +284,7 @@ async def get_component_template(
         """
         Get component templates. Get information about component templates.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Comma-separated list of component template names used to limit the
             request. Wildcard (`*`) expressions are supported.
@@ -348,7 +348,7 @@ async def get_settings(
         Get cluster-wide settings. By default, it returns only settings that have been
         explicitly defined.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html>`_
 
         :param flat_settings: If `true`, returns settings in flat format.
         :param include_defaults: If `true`, returns default cluster settings from the
@@ -439,7 +439,7 @@ async def health(
         high watermark health level. The cluster status is controlled by the worst index
         status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html>`_
 
         :param index: Comma-separated list of data streams, indices, and index aliases
             used to limit the request. Wildcard expressions (`*`) are supported. To target
@@ -543,7 +543,7 @@ async def info(
         """
         Get cluster info. Returns basic information about the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-info.html>`_
 
         :param target: Limits the information returned to the specific target. Supports
             a comma-separated list, such as http,ingest.
@@ -592,7 +592,7 @@ async def pending_tasks(
         index command causes a cluster state update, the activity of this task might
         be reported by both task api and pending cluster tasks API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html>`_
 
         :param local: If `true`, the request retrieves information from the local node
             only. If `false`, information is retrieved from the master node.
@@ -667,7 +667,7 @@ async def post_voting_config_exclusions(
         master-ineligible nodes or when removing fewer than half of the master-eligible
         nodes.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html>`_
 
         :param master_timeout: Period to wait for a connection to the master node.
         :param node_ids: A comma-separated list of the persistent ids of the nodes to
@@ -746,7 +746,7 @@ async def put_component_template(
         template to a data stream or index. To be applied, a component template must
         be included in an index template's `composed_of` list.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Name of the component template to create. Elasticsearch includes
             the following built-in component templates: `logs-mappings`; `logs-settings`;
@@ -854,7 +854,7 @@ async def put_settings(
         settings can clear unexpectedly, resulting in a potentially undesired cluster
         configuration.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html>`_
 
         :param flat_settings: Return settings in flat format (default: false)
         :param master_timeout: Explicit operation timeout for connection to master node
@@ -910,7 +910,7 @@ async def remote_info(
         This API returns connection and endpoint information keyed by the configured
         remote cluster alias.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-remote-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-remote-info.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_remote/info"
@@ -973,7 +973,7 @@ async def reroute(
         API with the `?retry_failed` URI query parameter, which will attempt a single
         retry round for these shards.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html>`_
 
         :param commands: Defines the commands to perform.
         :param dry_run: If true, then the request simulates the operation. It will calculate
@@ -1081,7 +1081,7 @@ async def state(
         external monitoring tools. Instead, obtain the information you require using
         other more stable cluster APIs.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html>`_
 
         :param metric: Limit the information returned to the specified metrics
         :param index: A comma-separated list of index names; use `_all` or empty string
@@ -1167,7 +1167,7 @@ async def stats(
         usage) and information about the current nodes that form the cluster (number,
         roles, os, jvm versions, memory usage, cpu and installed plugins).
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html>`_
 
         :param node_id: Comma-separated list of node filters used to limit returned information.
             Defaults to all nodes in the cluster.