Skip to content

Commit 8cd8125

Browse files
committed
Update APIs to 8.8-SNAPSHOT
1 parent 47d1f25 commit 8cd8125

Some content is hidden

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

68 files changed

+2084
-808
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 45 additions & 43 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.8/async-search.html>`_
4444
4545
:param id: The async search ID
4646
"""
@@ -82,7 +82,7 @@ async def get(
8282
Retrieves the results of a previously submitted async search request given its
8383
ID.
8484
85-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
85+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/async-search.html>`_
8686
8787
:param id: The async search ID
8888
:param keep_alive: Specify the time interval in which the results (partial or
@@ -131,7 +131,7 @@ async def status(
131131
Retrieves the status of a previously submitted async search request given its
132132
ID.
133133
134-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
134+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/async-search.html>`_
135135
136136
:param id: The async search ID
137137
"""
@@ -302,7 +302,7 @@ async def submit(
302302
"""
303303
Executes a search request asynchronously.
304304
305-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
305+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/async-search.html>`_
306306
307307
:param index: A comma-separated list of index names to search; use `_all` or
308308
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.8/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.8/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.8/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.8/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: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ async def aliases(
6767
Shows information about currently configured aliases to indices including filter
6868
and routing infos.
6969
70-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
70+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-alias.html>`_
7171
7272
:param name: A comma-separated list of alias names to return
7373
:param expand_wildcards: Whether to expand wildcard expression to concrete indices
@@ -151,7 +151,7 @@ async def allocation(
151151
Provides a snapshot of how many shards are allocated to each data node and how
152152
much disk space they are using.
153153
154-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
154+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-allocation.html>`_
155155
156156
:param node_id: A comma-separated list of node IDs or names to limit the returned
157157
information
@@ -229,7 +229,7 @@ async def component_templates(
229229
"""
230230
Returns information about existing component_templates templates.
231231
232-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
232+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-component-templates.html>`_
233233
234234
:param name: A pattern that returned component template names must match
235235
:param format: Specifies the format to return the columnar data in, can be set
@@ -304,7 +304,7 @@ async def count(
304304
Provides quick access to the document count of the entire cluster, or individual
305305
indices.
306306
307-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
307+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-count.html>`_
308308
309309
:param index: A comma-separated list of index names to limit the returned information
310310
:param format: Specifies the format to return the columnar data in, can be set
@@ -384,7 +384,7 @@ async def fielddata(
384384
Shows how much heap memory is currently being used by fielddata on every data
385385
node in the cluster.
386386
387-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
387+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-fielddata.html>`_
388388
389389
:param fields: A comma-separated list of fields to return the fielddata size
390390
:param bytes: The unit in which to display byte values
@@ -461,7 +461,7 @@ async def health(
461461
"""
462462
Returns a concise representation of the cluster health.
463463
464-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
464+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-health.html>`_
465465
466466
:param format: Specifies the format to return the columnar data in, can be set
467467
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -533,7 +533,7 @@ async def help(
533533
"""
534534
Returns help for the Cat APIs.
535535
536-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
536+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat.html>`_
537537
538538
:param format: Specifies the format to return the columnar data in, can be set
539539
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -631,7 +631,7 @@ async def indices(
631631
Returns information about indices: number of primaries and replicas, document
632632
counts, disk size, ...
633633
634-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
634+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-indices.html>`_
635635
636636
:param index: A comma-separated list of index names to limit the returned information
637637
:param bytes: The unit in which to display byte values
@@ -725,7 +725,7 @@ async def master(
725725
"""
726726
Returns information about the master node.
727727
728-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
728+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-master.html>`_
729729
730730
:param format: Specifies the format to return the columnar data in, can be set
731731
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -844,7 +844,7 @@ async def ml_data_frame_analytics(
844844
"""
845845
Gets configuration and usage information about data frame analytics jobs.
846846
847-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
847+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-dfanalytics.html>`_
848848
849849
:param id: The ID of the data frame analytics to fetch
850850
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -975,7 +975,7 @@ async def ml_datafeeds(
975975
"""
976976
Gets configuration and usage information about datafeeds.
977977
978-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
978+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-datafeeds.html>`_
979979
980980
:param datafeed_id: A numerical character string that uniquely identifies the
981981
datafeed.
@@ -1112,7 +1112,7 @@ async def ml_jobs(
11121112
"""
11131113
Gets configuration and usage information about anomaly detection jobs.
11141114
1115-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1115+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-anomaly-detectors.html>`_
11161116
11171117
:param job_id: Identifier for the anomaly detection job.
11181118
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1252,7 +1252,7 @@ async def ml_trained_models(
12521252
"""
12531253
Gets configuration and usage information about inference trained models.
12541254
1255-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1255+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-trained-model.html>`_
12561256
12571257
:param model_id: The ID of the trained models stats to fetch
12581258
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1337,7 +1337,7 @@ async def nodeattrs(
13371337
"""
13381338
Returns information about custom node attributes.
13391339
1340-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1340+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-nodeattrs.html>`_
13411341
13421342
:param format: Specifies the format to return the columnar data in, can be set
13431343
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1410,7 +1410,7 @@ async def nodes(
14101410
"""
14111411
Returns basic statistics about performance of cluster nodes.
14121412
1413-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1413+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-nodes.html>`_
14141414
14151415
:param bytes: The unit in which to display byte values
14161416
:param format: Specifies the format to return the columnar data in, can be set
@@ -1486,7 +1486,7 @@ async def pending_tasks(
14861486
"""
14871487
Returns a concise representation of the cluster pending tasks.
14881488
1489-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1489+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-pending-tasks.html>`_
14901490
14911491
:param format: Specifies the format to return the columnar data in, can be set
14921492
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1555,7 +1555,7 @@ async def plugins(
15551555
"""
15561556
Returns information about installed plugins across nodes node.
15571557
1558-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1558+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-plugins.html>`_
15591559
15601560
:param format: Specifies the format to return the columnar data in, can be set
15611561
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1630,7 +1630,7 @@ async def recovery(
16301630
"""
16311631
Returns information about index shard recoveries, both on-going completed.
16321632
1633-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1633+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-recovery.html>`_
16341634
16351635
:param index: Comma-separated list or wildcard expression of index names to limit
16361636
the returned information
@@ -1714,7 +1714,7 @@ async def repositories(
17141714
"""
17151715
Returns information about snapshot repositories registered in the cluster.
17161716
1717-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1717+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-repositories.html>`_
17181718
17191719
:param format: Specifies the format to return the columnar data in, can be set
17201720
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1787,7 +1787,7 @@ async def segments(
17871787
"""
17881788
Provides low-level information about the segments in the shards of an index.
17891789
1790-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1790+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-segments.html>`_
17911791
17921792
:param index: A comma-separated list of index names to limit the returned information
17931793
:param bytes: The unit in which to display byte values
@@ -1867,7 +1867,7 @@ async def shards(
18671867
"""
18681868
Provides a detailed view of shard allocation on nodes.
18691869
1870-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1870+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-shards.html>`_
18711871
18721872
:param index: A comma-separated list of index names to limit the returned information
18731873
:param bytes: The unit in which to display byte values
@@ -1947,7 +1947,7 @@ async def snapshots(
19471947
"""
19481948
Returns all snapshots in a specific repository.
19491949
1950-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1950+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-snapshots.html>`_
19511951
19521952
:param repository: Name of repository from which to fetch the snapshot information
19531953
:param format: Specifies the format to return the columnar data in, can be set
@@ -2028,7 +2028,7 @@ async def tasks(
20282028
Returns information about the tasks currently executing on one or more nodes
20292029
in the cluster.
20302030
2031-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
2031+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/tasks.html>`_
20322032
20332033
:param actions: A comma-separated list of actions that should be returned. Leave
20342034
empty to return all.
@@ -2111,7 +2111,7 @@ async def templates(
21112111
"""
21122112
Returns information about existing templates.
21132113
2114-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2114+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-templates.html>`_
21152115
21162116
:param name: A pattern that returned template names must match
21172117
:param format: Specifies the format to return the columnar data in, can be set
@@ -2191,7 +2191,7 @@ async def thread_pool(
21912191
Returns cluster-wide thread pool statistics per node. By default the active,
21922192
queue and rejected statistics are returned for all thread pools.
21932193
2194-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2194+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-thread-pool.html>`_
21952195
21962196
:param thread_pool_patterns: List of thread pool names used to limit the request.
21972197
Accepts wildcard expressions.
@@ -2321,7 +2321,7 @@ async def transforms(
23212321
"""
23222322
Gets configuration and usage information about transforms.
23232323
2324-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2324+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.8/cat-transforms.html>`_
23252325
23262326
:param transform_id: The id of the transform for which to get stats. '_all' or
23272327
'*' implies all transforms

0 commit comments

Comments
 (0)