Skip to content

Commit f7c39d1

Browse files
Auto-generated code for main (#2231)
Co-authored-by: Josh Mock <joshua.mock@elastic.co>
1 parent 21a97dc commit f7c39d1

File tree

12 files changed

+842
-446
lines changed

12 files changed

+842
-446
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 146 additions & 89 deletions
Large diffs are not rendered by default.

elasticsearch/_async/client/cat.py

Lines changed: 54 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1266,24 +1266,29 @@ async def ml_trained_models(
12661266
12671267
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
12681268
1269-
:param model_id: The ID of the trained models stats to fetch
1270-
:param allow_no_match: Whether to ignore if a wildcard expression matches no
1271-
trained models. (This includes `_all` string or when no trained models have
1272-
been specified)
1273-
:param bytes: The unit in which to display byte values
1269+
:param model_id: A unique identifier for the trained model.
1270+
:param allow_no_match: Specifies what to do when the request: contains wildcard
1271+
expressions and there are no models that match; contains the `_all` string
1272+
or no identifiers and there are no matches; contains wildcard expressions
1273+
and there are only partial matches. If `true`, the API returns an empty array
1274+
when there are no matches and the subset of results when there are partial
1275+
matches. If `false`, the API returns a 404 status code when there are no
1276+
matches or only partial matches.
1277+
:param bytes: The unit used to display byte values.
12741278
:param format: Specifies the format to return the columnar data in, can be set
12751279
to `text`, `json`, `cbor`, `yaml`, or `smile`.
1276-
:param from_: skips a number of trained models
1277-
:param h: Comma-separated list of column names to display
1280+
:param from_: Skips the specified number of transforms.
1281+
:param h: A comma-separated list of column names to display.
12781282
:param help: When set to `true` will output available columns. This option can't
12791283
be combined with any other query string option.
12801284
:param local: If `true`, the request computes the list of selected nodes from
12811285
the local cluster state. If `false` the list of selected nodes are computed
12821286
from the cluster state of the master node. In both cases the coordinating
12831287
node will send requests for further information to each selected node.
12841288
:param master_timeout: Period to wait for a connection to the master node.
1285-
:param s: Comma-separated list of column names or column aliases to sort by
1286-
:param size: specifies a max number of trained models to get
1289+
:param s: A comma-separated list of column names or aliases used to sort the
1290+
response.
1291+
:param size: The maximum number of transforms to display.
12871292
:param v: When set to `true` will enable verbose output.
12881293
"""
12891294
if model_id not in SKIP_IN_PATH:
@@ -1807,8 +1812,10 @@ async def segments(
18071812
18081813
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
18091814
1810-
:param index: A comma-separated list of index names to limit the returned information
1811-
:param bytes: The unit in which to display byte values
1815+
:param index: A comma-separated list of data streams, indices, and aliases used
1816+
to limit the request. Supports wildcards (`*`). To target all data streams
1817+
and indices, omit this parameter or use `*` or `_all`.
1818+
:param bytes: The unit used to display byte values.
18121819
:param format: Specifies the format to return the columnar data in, can be set
18131820
to `text`, `json`, `cbor`, `yaml`, or `smile`.
18141821
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -1887,8 +1894,10 @@ async def shards(
18871894
18881895
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
18891896
1890-
:param index: A comma-separated list of index names to limit the returned information
1891-
:param bytes: The unit in which to display byte values
1897+
:param index: A comma-separated list of data streams, indices, and aliases used
1898+
to limit the request. Supports wildcards (`*`). To target all data streams
1899+
and indices, omit this parameter or use `*` or `_all`.
1900+
:param bytes: The unit used to display byte values.
18921901
:param format: Specifies the format to return the columnar data in, can be set
18931902
to `text`, `json`, `cbor`, `yaml`, or `smile`.
18941903
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -1967,13 +1976,16 @@ async def snapshots(
19671976
19681977
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
19691978
1970-
:param repository: Name of repository from which to fetch the snapshot information
1979+
:param repository: A comma-separated list of snapshot repositories used to limit
1980+
the request. Accepts wildcard expressions. `_all` returns all repositories.
1981+
If any repository fails during the request, Elasticsearch returns an error.
19711982
:param format: Specifies the format to return the columnar data in, can be set
19721983
to `text`, `json`, `cbor`, `yaml`, or `smile`.
19731984
:param h: List of columns to appear in the response. Supports simple wildcards.
19741985
:param help: When set to `true` will output available columns. This option can't
19751986
be combined with any other query string option.
1976-
:param ignore_unavailable: Set to true to ignore unavailable snapshots
1987+
:param ignore_unavailable: If `true`, the response does not include information
1988+
from unavailable snapshots.
19771989
:param local: If `true`, the request computes the list of selected nodes from
19781990
the local cluster state. If `false` the list of selected nodes are computed
19791991
from the cluster state of the master node. In both cases the coordinating
@@ -2037,7 +2049,7 @@ async def tasks(
20372049
t.Union["t.Literal[-1]", "t.Literal[0]", str]
20382050
] = None,
20392051
node_id: t.Optional[t.Union[t.List[str], t.Tuple[str, ...]]] = None,
2040-
parent_task: t.Optional[int] = None,
2052+
parent_task_id: t.Optional[str] = None,
20412053
pretty: t.Optional[bool] = None,
20422054
s: t.Optional[t.Union[str, t.Union[t.List[str], t.Tuple[str, ...]]]] = None,
20432055
v: t.Optional[bool] = None,
@@ -2048,9 +2060,9 @@ async def tasks(
20482060
20492061
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
20502062
2051-
:param actions: A comma-separated list of actions that should be returned. Leave
2052-
empty to return all.
2053-
:param detailed: Return detailed task information (default: false)
2063+
:param actions: The task action names, which are used to limit the response.
2064+
:param detailed: If `true`, the response includes detailed information about
2065+
shard recoveries.
20542066
:param format: Specifies the format to return the columnar data in, can be set
20552067
to `text`, `json`, `cbor`, `yaml`, or `smile`.
20562068
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -2061,8 +2073,9 @@ async def tasks(
20612073
from the cluster state of the master node. In both cases the coordinating
20622074
node will send requests for further information to each selected node.
20632075
:param master_timeout: Period to wait for a connection to the master node.
2064-
:param node_id:
2065-
:param parent_task:
2076+
:param node_id: Unique node identifiers, which are used to limit the response.
2077+
:param parent_task_id: The parent task identifier, which is used to limit the
2078+
response.
20662079
:param s: List of columns that determine how the table should be sorted. Sorting
20672080
defaults to ascending and can be changed by setting `:asc` or `:desc` as
20682081
a suffix to the column name.
@@ -2092,8 +2105,8 @@ async def tasks(
20922105
__query["master_timeout"] = master_timeout
20932106
if node_id is not None:
20942107
__query["node_id"] = node_id
2095-
if parent_task is not None:
2096-
__query["parent_task"] = parent_task
2108+
if parent_task_id is not None:
2109+
__query["parent_task_id"] = parent_task_id
20972110
if pretty is not None:
20982111
__query["pretty"] = pretty
20992112
if s is not None:
@@ -2131,7 +2144,8 @@ async def templates(
21312144
21322145
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
21332146
2134-
:param name: A pattern that returned template names must match
2147+
:param name: The name of the template to return. Accepts wildcard expressions.
2148+
If omitted, all templates are returned.
21352149
:param format: Specifies the format to return the columnar data in, can be set
21362150
to `text`, `json`, `cbor`, `yaml`, or `smile`.
21372151
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -2211,8 +2225,8 @@ async def thread_pool(
22112225
22122226
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
22132227
2214-
:param thread_pool_patterns: List of thread pool names used to limit the request.
2215-
Accepts wildcard expressions.
2228+
:param thread_pool_patterns: A comma-separated list of thread pool names used
2229+
to limit the request. Accepts wildcard expressions.
22162230
:param format: Specifies the format to return the columnar data in, can be set
22172231
to `text`, `json`, `cbor`, `yaml`, or `smile`.
22182232
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -2226,7 +2240,7 @@ async def thread_pool(
22262240
:param s: List of columns that determine how the table should be sorted. Sorting
22272241
defaults to ascending and can be changed by setting `:asc` or `:desc` as
22282242
a suffix to the column name.
2229-
:param time: Unit used to display time values.
2243+
:param time: The unit used to display time values.
22302244
:param v: When set to `true` will enable verbose output.
22312245
"""
22322246
if thread_pool_patterns not in SKIP_IN_PATH:
@@ -2341,14 +2355,19 @@ async def transforms(
23412355
23422356
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
23432357
2344-
:param transform_id: The id of the transform for which to get stats. '_all' or
2345-
'*' implies all transforms
2346-
:param allow_no_match: Whether to ignore if a wildcard expression matches no
2347-
transforms. (This includes `_all` string or when no transforms have been
2348-
specified)
2358+
:param transform_id: A transform identifier or a wildcard expression. If you
2359+
do not specify one of these options, the API returns information for all
2360+
transforms.
2361+
:param allow_no_match: Specifies what to do when the request: contains wildcard
2362+
expressions and there are no transforms that match; contains the `_all` string
2363+
or no identifiers and there are no matches; contains wildcard expressions
2364+
and there are only partial matches. If `true`, it returns an empty transforms
2365+
array when there are no matches and the subset of results when there are
2366+
partial matches. If `false`, the request returns a 404 status code when there
2367+
are no matches or only partial matches.
23492368
:param format: Specifies the format to return the columnar data in, can be set
23502369
to `text`, `json`, `cbor`, `yaml`, or `smile`.
2351-
:param from_: skips a number of transform configs, defaults to 0
2370+
:param from_: Skips the specified number of transforms.
23522371
:param h: Comma-separated list of column names to display.
23532372
:param help: When set to `true` will output available columns. This option can't
23542373
be combined with any other query string option.
@@ -2359,8 +2378,8 @@ async def transforms(
23592378
:param master_timeout: Period to wait for a connection to the master node.
23602379
:param s: Comma-separated list of column names or column aliases used to sort
23612380
the response.
2362-
:param size: specifies a max number of transforms to get, defaults to 100
2363-
:param time: Unit used to display time values.
2381+
:param size: The maximum number of transforms to obtain.
2382+
:param time: The unit used to display time values.
23642383
:param v: When set to `true` will enable verbose output.
23652384
"""
23662385
if transform_id not in SKIP_IN_PATH:

0 commit comments

Comments
 (0)