Skip to content

Commit 56231b6

Browse files
Auto-generated API code (#2323)
1 parent 65e0ea6 commit 56231b6

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

+876
-854
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
@@ -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.11/async-search.html>`_
4444
4545
:param id: A unique identifier for the async search.
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.11/async-search.html>`_
8686
8787
:param id: A unique identifier for the async search.
8888
:param keep_alive: Specifies how long the async search should be available in
@@ -139,7 +139,7 @@ async def status(
139139
Retrieves the status of a previously submitted async search request given its
140140
ID.
141141
142-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
142+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/async-search.html>`_
143143
144144
:param id: A unique identifier for the async search.
145145
"""
@@ -310,7 +310,7 @@ async def submit(
310310
"""
311311
Executes a search request asynchronously.
312312
313-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
313+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/async-search.html>`_
314314
315315
:param index: A comma-separated list of index names to search; use `_all` or
316316
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.11/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.11/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.11/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.11/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.11/cat-alias.html>`_
7171
7272
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
7373
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -152,7 +152,7 @@ async def allocation(
152152
Provides a snapshot of how many shards are allocated to each data node and how
153153
much disk space they are using.
154154
155-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
155+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-allocation.html>`_
156156
157157
:param node_id: Comma-separated list of node identifiers or names used to limit
158158
the returned information.
@@ -230,7 +230,7 @@ async def component_templates(
230230
"""
231231
Returns information about existing component_templates templates.
232232
233-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
233+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-component-templates.html>`_
234234
235235
:param name: The name of the component template. Accepts wildcard expressions.
236236
If omitted, all component templates are returned.
@@ -306,7 +306,7 @@ async def count(
306306
Provides quick access to the document count of the entire cluster, or individual
307307
indices.
308308
309-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
309+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-count.html>`_
310310
311311
:param index: Comma-separated list of data streams, indices, and aliases used
312312
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -388,7 +388,7 @@ async def fielddata(
388388
Shows how much heap memory is currently being used by fielddata on every data
389389
node in the cluster.
390390
391-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
391+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-fielddata.html>`_
392392
393393
:param fields: Comma-separated list of fields used to limit returned information.
394394
To retrieve all fields, omit this parameter.
@@ -469,7 +469,7 @@ async def health(
469469
"""
470470
Returns a concise representation of the cluster health.
471471
472-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
472+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-health.html>`_
473473
474474
:param format: Specifies the format to return the columnar data in, can be set
475475
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -544,7 +544,7 @@ async def help(
544544
"""
545545
Returns help for the Cat APIs.
546546
547-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
547+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat.html>`_
548548
549549
:param format: Specifies the format to return the columnar data in, can be set
550550
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -642,7 +642,7 @@ async def indices(
642642
Returns information about indices: number of primaries and replicas, document
643643
counts, disk size, ...
644644
645-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
645+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-indices.html>`_
646646
647647
:param index: Comma-separated list of data streams, indices, and aliases used
648648
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -737,7 +737,7 @@ async def master(
737737
"""
738738
Returns information about the master node.
739739
740-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
740+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-master.html>`_
741741
742742
:param format: Specifies the format to return the columnar data in, can be set
743743
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -856,7 +856,7 @@ async def ml_data_frame_analytics(
856856
"""
857857
Gets configuration and usage information about data frame analytics jobs.
858858
859-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
859+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-dfanalytics.html>`_
860860
861861
:param id: The ID of the data frame analytics to fetch
862862
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -987,7 +987,7 @@ async def ml_datafeeds(
987987
"""
988988
Gets configuration and usage information about datafeeds.
989989
990-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
990+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-datafeeds.html>`_
991991
992992
:param datafeed_id: A numerical character string that uniquely identifies the
993993
datafeed.
@@ -1124,7 +1124,7 @@ async def ml_jobs(
11241124
"""
11251125
Gets configuration and usage information about anomaly detection jobs.
11261126
1127-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1127+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-anomaly-detectors.html>`_
11281128
11291129
:param job_id: Identifier for the anomaly detection job.
11301130
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1264,7 +1264,7 @@ async def ml_trained_models(
12641264
"""
12651265
Gets configuration and usage information about inference trained models.
12661266
1267-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1267+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-trained-model.html>`_
12681268
12691269
:param model_id: A unique identifier for the trained model.
12701270
:param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1354,7 +1354,7 @@ async def nodeattrs(
13541354
"""
13551355
Returns information about custom node attributes.
13561356
1357-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1357+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-nodeattrs.html>`_
13581358
13591359
:param format: Specifies the format to return the columnar data in, can be set
13601360
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1428,7 +1428,7 @@ async def nodes(
14281428
"""
14291429
Returns basic statistics about performance of cluster nodes.
14301430
1431-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1431+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-nodes.html>`_
14321432
14331433
:param bytes: The unit used to display byte values.
14341434
:param format: Specifies the format to return the columnar data in, can be set
@@ -1508,7 +1508,7 @@ async def pending_tasks(
15081508
"""
15091509
Returns a concise representation of the cluster pending tasks.
15101510
1511-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1511+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-pending-tasks.html>`_
15121512
15131513
:param format: Specifies the format to return the columnar data in, can be set
15141514
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1577,7 +1577,7 @@ async def plugins(
15771577
"""
15781578
Returns information about installed plugins across nodes node.
15791579
1580-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1580+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-plugins.html>`_
15811581
15821582
:param format: Specifies the format to return the columnar data in, can be set
15831583
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1652,7 +1652,7 @@ async def recovery(
16521652
"""
16531653
Returns information about index shard recoveries, both on-going completed.
16541654
1655-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1655+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-recovery.html>`_
16561656
16571657
:param index: A comma-separated list of data streams, indices, and aliases used
16581658
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1737,7 +1737,7 @@ async def repositories(
17371737
"""
17381738
Returns information about snapshot repositories registered in the cluster.
17391739
1740-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1740+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-repositories.html>`_
17411741
17421742
:param format: Specifies the format to return the columnar data in, can be set
17431743
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1810,7 +1810,7 @@ async def segments(
18101810
"""
18111811
Provides low-level information about the segments in the shards of an index.
18121812
1813-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1813+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-segments.html>`_
18141814
18151815
:param index: A comma-separated list of data streams, indices, and aliases used
18161816
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1892,7 +1892,7 @@ async def shards(
18921892
"""
18931893
Provides a detailed view of shard allocation on nodes.
18941894
1895-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1895+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-shards.html>`_
18961896
18971897
:param index: A comma-separated list of data streams, indices, and aliases used
18981898
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1974,7 +1974,7 @@ async def snapshots(
19741974
"""
19751975
Returns all snapshots in a specific repository.
19761976
1977-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1977+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-snapshots.html>`_
19781978
19791979
:param repository: A comma-separated list of snapshot repositories used to limit
19801980
the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2058,7 +2058,7 @@ async def tasks(
20582058
Returns information about the tasks currently executing on one or more nodes
20592059
in the cluster.
20602060
2061-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
2061+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/tasks.html>`_
20622062
20632063
:param actions: The task action names, which are used to limit the response.
20642064
:param detailed: If `true`, the response includes detailed information about
@@ -2142,7 +2142,7 @@ async def templates(
21422142
"""
21432143
Returns information about existing templates.
21442144
2145-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2145+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-templates.html>`_
21462146
21472147
:param name: The name of the template to return. Accepts wildcard expressions.
21482148
If omitted, all templates are returned.
@@ -2223,7 +2223,7 @@ async def thread_pool(
22232223
Returns cluster-wide thread pool statistics per node. By default the active,
22242224
queue and rejected statistics are returned for all thread pools.
22252225
2226-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2226+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-thread-pool.html>`_
22272227
22282228
:param thread_pool_patterns: A comma-separated list of thread pool names used
22292229
to limit the request. Accepts wildcard expressions.
@@ -2353,7 +2353,7 @@ async def transforms(
23532353
"""
23542354
Gets configuration and usage information about transforms.
23552355
2356-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2356+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-transforms.html>`_
23572357
23582358
:param transform_id: A transform identifier or a wildcard expression. If you
23592359
do not specify one of these options, the API returns information for all

0 commit comments

Comments
 (0)