Skip to content

Commit 784674f

Browse files
Auto-generated API code (#2533)
1 parent 7001721 commit 784674f

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

+1706
-1130
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
@@ -39,7 +39,7 @@ async def delete(
3939
Deletes an async search by ID. If the search is still running, the search request
4040
will be cancelled. Otherwise, the saved search results are deleted.
4141
42-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
42+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
4343
4444
:param id: A unique identifier for the async search.
4545
"""
@@ -85,7 +85,7 @@ async def get(
8585
Retrieves the results of a previously submitted async search request given its
8686
ID.
8787
88-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
88+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
8989
9090
:param id: A unique identifier for the async search.
9191
:param keep_alive: Specifies how long the async search should be available in
@@ -146,7 +146,7 @@ async def status(
146146
Retrieves the status of a previously submitted async search request given its
147147
ID.
148148
149-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
149+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
150150
151151
:param id: A unique identifier for the async search.
152152
"""
@@ -318,7 +318,7 @@ async def submit(
318318
"""
319319
Executes a search request asynchronously.
320320
321-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
321+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
322322
323323
:param index: A comma-separated list of index names to search; use `_all` or
324324
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
@@ -39,7 +39,7 @@ async def delete_autoscaling_policy(
3939
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
4040
Direct use is not supported.
4141
42-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
42+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-delete-autoscaling-policy.html>`_
4343
4444
:param name: the name of the autoscaling policy
4545
"""
@@ -79,7 +79,7 @@ async def get_autoscaling_capacity(
7979
Gets the current autoscaling capacity based on the configured autoscaling policy.
8080
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
8181
82-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
82+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-get-autoscaling-capacity.html>`_
8383
"""
8484
__path_parts: t.Dict[str, str] = {}
8585
__path = "/_autoscaling/capacity"
@@ -116,7 +116,7 @@ async def get_autoscaling_policy(
116116
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
117117
Direct use is not supported.
118118
119-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
119+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-get-autoscaling-capacity.html>`_
120120
121121
:param name: the name of the autoscaling policy
122122
"""
@@ -161,7 +161,7 @@ async def put_autoscaling_policy(
161161
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
162162
Direct use is not supported.
163163
164-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
164+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-put-autoscaling-policy.html>`_
165165
166166
:param name: the name of the autoscaling policy
167167
:param policy:

elasticsearch/_async/client/cat.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ async def aliases(
5656
Shows information about currently configured aliases to indices including filter
5757
and routing infos.
5858
59-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
59+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-alias.html>`_
6060
6161
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
6262
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -145,7 +145,7 @@ async def allocation(
145145
Provides a snapshot of how many shards are allocated to each data node and how
146146
much disk space they are using.
147147
148-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
148+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-allocation.html>`_
149149
150150
:param node_id: Comma-separated list of node identifiers or names used to limit
151151
the returned 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.14/cat-component-templates.html>`_
233233
234234
:param name: The name of the component template. Accepts wildcard expressions.
235235
If omitted, all component templates are returned.
@@ -311,7 +311,7 @@ async def count(
311311
Provides quick access to the document count of the entire cluster, or individual
312312
indices.
313313
314-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
314+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-count.html>`_
315315
316316
:param index: Comma-separated list of data streams, indices, and aliases used
317317
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -397,7 +397,7 @@ async def fielddata(
397397
Shows how much heap memory is currently being used by fielddata on every data
398398
node in the cluster.
399399
400-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
400+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-fielddata.html>`_
401401
402402
:param fields: Comma-separated list of fields used to limit returned information.
403403
To retrieve all fields, omit this parameter.
@@ -484,7 +484,7 @@ async def health(
484484
"""
485485
Returns a concise representation of the cluster health.
486486
487-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
487+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-health.html>`_
488488
489489
:param format: Specifies the format to return the columnar data in, can be set
490490
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -563,7 +563,7 @@ async def help(
563563
"""
564564
Returns help for the Cat APIs.
565565
566-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
566+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat.html>`_
567567
568568
:param format: Specifies the format to return the columnar data in, can be set
569569
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -655,7 +655,7 @@ async def indices(
655655
Returns information about indices: number of primaries and replicas, document
656656
counts, disk size, ...
657657
658-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
658+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-indices.html>`_
659659
660660
:param index: Comma-separated list of data streams, indices, and aliases used
661661
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -756,7 +756,7 @@ async def master(
756756
"""
757757
Returns information about the master node.
758758
759-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
759+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-master.html>`_
760760
761761
:param format: Specifies the format to return the columnar data in, can be set
762762
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -861,7 +861,7 @@ async def ml_data_frame_analytics(
861861
"""
862862
Gets configuration and usage information about data frame analytics jobs.
863863
864-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
864+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-dfanalytics.html>`_
865865
866866
:param id: The ID of the data frame analytics to fetch
867867
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -980,7 +980,7 @@ async def ml_datafeeds(
980980
"""
981981
Gets configuration and usage information about datafeeds.
982982
983-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
983+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-datafeeds.html>`_
984984
985985
:param datafeed_id: A numerical character string that uniquely identifies the
986986
datafeed.
@@ -1105,7 +1105,7 @@ async def ml_jobs(
11051105
"""
11061106
Gets configuration and usage information about anomaly detection jobs.
11071107
1108-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1108+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-anomaly-detectors.html>`_
11091109
11101110
:param job_id: Identifier for the anomaly detection job.
11111111
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1233,7 +1233,7 @@ async def ml_trained_models(
12331233
"""
12341234
Gets configuration and usage information about inference trained models.
12351235
1236-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1236+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-trained-model.html>`_
12371237
12381238
:param model_id: A unique identifier for the trained model.
12391239
:param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1329,7 +1329,7 @@ async def nodeattrs(
13291329
"""
13301330
Returns information about custom node attributes.
13311331
1332-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1332+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodeattrs.html>`_
13331333
13341334
:param format: Specifies the format to return the columnar data in, can be set
13351335
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1407,7 +1407,7 @@ async def nodes(
14071407
"""
14081408
Returns basic statistics about performance of cluster nodes.
14091409
1410-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1410+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodes.html>`_
14111411
14121412
:param bytes: The unit used to display byte values.
14131413
:param format: Specifies the format to return the columnar data in, can be set
@@ -1491,7 +1491,7 @@ async def pending_tasks(
14911491
"""
14921492
Returns a concise representation of the cluster pending tasks.
14931493
1494-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1494+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-pending-tasks.html>`_
14951495
14961496
:param format: Specifies the format to return the columnar data in, can be set
14971497
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1564,7 +1564,7 @@ async def plugins(
15641564
"""
15651565
Returns information about installed plugins across nodes node.
15661566
1567-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1567+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-plugins.html>`_
15681568
15691569
:param format: Specifies the format to return the columnar data in, can be set
15701570
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1643,7 +1643,7 @@ async def recovery(
16431643
"""
16441644
Returns information about index shard recoveries, both on-going completed.
16451645
1646-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1646+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-recovery.html>`_
16471647
16481648
:param index: A comma-separated list of data streams, indices, and aliases used
16491649
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1734,7 +1734,7 @@ async def repositories(
17341734
"""
17351735
Returns information about snapshot repositories registered in the cluster.
17361736
1737-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1737+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-repositories.html>`_
17381738
17391739
:param format: Specifies the format to return the columnar data in, can be set
17401740
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1811,7 +1811,7 @@ async def segments(
18111811
"""
18121812
Provides low-level information about the segments in the shards of an index.
18131813
1814-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1814+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-segments.html>`_
18151815
18161816
:param index: A comma-separated list of data streams, indices, and aliases used
18171817
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1899,7 +1899,7 @@ async def shards(
18991899
"""
19001900
Provides a detailed view of shard allocation on nodes.
19011901
1902-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1902+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-shards.html>`_
19031903
19041904
:param index: A comma-separated list of data streams, indices, and aliases used
19051905
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1985,7 +1985,7 @@ async def snapshots(
19851985
"""
19861986
Returns all snapshots in a specific repository.
19871987
1988-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1988+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-snapshots.html>`_
19891989
19901990
:param repository: A comma-separated list of snapshot repositories used to limit
19911991
the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2075,7 +2075,7 @@ async def tasks(
20752075
Returns information about the tasks currently executing on one or more nodes
20762076
in the cluster.
20772077
2078-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
2078+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/tasks.html>`_
20792079
20802080
:param actions: The task action names, which are used to limit the response.
20812081
:param detailed: If `true`, the response includes detailed information about
@@ -2163,7 +2163,7 @@ async def templates(
21632163
"""
21642164
Returns information about existing templates.
21652165
2166-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2166+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-templates.html>`_
21672167
21682168
:param name: The name of the template to return. Accepts wildcard expressions.
21692169
If omitted, all templates are returned.
@@ -2248,7 +2248,7 @@ async def thread_pool(
22482248
Returns cluster-wide thread pool statistics per node. By default the active,
22492249
queue and rejected statistics are returned for all thread pools.
22502250
2251-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2251+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-thread-pool.html>`_
22522252
22532253
:param thread_pool_patterns: A comma-separated list of thread pool names used
22542254
to limit the request. Accepts wildcard expressions.
@@ -2366,7 +2366,7 @@ async def transforms(
23662366
"""
23672367
Gets configuration and usage information about transforms.
23682368
2369-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2369+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-transforms.html>`_
23702370
23712371
:param transform_id: A transform identifier or a wildcard expression. If you
23722372
do not specify one of these options, the API returns information for all

0 commit comments

Comments
 (0)