Skip to content

Commit 58b1a1c

Browse files
Auto-generated code for 8.13 (#2446)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
1 parent 0a8f2da commit 58b1a1c

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

+1340
-982
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: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525

2626
class AsyncSearchClient(NamespacedClient):
27+
2728
@_rewrite_parameters()
2829
async def delete(
2930
self,
@@ -38,7 +39,7 @@ async def delete(
3839
Deletes an async search by ID. If the search is still running, the search request
3940
will be cancelled. Otherwise, the saved search results are deleted.
4041
41-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
42+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/async-search.html>`_
4243
4344
:param id: A unique identifier for the async search.
4445
"""
@@ -78,7 +79,7 @@ async def get(
7879
Retrieves the results of a previously submitted async search request given its
7980
ID.
8081
81-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
82+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/async-search.html>`_
8283
8384
:param id: A unique identifier for the async search.
8485
:param keep_alive: Specifies how long the async search should be available in
@@ -133,7 +134,7 @@ async def status(
133134
Retrieves the status of a previously submitted async search request given its
134135
ID.
135136
136-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
137+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/async-search.html>`_
137138
138139
:param id: A unique identifier for the async search.
139140
"""
@@ -299,7 +300,7 @@ async def submit(
299300
"""
300301
Executes a search request asynchronously.
301302
302-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
303+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/async-search.html>`_
303304
304305
:param index: A comma-separated list of index names to search; use `_all` or
305306
empty string to perform the operation on all indices

elasticsearch/_async/client/autoscaling.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525

2626
class AutoscalingClient(NamespacedClient):
27+
2728
@_rewrite_parameters()
2829
async def delete_autoscaling_policy(
2930
self,
@@ -38,7 +39,7 @@ async def delete_autoscaling_policy(
3839
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
3940
Direct use is not supported.
4041
41-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
42+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/autoscaling-delete-autoscaling-policy.html>`_
4243
4344
:param name: the name of the autoscaling policy
4445
"""
@@ -72,7 +73,7 @@ async def get_autoscaling_capacity(
7273
Gets the current autoscaling capacity based on the configured autoscaling policy.
7374
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
7475
75-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
76+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/autoscaling-get-autoscaling-capacity.html>`_
7677
"""
7778
__path = "/_autoscaling/capacity"
7879
__query: t.Dict[str, t.Any] = {}
@@ -103,7 +104,7 @@ async def get_autoscaling_policy(
103104
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
104105
Direct use is not supported.
105106
106-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
107+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/autoscaling-get-autoscaling-capacity.html>`_
107108
108109
:param name: the name of the autoscaling policy
109110
"""
@@ -142,7 +143,7 @@ async def put_autoscaling_policy(
142143
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
143144
Direct use is not supported.
144145
145-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
146+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/autoscaling-put-autoscaling-policy.html>`_
146147
147148
:param name: the name of the autoscaling policy
148149
:param policy:

elasticsearch/_async/client/cat.py

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525

2626
class CatClient(NamespacedClient):
27+
2728
@_rewrite_parameters()
2829
async def aliases(
2930
self,
@@ -55,7 +56,7 @@ async def aliases(
5556
Shows information about currently configured aliases to indices including filter
5657
and routing infos.
5758
58-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
59+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-alias.html>`_
5960
6061
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
6162
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -136,7 +137,7 @@ async def allocation(
136137
Provides a snapshot of how many shards are allocated to each data node and how
137138
much disk space they are using.
138139
139-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
140+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-allocation.html>`_
140141
141142
:param node_id: Comma-separated list of node identifiers or names used to limit
142143
the returned information.
@@ -212,7 +213,7 @@ async def component_templates(
212213
"""
213214
Returns information about existing component_templates templates.
214215
215-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
216+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-component-templates.html>`_
216217
217218
:param name: The name of the component template. Accepts wildcard expressions.
218219
If omitted, all component templates are returned.
@@ -286,7 +287,7 @@ async def count(
286287
Provides quick access to the document count of the entire cluster, or individual
287288
indices.
288289
289-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
290+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-count.html>`_
290291
291292
:param index: Comma-separated list of data streams, indices, and aliases used
292293
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -364,7 +365,7 @@ async def fielddata(
364365
Shows how much heap memory is currently being used by fielddata on every data
365366
node in the cluster.
366367
367-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
368+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-fielddata.html>`_
368369
369370
:param fields: Comma-separated list of fields used to limit returned information.
370371
To retrieve all fields, omit this parameter.
@@ -443,7 +444,7 @@ async def health(
443444
"""
444445
Returns a concise representation of the cluster health.
445446
446-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
447+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-health.html>`_
447448
448449
:param format: Specifies the format to return the columnar data in, can be set
449450
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -516,7 +517,7 @@ async def help(
516517
"""
517518
Returns help for the Cat APIs.
518519
519-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
520+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat.html>`_
520521
521522
:param format: Specifies the format to return the columnar data in, can be set
522523
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -602,7 +603,7 @@ async def indices(
602603
Returns information about indices: number of primaries and replicas, document
603604
counts, disk size, ...
604605
605-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
606+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-indices.html>`_
606607
607608
:param index: Comma-separated list of data streams, indices, and aliases used
608609
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -695,7 +696,7 @@ async def master(
695696
"""
696697
Returns information about the master node.
697698
698-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
699+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-master.html>`_
699700
700701
:param format: Specifies the format to return the columnar data in, can be set
701702
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -794,7 +795,7 @@ async def ml_data_frame_analytics(
794795
"""
795796
Gets configuration and usage information about data frame analytics jobs.
796797
797-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
798+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-dfanalytics.html>`_
798799
799800
:param id: The ID of the data frame analytics to fetch
800801
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -905,7 +906,7 @@ async def ml_datafeeds(
905906
"""
906907
Gets configuration and usage information about datafeeds.
907908
908-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
909+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-datafeeds.html>`_
909910
910911
:param datafeed_id: A numerical character string that uniquely identifies the
911912
datafeed.
@@ -1022,7 +1023,7 @@ async def ml_jobs(
10221023
"""
10231024
Gets configuration and usage information about anomaly detection jobs.
10241025
1025-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1026+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-anomaly-detectors.html>`_
10261027
10271028
:param job_id: Identifier for the anomaly detection job.
10281029
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1142,7 +1143,7 @@ async def ml_trained_models(
11421143
"""
11431144
Gets configuration and usage information about inference trained models.
11441145
1145-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1146+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-trained-model.html>`_
11461147
11471148
:param model_id: A unique identifier for the trained model.
11481149
:param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1230,7 +1231,7 @@ async def nodeattrs(
12301231
"""
12311232
Returns information about custom node attributes.
12321233
1233-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1234+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-nodeattrs.html>`_
12341235
12351236
:param format: Specifies the format to return the columnar data in, can be set
12361237
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1302,7 +1303,7 @@ async def nodes(
13021303
"""
13031304
Returns basic statistics about performance of cluster nodes.
13041305
1305-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1306+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-nodes.html>`_
13061307
13071308
:param bytes: The unit used to display byte values.
13081309
:param format: Specifies the format to return the columnar data in, can be set
@@ -1380,7 +1381,7 @@ async def pending_tasks(
13801381
"""
13811382
Returns a concise representation of the cluster pending tasks.
13821383
1383-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1384+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-pending-tasks.html>`_
13841385
13851386
:param format: Specifies the format to return the columnar data in, can be set
13861387
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1447,7 +1448,7 @@ async def plugins(
14471448
"""
14481449
Returns information about installed plugins across nodes node.
14491450
1450-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1451+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-plugins.html>`_
14511452
14521453
:param format: Specifies the format to return the columnar data in, can be set
14531454
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1520,7 +1521,7 @@ async def recovery(
15201521
"""
15211522
Returns information about index shard recoveries, both on-going completed.
15221523
1523-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1524+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-recovery.html>`_
15241525
15251526
:param index: A comma-separated list of data streams, indices, and aliases used
15261527
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1603,7 +1604,7 @@ async def repositories(
16031604
"""
16041605
Returns information about snapshot repositories registered in the cluster.
16051606
1606-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1607+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-repositories.html>`_
16071608
16081609
:param format: Specifies the format to return the columnar data in, can be set
16091610
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1674,7 +1675,7 @@ async def segments(
16741675
"""
16751676
Provides low-level information about the segments in the shards of an index.
16761677
1677-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1678+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-segments.html>`_
16781679
16791680
:param index: A comma-separated list of data streams, indices, and aliases used
16801681
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1754,7 +1755,7 @@ async def shards(
17541755
"""
17551756
Provides a detailed view of shard allocation on nodes.
17561757
1757-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1758+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-shards.html>`_
17581759
17591760
:param index: A comma-separated list of data streams, indices, and aliases used
17601761
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1832,7 +1833,7 @@ async def snapshots(
18321833
"""
18331834
Returns all snapshots in a specific repository.
18341835
1835-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1836+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-snapshots.html>`_
18361837
18371838
:param repository: A comma-separated list of snapshot repositories used to limit
18381839
the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -1914,7 +1915,7 @@ async def tasks(
19141915
Returns information about the tasks currently executing on one or more nodes
19151916
in the cluster.
19161917
1917-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
1918+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/tasks.html>`_
19181919
19191920
:param actions: The task action names, which are used to limit the response.
19201921
:param detailed: If `true`, the response includes detailed information about
@@ -1996,7 +1997,7 @@ async def templates(
19961997
"""
19971998
Returns information about existing templates.
19981999
1999-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2000+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-templates.html>`_
20002001
20012002
:param name: The name of the template to return. Accepts wildcard expressions.
20022003
If omitted, all templates are returned.
@@ -2073,7 +2074,7 @@ async def thread_pool(
20732074
Returns cluster-wide thread pool statistics per node. By default the active,
20742075
queue and rejected statistics are returned for all thread pools.
20752076
2076-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2077+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-thread-pool.html>`_
20772078
20782079
:param thread_pool_patterns: A comma-separated list of thread pool names used
20792080
to limit the request. Accepts wildcard expressions.
@@ -2183,7 +2184,7 @@ async def transforms(
21832184
"""
21842185
Gets configuration and usage information about transforms.
21852186
2186-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2187+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-transforms.html>`_
21872188
21882189
:param transform_id: A transform identifier or a wildcard expression. If you
21892190
do not specify one of these options, the API returns information for all

0 commit comments

Comments
 (0)