Skip to content

Commit c1c8cba

Browse files
Auto-generated API code
1 parent 5d86ccd commit c1c8cba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+2908
-1426
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 52 additions & 55 deletions
Large diffs are not rendered by default.

elasticsearch/_async/client/async_search.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ async def delete(
4444
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <code>cancel_task</code> cluster privilege.</p>
4545
4646
47-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
47+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
4848
4949
:param id: A unique identifier for the async search.
5050
"""
@@ -94,7 +94,7 @@ async def get(
9494
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</p>
9595
9696
97-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
97+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
9898
9999
:param id: A unique identifier for the async search.
100100
:param keep_alive: The length of time that the async search should be available
@@ -164,7 +164,7 @@ async def status(
164164
</ul>
165165
166166
167-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
167+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
168168
169169
:param id: A unique identifier for the async search.
170170
:param keep_alive: The length of time that the async search needs to be available.
@@ -346,7 +346,7 @@ async def submit(
346346
The maximum allowed size for a stored async search response can be set by changing the <code>search.max_async_search_response_size</code> cluster level setting.</p>
347347
348348
349-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
349+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
350350
351351
:param index: A comma-separated list of index names to search; use `_all` or
352352
empty string to perform the operation on all indices

elasticsearch/_async/client/autoscaling.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ async def delete_autoscaling_policy(
4444
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
4545
4646
47-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-delete-autoscaling-policy.html>`_
47+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-delete-autoscaling-policy.html>`_
4848
4949
:param name: the name of the autoscaling policy
5050
:param master_timeout: Period to wait for a connection to the master node. If
@@ -104,7 +104,7 @@ async def get_autoscaling_capacity(
104104
Do not use this information to make autoscaling decisions.</p>
105105
106106
107-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html>`_
107+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html>`_
108108
109109
:param master_timeout: Period to wait for a connection to the master node. If
110110
no response is received before the timeout expires, the request fails and
@@ -151,7 +151,7 @@ async def get_autoscaling_policy(
151151
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
152152
153153
154-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html>`_
154+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html>`_
155155
156156
:param name: the name of the autoscaling policy
157157
:param master_timeout: Period to wait for a connection to the master node. If
@@ -206,7 +206,7 @@ async def put_autoscaling_policy(
206206
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
207207
208208
209-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html>`_
209+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-put-autoscaling-policy.html>`_
210210
211211
:param name: the name of the autoscaling policy
212212
:param policy:

elasticsearch/_async/client/cat.py

Lines changed: 693 additions & 57 deletions
Large diffs are not rendered by default.

elasticsearch/_async/client/ccr.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ async def delete_auto_follow_pattern(
4343
<p>Delete a collection of cross-cluster replication auto-follow patterns.</p>
4444
4545
46-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html>`_
46+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-delete-auto-follow-pattern.html>`_
4747
4848
:param name: The auto-follow pattern collection to delete.
4949
:param master_timeout: The period to wait for a connection to the master node.
@@ -130,7 +130,7 @@ async def follow(
130130
When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.</p>
131131
132132
133-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html>`_
133+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-put-follow.html>`_
134134
135135
:param index: The name of the follower index.
136136
:param leader_index: The name of the index in the leader cluster to follow.
@@ -259,7 +259,7 @@ async def follow_info(
259259
For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.</p>
260260
261261
262-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html>`_
262+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-info.html>`_
263263
264264
:param index: A comma-delimited list of follower index patterns.
265265
:param master_timeout: The period to wait for a connection to the master node.
@@ -311,7 +311,7 @@ async def follow_stats(
311311
The API returns shard-level stats about the &quot;following tasks&quot; associated with each shard for the specified indices.</p>
312312
313313
314-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html>`_
314+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-stats.html>`_
315315
316316
:param index: A comma-delimited list of index patterns.
317317
:param timeout: The period to wait for a response. If no response is received
@@ -380,7 +380,7 @@ async def forget_follower(
380380
The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.</p>
381381
382382
383-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html>`_
383+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-forget-follower.html>`_
384384
385385
:param index: the name of the leader index for which specified follower retention
386386
leases should be removed
@@ -445,7 +445,7 @@ async def get_auto_follow_pattern(
445445
<p>Get cross-cluster replication auto-follow patterns.</p>
446446
447447
448-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html>`_
448+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-auto-follow-pattern.html>`_
449449
450450
:param name: The auto-follow pattern collection that you want to retrieve. If
451451
you do not specify a name, the API returns information for all collections.
@@ -505,7 +505,7 @@ async def pause_auto_follow_pattern(
505505
Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.</p>
506506
507507
508-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html>`_
508+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-pause-auto-follow-pattern.html>`_
509509
510510
:param name: The name of the auto-follow pattern to pause.
511511
:param master_timeout: The period to wait for a connection to the master node.
@@ -559,7 +559,7 @@ async def pause_follow(
559559
You can pause and resume a follower index to change the configuration of the following task.</p>
560560
561561
562-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html>`_
562+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-pause-follow.html>`_
563563
564564
:param index: The name of the follower index.
565565
:param master_timeout: The period to wait for a connection to the master node.
@@ -648,7 +648,7 @@ async def put_auto_follow_pattern(
648648
NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.</p>
649649
650650
651-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html>`_
651+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-put-auto-follow-pattern.html>`_
652652
653653
:param name: The name of the collection of auto-follow patterns.
654654
:param remote_cluster: The remote cluster containing the leader indices to match
@@ -782,7 +782,7 @@ async def resume_auto_follow_pattern(
782782
Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.</p>
783783
784784
785-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-resume-auto-follow-pattern.html>`_
785+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-resume-auto-follow-pattern.html>`_
786786
787787
:param name: The name of the auto-follow pattern to resume.
788788
:param master_timeout: The period to wait for a connection to the master node.
@@ -860,7 +860,7 @@ async def resume_follow(
860860
When this API returns, the follower index will resume fetching operations from the leader index.</p>
861861
862862
863-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-resume-follow.html>`_
863+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-resume-follow.html>`_
864864
865865
:param index: The name of the follow index to resume following.
866866
:param master_timeout: Period to wait for a connection to the master node.
@@ -951,7 +951,7 @@ async def stats(
951951
<p>This API returns stats about auto-following and the same shard-level stats as the get follower stats API.</p>
952952
953953
954-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-stats.html>`_
954+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-stats.html>`_
955955
956956
:param master_timeout: The period to wait for a connection to the master node.
957957
If the master node is not available before the timeout expires, the request
@@ -1009,7 +1009,7 @@ async def unfollow(
10091009
</blockquote>
10101010
10111011
1012-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-unfollow.html>`_
1012+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-unfollow.html>`_
10131013
10141014
:param index: The name of the follower index.
10151015
:param master_timeout: The period to wait for a connection to the master node.

0 commit comments

Comments
 (0)