Skip to content

Commit 64dd9a8

Browse files
authored
Update API to 8.3
1 parent 6697c52 commit 64dd9a8

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

+914
-800
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 50 additions & 45 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.3/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.3/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.3/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.3/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.3/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.3/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.3/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.3/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
@@ -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.3/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.3/cat-allocation.html>`_
151151
152152
:param node_id: A comma-separated list of node IDs or names to limit the returned
153153
information
@@ -223,7 +223,7 @@ async def component_templates(
223223
"""
224224
Returns information about existing component_templates templates.
225225
226-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-compoentn-templates.html>`_
226+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-compoentn-templates.html>`_
227227
228228
:param name: A pattern that returned component template names must match
229229
:param format: Specifies the format to return the columnar data in, can be set
@@ -296,7 +296,7 @@ async def count(
296296
Provides quick access to the document count of the entire cluster, or individual
297297
indices.
298298
299-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
299+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-count.html>`_
300300
301301
:param index: A comma-separated list of index names to limit the returned information
302302
:param format: Specifies the format to return the columnar data in, can be set
@@ -374,7 +374,7 @@ async def fielddata(
374374
Shows how much heap memory is currently being used by fielddata on every data
375375
node in the cluster.
376376
377-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
377+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-fielddata.html>`_
378378
379379
:param fields: A comma-separated list of fields to return the fielddata size
380380
:param bytes: The unit in which to display byte values
@@ -449,7 +449,7 @@ async def health(
449449
"""
450450
Returns a concise representation of the cluster health.
451451
452-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
452+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-health.html>`_
453453
454454
:param format: Specifies the format to return the columnar data in, can be set
455455
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -519,7 +519,7 @@ async def help(
519519
"""
520520
Returns help for the Cat APIs.
521521
522-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
522+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat.html>`_
523523
524524
:param format: Specifies the format to return the columnar data in, can be set
525525
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -612,7 +612,7 @@ async def indices(
612612
Returns information about indices: number of primaries and replicas, document
613613
counts, disk size, ...
614614
615-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
615+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-indices.html>`_
616616
617617
:param index: A comma-separated list of index names to limit the returned information
618618
:param bytes: The unit in which to display byte values
@@ -701,7 +701,7 @@ async def master(
701701
"""
702702
Returns information about the master node.
703703
704-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
704+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-master.html>`_
705705
706706
:param format: Specifies the format to return the columnar data in, can be set
707707
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -818,7 +818,7 @@ async def ml_data_frame_analytics(
818818
"""
819819
Gets configuration and usage information about data frame analytics jobs.
820820
821-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
821+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-dfanalytics.html>`_
822822
823823
:param id: The ID of the data frame analytics to fetch
824824
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -947,7 +947,7 @@ async def ml_datafeeds(
947947
"""
948948
Gets configuration and usage information about datafeeds.
949949
950-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
950+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-datafeeds.html>`_
951951
952952
:param datafeed_id: A numerical character string that uniquely identifies the
953953
datafeed.
@@ -1082,7 +1082,7 @@ async def ml_jobs(
10821082
"""
10831083
Gets configuration and usage information about anomaly detection jobs.
10841084
1085-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1085+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-anomaly-detectors.html>`_
10861086
10871087
:param job_id: Identifier for the anomaly detection job.
10881088
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1220,7 +1220,7 @@ async def ml_trained_models(
12201220
"""
12211221
Gets configuration and usage information about inference trained models.
12221222
1223-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1223+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-trained-model.html>`_
12241224
12251225
:param model_id: The ID of the trained models stats to fetch
12261226
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1303,7 +1303,7 @@ async def nodeattrs(
13031303
"""
13041304
Returns information about custom node attributes.
13051305
1306-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1306+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-nodeattrs.html>`_
13071307
13081308
:param format: Specifies the format to return the columnar data in, can be set
13091309
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1374,7 +1374,7 @@ async def nodes(
13741374
"""
13751375
Returns basic statistics about performance of cluster nodes.
13761376
1377-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1377+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-nodes.html>`_
13781378
13791379
:param bytes: The unit in which to display byte values
13801380
:param format: Specifies the format to return the columnar data in, can be set
@@ -1448,7 +1448,7 @@ async def pending_tasks(
14481448
"""
14491449
Returns a concise representation of the cluster pending tasks.
14501450
1451-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1451+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-pending-tasks.html>`_
14521452
14531453
:param format: Specifies the format to return the columnar data in, can be set
14541454
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1515,7 +1515,7 @@ async def plugins(
15151515
"""
15161516
Returns information about installed plugins across nodes node.
15171517
1518-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1518+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-plugins.html>`_
15191519
15201520
:param format: Specifies the format to return the columnar data in, can be set
15211521
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1588,7 +1588,7 @@ async def recovery(
15881588
"""
15891589
Returns information about index shard recoveries, both on-going completed.
15901590
1591-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1591+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-recovery.html>`_
15921592
15931593
:param index: Comma-separated list or wildcard expression of index names to limit
15941594
the returned information
@@ -1670,7 +1670,7 @@ async def repositories(
16701670
"""
16711671
Returns information about snapshot repositories registered in the cluster.
16721672
1673-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1673+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-repositories.html>`_
16741674
16751675
:param format: Specifies the format to return the columnar data in, can be set
16761676
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1741,7 +1741,7 @@ async def segments(
17411741
"""
17421742
Provides low-level information about the segments in the shards of an index.
17431743
1744-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1744+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-segments.html>`_
17451745
17461746
:param index: A comma-separated list of index names to limit the returned information
17471747
:param bytes: The unit in which to display byte values
@@ -1819,7 +1819,7 @@ async def shards(
18191819
"""
18201820
Provides a detailed view of shard allocation on nodes.
18211821
1822-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1822+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-shards.html>`_
18231823
18241824
:param index: A comma-separated list of index names to limit the returned information
18251825
:param bytes: The unit in which to display byte values
@@ -1897,7 +1897,7 @@ async def snapshots(
18971897
"""
18981898
Returns all snapshots in a specific repository.
18991899
1900-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1900+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-snapshots.html>`_
19011901
19021902
:param repository: Name of repository from which to fetch the snapshot information
19031903
:param format: Specifies the format to return the columnar data in, can be set
@@ -1976,7 +1976,7 @@ async def tasks(
19761976
Returns information about the tasks currently executing on one or more nodes
19771977
in the cluster.
19781978
1979-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
1979+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/tasks.html>`_
19801980
19811981
:param actions: A comma-separated list of actions that should be returned. Leave
19821982
empty to return all.
@@ -2057,7 +2057,7 @@ async def templates(
20572057
"""
20582058
Returns information about existing templates.
20592059
2060-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2060+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-templates.html>`_
20612061
20622062
:param name: A pattern that returned template names must match
20632063
:param format: Specifies the format to return the columnar data in, can be set
@@ -2133,7 +2133,7 @@ async def thread_pool(
21332133
Returns cluster-wide thread pool statistics per node. By default the active,
21342134
queue and rejected statistics are returned for all thread pools.
21352135
2136-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2136+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-thread-pool.html>`_
21372137
21382138
:param thread_pool_patterns: List of thread pool names used to limit the request.
21392139
Accepts wildcard expressions.
@@ -2259,7 +2259,7 @@ async def transforms(
22592259
"""
22602260
Gets configuration and usage information about transforms.
22612261
2262-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2262+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.3/cat-transforms.html>`_
22632263
22642264
:param transform_id: The id of the transform for which to get stats. '_all' or
22652265
'*' implies all transforms

0 commit comments

Comments
 (0)