Skip to content

Commit 706f38b

Browse files
Auto-generated API code
1 parent 14e6265 commit 706f38b

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

+1162
-960
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
@@ -42,7 +42,7 @@ async def delete(
4242
search is restricted to: the authenticated user that submitted the original search
4343
request; users that have the `cancel_task` cluster privilege.
4444
45-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
45+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/async-search.html>`_
4646
4747
:param id: A unique identifier for the async search.
4848
"""
@@ -90,7 +90,7 @@ async def get(
9090
results of a specific async search is restricted to the user or API key that
9191
submitted it.
9292
93-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
93+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/async-search.html>`_
9494
9595
:param id: A unique identifier for the async search.
9696
:param keep_alive: Specifies how long the async search should be available in
@@ -153,7 +153,7 @@ async def status(
153153
Elasticsearch security features are enabled, use of this API is restricted to
154154
the `monitoring_user` role.
155155
156-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
156+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/async-search.html>`_
157157
158158
:param id: A unique identifier for the async search.
159159
"""
@@ -333,7 +333,7 @@ async def submit(
333333
response can be set by changing the `search.max_async_search_response_size` cluster
334334
level setting.
335335
336-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
336+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/async-search.html>`_
337337
338338
:param index: A comma-separated list of index names to search; use `_all` or
339339
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.x/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.x/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.x/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.x/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
@@ -57,7 +57,7 @@ async def aliases(
5757
not intended for use by applications. For application consumption, use the aliases
5858
API.
5959
60-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
60+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-alias.html>`_
6161
6262
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
6363
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -145,7 +145,7 @@ async def allocation(
145145
disk space. IMPORTANT: cat APIs are only intended for human consumption using
146146
the command line or Kibana console. They are not intended for use by applications.
147147
148-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
148+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-allocation.html>`_
149149
150150
:param node_id: Comma-separated list of node identifiers or names used to limit
151151
the returned information.
@@ -232,7 +232,7 @@ async def component_templates(
232232
for use by applications. For application consumption, use the get component template
233233
API.
234234
235-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
235+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-component-templates.html>`_
236236
237237
:param name: The name of the component template. Accepts wildcard expressions.
238238
If omitted, all component templates are returned.
@@ -316,7 +316,7 @@ async def count(
316316
console. They are not intended for use by applications. For application consumption,
317317
use the count API.
318318
319-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
319+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-count.html>`_
320320
321321
:param index: Comma-separated list of data streams, indices, and aliases used
322322
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -402,7 +402,7 @@ async def fielddata(
402402
using the command line or Kibana console. They are not intended for use by applications.
403403
For application consumption, use the nodes stats API.
404404
405-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
405+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-fielddata.html>`_
406406
407407
:param fields: Comma-separated list of fields used to limit returned information.
408408
To retrieve all fields, omit this parameter.
@@ -497,7 +497,7 @@ async def health(
497497
across multiple nodes. You also can use the API to track the recovery of a large
498498
cluster over a longer period of time.
499499
500-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
500+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-health.html>`_
501501
502502
:param format: Specifies the format to return the columnar data in, can be set
503503
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -574,7 +574,7 @@ async def help(
574574
"""
575575
Get CAT help. Returns help for the CAT APIs.
576576
577-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
577+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat.html>`_
578578
579579
:param format: Specifies the format to return the columnar data in, can be set
580580
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -672,7 +672,7 @@ async def indices(
672672
using the command line or Kibana console. They are not intended for use by applications.
673673
For application consumption, use an index endpoint.
674674
675-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
675+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-indices.html>`_
676676
677677
:param index: Comma-separated list of data streams, indices, and aliases used
678678
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -774,7 +774,7 @@ async def master(
774774
command line or Kibana console. They are not intended for use by applications.
775775
For application consumption, use the nodes info API.
776776
777-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
777+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-master.html>`_
778778
779779
:param format: Specifies the format to return the columnar data in, can be set
780780
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -949,7 +949,7 @@ async def ml_data_frame_analytics(
949949
For application consumption, use the get data frame analytics jobs statistics
950950
API.
951951
952-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
952+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-dfanalytics.html>`_
953953
954954
:param id: The ID of the data frame analytics to fetch
955955
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1123,7 +1123,7 @@ async def ml_datafeeds(
11231123
using the Kibana console or command line. They are not intended for use by applications.
11241124
For application consumption, use the get datafeed statistics API.
11251125
1126-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
1126+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-datafeeds.html>`_
11271127
11281128
:param datafeed_id: A numerical character string that uniquely identifies the
11291129
datafeed.
@@ -1496,7 +1496,7 @@ async def ml_jobs(
14961496
for use by applications. For application consumption, use the get anomaly detection
14971497
job statistics API.
14981498
1499-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1499+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-anomaly-detectors.html>`_
15001500
15011501
:param job_id: Identifier for the anomaly detection job.
15021502
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1685,7 +1685,7 @@ async def ml_trained_models(
16851685
console or command line. They are not intended for use by applications. For application
16861686
consumption, use the get trained models statistics API.
16871687
1688-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1688+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-trained-model.html>`_
16891689
16901690
:param model_id: A unique identifier for the trained model.
16911691
:param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1782,7 +1782,7 @@ async def nodeattrs(
17821782
are not intended for use by applications. For application consumption, use the
17831783
nodes info API.
17841784
1785-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1785+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-nodeattrs.html>`_
17861786
17871787
:param format: Specifies the format to return the columnar data in, can be set
17881788
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1861,7 +1861,7 @@ async def nodes(
18611861
are not intended for use by applications. For application consumption, use the
18621862
nodes info API.
18631863
1864-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1864+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-nodes.html>`_
18651865
18661866
:param bytes: The unit used to display byte values.
18671867
:param format: Specifies the format to return the columnar data in, can be set
@@ -1946,7 +1946,7 @@ async def pending_tasks(
19461946
console. They are not intended for use by applications. For application consumption,
19471947
use the pending cluster tasks API.
19481948
1949-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1949+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-pending-tasks.html>`_
19501950
19511951
:param format: Specifies the format to return the columnar data in, can be set
19521952
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2020,7 +2020,7 @@ async def plugins(
20202020
They are not intended for use by applications. For application consumption, use
20212021
the nodes info API.
20222022
2023-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
2023+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-plugins.html>`_
20242024
20252025
:param format: Specifies the format to return the columnar data in, can be set
20262026
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2104,7 +2104,7 @@ async def recovery(
21042104
line or Kibana console. They are not intended for use by applications. For application
21052105
consumption, use the index recovery API.
21062106
2107-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
2107+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-recovery.html>`_
21082108
21092109
:param index: A comma-separated list of data streams, indices, and aliases used
21102110
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2196,7 +2196,7 @@ async def repositories(
21962196
are not intended for use by applications. For application consumption, use the
21972197
get snapshot repository API.
21982198
2199-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
2199+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-repositories.html>`_
22002200
22012201
:param format: Specifies the format to return the columnar data in, can be set
22022202
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2275,7 +2275,7 @@ async def segments(
22752275
console. They are not intended for use by applications. For application consumption,
22762276
use the index segments API.
22772277
2278-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
2278+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-segments.html>`_
22792279
22802280
:param index: A comma-separated list of data streams, indices, and aliases used
22812281
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2364,7 +2364,7 @@ async def shards(
23642364
for human consumption using the command line or Kibana console. They are not
23652365
intended for use by applications.
23662366
2367-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
2367+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-shards.html>`_
23682368
23692369
:param index: A comma-separated list of data streams, indices, and aliases used
23702370
to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2452,7 +2452,7 @@ async def snapshots(
24522452
console. They are not intended for use by applications. For application consumption,
24532453
use the get snapshot API.
24542454
2455-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
2455+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-snapshots.html>`_
24562456
24572457
:param repository: A comma-separated list of snapshot repositories used to limit
24582458
the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2542,7 +2542,7 @@ async def tasks(
25422542
console. They are not intended for use by applications. For application consumption,
25432543
use the task management API.
25442544
2545-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
2545+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/tasks.html>`_
25462546
25472547
:param actions: The task action names, which are used to limit the response.
25482548
:param detailed: If `true`, the response includes detailed information about
@@ -2632,7 +2632,7 @@ async def templates(
26322632
console. They are not intended for use by applications. For application consumption,
26332633
use the get index template API.
26342634
2635-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2635+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-templates.html>`_
26362636
26372637
:param name: The name of the template to return. Accepts wildcard expressions.
26382638
If omitted, all templates are returned.
@@ -2718,7 +2718,7 @@ async def thread_pool(
27182718
They are not intended for use by applications. For application consumption, use
27192719
the nodes info API.
27202720
2721-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2721+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-thread-pool.html>`_
27222722
27232723
:param thread_pool_patterns: A comma-separated list of thread pool names used
27242724
to limit the request. Accepts wildcard expressions.
@@ -2973,7 +2973,7 @@ async def transforms(
29732973
command line. They are not intended for use by applications. For application
29742974
consumption, use the get transform statistics API.
29752975
2976-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2976+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-transforms.html>`_
29772977
29782978
:param transform_id: A transform identifier or a wildcard expression. If you
29792979
do not specify one of these options, the API returns information for all

0 commit comments

Comments
 (0)