Skip to content

Commit 9ecf733

Browse files
Generate API code for 8.6
1 parent 0a638c5 commit 9ecf733

Some content is hidden

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

66 files changed

+814
-802
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 42 additions & 42 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.6/async-search.html>`_
4444
4545
:param id: The async search ID
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.6/async-search.html>`_
8686
8787
:param id: The async search ID
8888
:param keep_alive: Specify the time interval in which the results (partial or
@@ -131,7 +131,7 @@ async def status(
131131
Retrieves the status of a previously submitted async search request given its
132132
ID.
133133
134-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
134+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/async-search.html>`_
135135
136136
:param id: The async search ID
137137
"""
@@ -295,7 +295,7 @@ async def submit(
295295
"""
296296
Executes a search request asynchronously.
297297
298-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
298+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/async-search.html>`_
299299
300300
:param index: A comma-separated list of index names to search; use `_all` or
301301
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.6/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.6/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.6/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.6/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: 32 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.6/cat-alias.html>`_
7171
7272
:param name: A comma-separated list of alias names to return
7373
:param expand_wildcards: Whether to expand wildcard expression to concrete indices
@@ -151,7 +151,7 @@ async def allocation(
151151
Provides a snapshot of how many shards are allocated to each data node and how
152152
much disk space they are using.
153153
154-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
154+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-allocation.html>`_
155155
156156
:param node_id: A comma-separated list of node IDs or names to limit the returned
157157
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-compoentn-templates.html>`_
232+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-compoentn-templates.html>`_
233233
234234
:param name: A pattern that returned component template names must match
235235
:param format: Specifies the format to return the columnar data in, can be set
@@ -304,7 +304,7 @@ async def count(
304304
Provides quick access to the document count of the entire cluster, or individual
305305
indices.
306306
307-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
307+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-count.html>`_
308308
309309
:param index: A comma-separated list of index names to limit the returned information
310310
:param format: Specifies the format to return the columnar data in, can be set
@@ -384,7 +384,7 @@ async def fielddata(
384384
Shows how much heap memory is currently being used by fielddata on every data
385385
node in the cluster.
386386
387-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
387+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-fielddata.html>`_
388388
389389
:param fields: A comma-separated list of fields to return the fielddata size
390390
:param bytes: The unit in which to display byte values
@@ -461,7 +461,7 @@ async def health(
461461
"""
462462
Returns a concise representation of the cluster health.
463463
464-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
464+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-health.html>`_
465465
466466
:param format: Specifies the format to return the columnar data in, can be set
467467
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -533,7 +533,7 @@ async def help(
533533
"""
534534
Returns help for the Cat APIs.
535535
536-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
536+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat.html>`_
537537
538538
:param format: Specifies the format to return the columnar data in, can be set
539539
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -622,13 +622,16 @@ async def indices(
622622
pretty: t.Optional[bool] = None,
623623
pri: t.Optional[bool] = None,
624624
s: t.Optional[t.Union[str, t.Union[t.List[str], t.Tuple[str, ...]]]] = None,
625+
time: t.Optional[
626+
t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
627+
] = None,
625628
v: t.Optional[bool] = None,
626629
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
627630
"""
628631
Returns information about indices: number of primaries and replicas, document
629632
counts, disk size, ...
630633
631-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
634+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-indices.html>`_
632635
633636
:param index: A comma-separated list of index names to limit the returned information
634637
:param bytes: The unit in which to display byte values
@@ -652,6 +655,7 @@ async def indices(
652655
:param s: List of columns that determine how the table should be sorted. Sorting
653656
defaults to ascending and can be changed by setting `:asc` or `:desc` as
654657
a suffix to the column name.
658+
:param time: The unit in which to display time values
655659
:param v: When set to `true` will enable verbose output.
656660
"""
657661
if index not in SKIP_IN_PATH:
@@ -689,6 +693,8 @@ async def indices(
689693
__query["pri"] = pri
690694
if s is not None:
691695
__query["s"] = s
696+
if time is not None:
697+
__query["time"] = time
692698
if v is not None:
693699
__query["v"] = v
694700
__headers = {"accept": "text/plain,application/json"}
@@ -719,7 +725,7 @@ async def master(
719725
"""
720726
Returns information about the master node.
721727
722-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
728+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-master.html>`_
723729
724730
:param format: Specifies the format to return the columnar data in, can be set
725731
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -838,7 +844,7 @@ async def ml_data_frame_analytics(
838844
"""
839845
Gets configuration and usage information about data frame analytics jobs.
840846
841-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
847+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-dfanalytics.html>`_
842848
843849
:param id: The ID of the data frame analytics to fetch
844850
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -969,7 +975,7 @@ async def ml_datafeeds(
969975
"""
970976
Gets configuration and usage information about datafeeds.
971977
972-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
978+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-datafeeds.html>`_
973979
974980
:param datafeed_id: A numerical character string that uniquely identifies the
975981
datafeed.
@@ -1106,7 +1112,7 @@ async def ml_jobs(
11061112
"""
11071113
Gets configuration and usage information about anomaly detection jobs.
11081114
1109-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
1115+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-anomaly-detectors.html>`_
11101116
11111117
:param job_id: Identifier for the anomaly detection job.
11121118
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1246,7 +1252,7 @@ async def ml_trained_models(
12461252
"""
12471253
Gets configuration and usage information about inference trained models.
12481254
1249-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1255+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-trained-model.html>`_
12501256
12511257
:param model_id: The ID of the trained models stats to fetch
12521258
:param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1331,7 +1337,7 @@ async def nodeattrs(
13311337
"""
13321338
Returns information about custom node attributes.
13331339
1334-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
1340+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-nodeattrs.html>`_
13351341
13361342
:param format: Specifies the format to return the columnar data in, can be set
13371343
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1404,7 +1410,7 @@ async def nodes(
14041410
"""
14051411
Returns basic statistics about performance of cluster nodes.
14061412
1407-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
1413+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-nodes.html>`_
14081414
14091415
:param bytes: The unit in which to display byte values
14101416
:param format: Specifies the format to return the columnar data in, can be set
@@ -1480,7 +1486,7 @@ async def pending_tasks(
14801486
"""
14811487
Returns a concise representation of the cluster pending tasks.
14821488
1483-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
1489+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-pending-tasks.html>`_
14841490
14851491
:param format: Specifies the format to return the columnar data in, can be set
14861492
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1549,7 +1555,7 @@ async def plugins(
15491555
"""
15501556
Returns information about installed plugins across nodes node.
15511557
1552-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
1558+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-plugins.html>`_
15531559
15541560
:param format: Specifies the format to return the columnar data in, can be set
15551561
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1624,7 +1630,7 @@ async def recovery(
16241630
"""
16251631
Returns information about index shard recoveries, both on-going completed.
16261632
1627-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
1633+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-recovery.html>`_
16281634
16291635
:param index: Comma-separated list or wildcard expression of index names to limit
16301636
the returned information
@@ -1708,7 +1714,7 @@ async def repositories(
17081714
"""
17091715
Returns information about snapshot repositories registered in the cluster.
17101716
1711-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
1717+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-repositories.html>`_
17121718
17131719
:param format: Specifies the format to return the columnar data in, can be set
17141720
to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1781,7 +1787,7 @@ async def segments(
17811787
"""
17821788
Provides low-level information about the segments in the shards of an index.
17831789
1784-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1790+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-segments.html>`_
17851791
17861792
:param index: A comma-separated list of index names to limit the returned information
17871793
:param bytes: The unit in which to display byte values
@@ -1861,7 +1867,7 @@ async def shards(
18611867
"""
18621868
Provides a detailed view of shard allocation on nodes.
18631869
1864-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1870+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-shards.html>`_
18651871
18661872
:param index: A comma-separated list of index names to limit the returned information
18671873
:param bytes: The unit in which to display byte values
@@ -1941,7 +1947,7 @@ async def snapshots(
19411947
"""
19421948
Returns all snapshots in a specific repository.
19431949
1944-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1950+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-snapshots.html>`_
19451951
19461952
:param repository: Name of repository from which to fetch the snapshot information
19471953
:param format: Specifies the format to return the columnar data in, can be set
@@ -2022,7 +2028,7 @@ async def tasks(
20222028
Returns information about the tasks currently executing on one or more nodes
20232029
in the cluster.
20242030
2025-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
2031+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/tasks.html>`_
20262032
20272033
:param actions: A comma-separated list of actions that should be returned. Leave
20282034
empty to return all.
@@ -2105,7 +2111,7 @@ async def templates(
21052111
"""
21062112
Returns information about existing templates.
21072113
2108-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2114+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-templates.html>`_
21092115
21102116
:param name: A pattern that returned template names must match
21112117
:param format: Specifies the format to return the columnar data in, can be set
@@ -2185,7 +2191,7 @@ async def thread_pool(
21852191
Returns cluster-wide thread pool statistics per node. By default the active,
21862192
queue and rejected statistics are returned for all thread pools.
21872193
2188-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2194+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-thread-pool.html>`_
21892195
21902196
:param thread_pool_patterns: List of thread pool names used to limit the request.
21912197
Accepts wildcard expressions.
@@ -2315,7 +2321,7 @@ async def transforms(
23152321
"""
23162322
Gets configuration and usage information about transforms.
23172323
2318-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2324+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-transforms.html>`_
23192325
23202326
:param transform_id: The id of the transform for which to get stats. '_all' or
23212327
'*' implies all transforms

0 commit comments

Comments
 (0)