Skip to content

Commit dd942fc

Browse files
Auto-generated API code (#2408)
1 parent e68b3c5 commit dd942fc

Some content is hidden

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

72 files changed

+894
-856
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 43 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
@@ -38,7 +38,7 @@ async def delete(
3838
Deletes an async search by ID. If the search is still running, the search request
3939
will be cancelled. Otherwise, the saved search results are deleted.
4040
41-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
41+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/async-search.html>`_
4242
4343
:param id: A unique identifier for the async search.
4444
"""
@@ -78,7 +78,7 @@ async def get(
7878
Retrieves the results of a previously submitted async search request given its
7979
ID.
8080
81-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
81+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/async-search.html>`_
8282
8383
:param id: A unique identifier for the async search.
8484
:param keep_alive: Specifies how long the async search should be available in
@@ -133,7 +133,7 @@ async def status(
133133
Retrieves the status of a previously submitted async search request given its
134134
ID.
135135
136-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
136+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/async-search.html>`_
137137
138138
:param id: A unique identifier for the async search.
139139
"""
@@ -299,7 +299,7 @@ async def submit(
299299
"""
300300
Executes a search request asynchronously.
301301
302-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
302+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/async-search.html>`_
303303
304304
:param index: A comma-separated list of index names to search; use `_all` or
305305
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
@@ -38,7 +38,7 @@ async def delete_autoscaling_policy(
3838
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
3939
Direct use is not supported.
4040
41-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
41+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/autoscaling-delete-autoscaling-policy.html>`_
4242
4343
:param name: the name of the autoscaling policy
4444
"""
@@ -72,7 +72,7 @@ async def get_autoscaling_capacity(
7272
Gets the current autoscaling capacity based on the configured autoscaling policy.
7373
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
7474
75-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
75+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/autoscaling-get-autoscaling-capacity.html>`_
7676
"""
7777
__path = "/_autoscaling/capacity"
7878
__query: t.Dict[str, t.Any] = {}
@@ -103,7 +103,7 @@ async def get_autoscaling_policy(
103103
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
104104
Direct use is not supported.
105105
106-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
106+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/autoscaling-get-autoscaling-capacity.html>`_
107107
108108
:param name: the name of the autoscaling policy
109109
"""
@@ -142,7 +142,7 @@ async def put_autoscaling_policy(
142142
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
143143
Direct use is not supported.
144144
145-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
145+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/autoscaling-put-autoscaling-policy.html>`_
146146
147147
:param name: the name of the autoscaling policy
148148
:param policy:

elasticsearch/_async/client/cat.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ async def aliases(
5555
Shows information about currently configured aliases to indices including filter
5656
and routing infos.
5757
58-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
58+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-alias.html>`_
5959
6060
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
6161
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -136,7 +136,7 @@ async def allocation(
136136
Provides a snapshot of how many shards are allocated to each data node and how
137137
much disk space they are using.
138138
139-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
139+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-allocation.html>`_
140140
141141
:param node_id: Comma-separated list of node identifiers or names used to limit
142142
the returned information.
@@ -212,7 +212,7 @@ async def component_templates(
212212
"""
213213
Returns information about existing component_templates templates.
214214
215-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
215+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-component-templates.html>`_
216216
217217
:param name: The name of the component template. Accepts wildcard expressions.
218218
If omitted, all component templates are returned.
@@ -286,7 +286,7 @@ async def count(
286286
Provides quick access to the document count of the entire cluster, or individual
287287
indices.
288288
289-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
289+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-count.html>`_
290290
291291
:param index: Comma-separated list of data streams, indices, and aliases used
292292
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -364,7 +364,7 @@ async def fielddata(
364364
Shows how much heap memory is currently being used by fielddata on every data
365365
node in the cluster.
366366
367-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
367+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-fielddata.html>`_
368368
369369
:param fields: Comma-separated list of fields used to limit returned information.
370370
To retrieve all fields, omit this parameter.
@@ -443,7 +443,7 @@ async def health(
443443
"""
444444
Returns a concise representation of the cluster health.
445445
446-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
446+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-health.html>`_
447447
448448
:param format: Specifies the format to return the columnar data in, can be set
449449
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -516,7 +516,7 @@ async def help(
516516
"""
517517
Returns help for the Cat APIs.
518518
519-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
519+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat.html>`_
520520
521521
:param format: Specifies the format to return the columnar data in, can be set
522522
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -602,7 +602,7 @@ async def indices(
602602
Returns information about indices: number of primaries and replicas, document
603603
counts, disk size, ...
604604
605-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
605+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-indices.html>`_
606606
607607
:param index: Comma-separated list of data streams, indices, and aliases used
608608
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -695,7 +695,7 @@ async def master(
695695
"""
696696
Returns information about the master node.
697697
698-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
698+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-master.html>`_
699699
700700
:param format: Specifies the format to return the columnar data in, can be set
701701
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -794,7 +794,7 @@ async def ml_data_frame_analytics(
794794
"""
795795
Gets configuration and usage information about data frame analytics jobs.
796796
797-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
797+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-dfanalytics.html>`_
798798
799799
:param id: The ID of the data frame analytics to fetch
800800
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -905,7 +905,7 @@ async def ml_datafeeds(
905905
"""
906906
Gets configuration and usage information about datafeeds.
907907
908-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
908+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-datafeeds.html>`_
909909
910910
:param datafeed_id: A numerical character string that uniquely identifies the
911911
datafeed.
@@ -1022,7 +1022,7 @@ async def ml_jobs(
10221022
"""
10231023
Gets configuration and usage information about anomaly detection jobs.
10241024
1025-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1025+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-anomaly-detectors.html>`_
10261026
10271027
:param job_id: Identifier for the anomaly detection job.
10281028
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1142,7 +1142,7 @@ async def ml_trained_models(
11421142
"""
11431143
Gets configuration and usage information about inference trained models.
11441144
1145-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1145+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-trained-model.html>`_
11461146
11471147
:param model_id: A unique identifier for the trained model.
11481148
:param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1230,7 +1230,7 @@ async def nodeattrs(
12301230
"""
12311231
Returns information about custom node attributes.
12321232
1233-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1233+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-nodeattrs.html>`_
12341234
12351235
:param format: Specifies the format to return the columnar data in, can be set
12361236
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.12/cat-nodes.html>`_
13061306
13071307
:param bytes: The unit used to display byte values.
13081308
:param format: Specifies the format to return the columnar data in, can be set
@@ -1380,7 +1380,7 @@ async def pending_tasks(
13801380
"""
13811381
Returns a concise representation of the cluster pending tasks.
13821382
1383-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1383+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-pending-tasks.html>`_
13841384
13851385
:param format: Specifies the format to return the columnar data in, can be set
13861386
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1447,7 +1447,7 @@ async def plugins(
14471447
"""
14481448
Returns information about installed plugins across nodes node.
14491449
1450-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1450+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-plugins.html>`_
14511451
14521452
:param format: Specifies the format to return the columnar data in, can be set
14531453
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1520,7 +1520,7 @@ async def recovery(
15201520
"""
15211521
Returns information about index shard recoveries, both on-going completed.
15221522
1523-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1523+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-recovery.html>`_
15241524
15251525
:param index: A comma-separated list of data streams, indices, and aliases used
15261526
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1603,7 +1603,7 @@ async def repositories(
16031603
"""
16041604
Returns information about snapshot repositories registered in the cluster.
16051605
1606-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1606+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-repositories.html>`_
16071607
16081608
:param format: Specifies the format to return the columnar data in, can be set
16091609
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1674,7 +1674,7 @@ async def segments(
16741674
"""
16751675
Provides low-level information about the segments in the shards of an index.
16761676
1677-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1677+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-segments.html>`_
16781678
16791679
:param index: A comma-separated list of data streams, indices, and aliases used
16801680
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1754,7 +1754,7 @@ async def shards(
17541754
"""
17551755
Provides a detailed view of shard allocation on nodes.
17561756
1757-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1757+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-shards.html>`_
17581758
17591759
:param index: A comma-separated list of data streams, indices, and aliases used
17601760
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1832,7 +1832,7 @@ async def snapshots(
18321832
"""
18331833
Returns all snapshots in a specific repository.
18341834
1835-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1835+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-snapshots.html>`_
18361836
18371837
:param repository: A comma-separated list of snapshot repositories used to limit
18381838
the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -1914,7 +1914,7 @@ async def tasks(
19141914
Returns information about the tasks currently executing on one or more nodes
19151915
in the cluster.
19161916
1917-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
1917+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/tasks.html>`_
19181918
19191919
:param actions: The task action names, which are used to limit the response.
19201920
:param detailed: If `true`, the response includes detailed information about
@@ -1996,7 +1996,7 @@ async def templates(
19961996
"""
19971997
Returns information about existing templates.
19981998
1999-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
1999+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-templates.html>`_
20002000
20012001
:param name: The name of the template to return. Accepts wildcard expressions.
20022002
If omitted, all templates are returned.
@@ -2073,7 +2073,7 @@ async def thread_pool(
20732073
Returns cluster-wide thread pool statistics per node. By default the active,
20742074
queue and rejected statistics are returned for all thread pools.
20752075
2076-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2076+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-thread-pool.html>`_
20772077
20782078
:param thread_pool_patterns: A comma-separated list of thread pool names used
20792079
to limit the request. Accepts wildcard expressions.
@@ -2183,7 +2183,7 @@ async def transforms(
21832183
"""
21842184
Gets configuration and usage information about transforms.
21852185
2186-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2186+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cat-transforms.html>`_
21872187
21882188
:param transform_id: A transform identifier or a wildcard expression. If you
21892189
do not specify one of these options, the API returns information for all

0 commit comments

Comments
 (0)