Skip to content

Commit 878f2ab

Browse files
committed
Update APIs to 8.1-SNAPSHOT
1 parent a52999c commit 878f2ab

Some content is hidden

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

66 files changed

+840
-834
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 69 additions & 66 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
@@ -40,7 +40,7 @@ async def delete(
4040
Deletes an async search by ID. If the search is still running, the search request
4141
will be cancelled. Otherwise, the saved search results are deleted.
4242
43-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
43+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/async-search.html>`_
4444
4545
:param id: The async search ID
4646
"""
@@ -80,7 +80,7 @@ async def get(
8080
Retrieves the results of a previously submitted async search request given its
8181
ID.
8282
83-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
83+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/async-search.html>`_
8484
8585
:param id: The async search ID
8686
:param keep_alive: Specify the time interval in which the results (partial or
@@ -129,7 +129,7 @@ async def status(
129129
Retrieves the status of a previously submitted async search request given its
130130
ID.
131131
132-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
132+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/async-search.html>`_
133133
134134
:param id: The async search ID
135135
"""
@@ -300,7 +300,7 @@ async def submit(
300300
"""
301301
Executes a search request asynchronously.
302302
303-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
303+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/async-search.html>`_
304304
305305
:param index: A comma-separated list of index names to search; use `_all` or
306306
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
@@ -40,7 +40,7 @@ async def delete_autoscaling_policy(
4040
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
4141
Direct use is not supported.
4242
43-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
43+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/autoscaling-delete-autoscaling-policy.html>`_
4444
4545
:param name: the name of the autoscaling policy
4646
"""
@@ -76,7 +76,7 @@ async def get_autoscaling_capacity(
7676
Gets the current autoscaling capacity based on the configured autoscaling policy.
7777
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
7878
79-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
79+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/autoscaling-get-autoscaling-capacity.html>`_
8080
"""
8181
__path = "/_autoscaling/capacity"
8282
__query: t.Dict[str, t.Any] = {}
@@ -109,7 +109,7 @@ async def get_autoscaling_policy(
109109
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
110110
Direct use is not supported.
111111
112-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
112+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/autoscaling-get-autoscaling-capacity.html>`_
113113
114114
:param name: the name of the autoscaling policy
115115
"""
@@ -149,7 +149,7 @@ async def put_autoscaling_policy(
149149
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
150150
Direct use is not supported.
151151
152-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
152+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/autoscaling-put-autoscaling-policy.html>`_
153153
154154
:param name: the name of the autoscaling policy
155155
:param policy:

elasticsearch/_async/client/cat.py

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ async def aliases(
6565
Shows information about currently configured aliases to indices including filter
6666
and routing infos.
6767
68-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
68+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-alias.html>`_
6969
7070
:param name: A comma-separated list of alias names to return
7171
:param expand_wildcards: Whether to expand wildcard expression to concrete indices
@@ -147,7 +147,7 @@ async def allocation(
147147
Provides a snapshot of how many shards are allocated to each data node and how
148148
much disk space they are using.
149149
150-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
150+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-allocation.html>`_
151151
152152
:param node_id: A comma-separated list of node IDs or names to limit the returned
153153
information
@@ -224,7 +224,7 @@ async def count(
224224
Provides quick access to the document count of the entire cluster, or individual
225225
indices.
226226
227-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
227+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-count.html>`_
228228
229229
:param index: A comma-separated list of index names to limit the returned information
230230
:param format: Specifies the format to return the columnar data in, can be set
@@ -302,7 +302,7 @@ async def fielddata(
302302
Shows how much heap memory is currently being used by fielddata on every data
303303
node in the cluster.
304304
305-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
305+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-fielddata.html>`_
306306
307307
:param fields: A comma-separated list of fields to return the fielddata size
308308
:param bytes: The unit in which to display byte values
@@ -377,7 +377,7 @@ async def health(
377377
"""
378378
Returns a concise representation of the cluster health.
379379
380-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
380+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-health.html>`_
381381
382382
:param format: Specifies the format to return the columnar data in, can be set
383383
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -447,7 +447,7 @@ async def help(
447447
"""
448448
Returns help for the Cat APIs.
449449
450-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
450+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat.html>`_
451451
452452
:param format: Specifies the format to return the columnar data in, can be set
453453
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -540,7 +540,7 @@ async def indices(
540540
Returns information about indices: number of primaries and replicas, document
541541
counts, disk size, ...
542542
543-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
543+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-indices.html>`_
544544
545545
:param index: A comma-separated list of index names to limit the returned information
546546
:param bytes: The unit in which to display byte values
@@ -629,7 +629,7 @@ async def master(
629629
"""
630630
Returns information about the master node.
631631
632-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
632+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-master.html>`_
633633
634634
:param format: Specifies the format to return the columnar data in, can be set
635635
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -746,7 +746,7 @@ async def ml_data_frame_analytics(
746746
"""
747747
Gets configuration and usage information about data frame analytics jobs.
748748
749-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
749+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-dfanalytics.html>`_
750750
751751
:param id: The ID of the data frame analytics to fetch
752752
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -875,7 +875,7 @@ async def ml_datafeeds(
875875
"""
876876
Gets configuration and usage information about datafeeds.
877877
878-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
878+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-datafeeds.html>`_
879879
880880
:param datafeed_id: A numerical character string that uniquely identifies the
881881
datafeed.
@@ -1010,7 +1010,7 @@ async def ml_jobs(
10101010
"""
10111011
Gets configuration and usage information about anomaly detection jobs.
10121012
1013-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1013+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-anomaly-detectors.html>`_
10141014
10151015
:param job_id: Identifier for the anomaly detection job.
10161016
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1148,7 +1148,7 @@ async def ml_trained_models(
11481148
"""
11491149
Gets configuration and usage information about inference trained models.
11501150
1151-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1151+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-trained-model.html>`_
11521152
11531153
:param model_id: The ID of the trained models stats to fetch
11541154
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1231,7 +1231,7 @@ async def nodeattrs(
12311231
"""
12321232
Returns information about custom node attributes.
12331233
1234-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1234+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-nodeattrs.html>`_
12351235
12361236
:param format: Specifies the format to return the columnar data in, can be set
12371237
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1302,7 +1302,7 @@ async def nodes(
13021302
"""
13031303
Returns basic statistics about performance of cluster nodes.
13041304
1305-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1305+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-nodes.html>`_
13061306
13071307
:param bytes: The unit in which to display byte values
13081308
:param format: Specifies the format to return the columnar data in, can be set
@@ -1376,7 +1376,7 @@ async def pending_tasks(
13761376
"""
13771377
Returns a concise representation of the cluster pending tasks.
13781378
1379-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1379+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-pending-tasks.html>`_
13801380
13811381
:param format: Specifies the format to return the columnar data in, can be set
13821382
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1443,7 +1443,7 @@ async def plugins(
14431443
"""
14441444
Returns information about installed plugins across nodes node.
14451445
1446-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1446+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-plugins.html>`_
14471447
14481448
:param format: Specifies the format to return the columnar data in, can be set
14491449
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1516,7 +1516,7 @@ async def recovery(
15161516
"""
15171517
Returns information about index shard recoveries, both on-going completed.
15181518
1519-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1519+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-recovery.html>`_
15201520
15211521
:param index: Comma-separated list or wildcard expression of index names to limit
15221522
the returned information
@@ -1598,7 +1598,7 @@ async def repositories(
15981598
"""
15991599
Returns information about snapshot repositories registered in the cluster.
16001600
1601-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1601+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-repositories.html>`_
16021602
16031603
:param format: Specifies the format to return the columnar data in, can be set
16041604
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1669,7 +1669,7 @@ async def segments(
16691669
"""
16701670
Provides low-level information about the segments in the shards of an index.
16711671
1672-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1672+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-segments.html>`_
16731673
16741674
:param index: A comma-separated list of index names to limit the returned information
16751675
:param bytes: The unit in which to display byte values
@@ -1747,7 +1747,7 @@ async def shards(
17471747
"""
17481748
Provides a detailed view of shard allocation on nodes.
17491749
1750-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1750+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-shards.html>`_
17511751
17521752
:param index: A comma-separated list of index names to limit the returned information
17531753
:param bytes: The unit in which to display byte values
@@ -1825,7 +1825,7 @@ async def snapshots(
18251825
"""
18261826
Returns all snapshots in a specific repository.
18271827
1828-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1828+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-snapshots.html>`_
18291829
18301830
:param repository: Name of repository from which to fetch the snapshot information
18311831
:param format: Specifies the format to return the columnar data in, can be set
@@ -1904,7 +1904,7 @@ async def tasks(
19041904
Returns information about the tasks currently executing on one or more nodes
19051905
in the cluster.
19061906
1907-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
1907+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/tasks.html>`_
19081908
19091909
:param actions: A comma-separated list of actions that should be returned. Leave
19101910
empty to return all.
@@ -1985,7 +1985,7 @@ async def templates(
19851985
"""
19861986
Returns information about existing templates.
19871987
1988-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
1988+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-templates.html>`_
19891989
19901990
:param name: A pattern that returned template names must match
19911991
:param format: Specifies the format to return the columnar data in, can be set
@@ -2061,7 +2061,7 @@ async def thread_pool(
20612061
Returns cluster-wide thread pool statistics per node. By default the active,
20622062
queue and rejected statistics are returned for all thread pools.
20632063
2064-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2064+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-thread-pool.html>`_
20652065
20662066
:param thread_pool_patterns: List of thread pool names used to limit the request.
20672067
Accepts wildcard expressions.
@@ -2187,7 +2187,7 @@ async def transforms(
21872187
"""
21882188
Gets configuration and usage information about transforms.
21892189
2190-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2190+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.1/cat-transforms.html>`_
21912191
21922192
:param transform_id: The id of the transform for which to get stats. '_all' or
21932193
'*' implies all transforms

0 commit comments

Comments
 (0)