@@ -1266,24 +1266,29 @@ async def ml_trained_models(
1266
1266
1267
1267
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
1268
1268
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.
1274
1278
:param format: Specifies the format to return the columnar data in, can be set
1275
1279
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.
1278
1282
:param help: When set to `true` will output available columns. This option can't
1279
1283
be combined with any other query string option.
1280
1284
:param local: If `true`, the request computes the list of selected nodes from
1281
1285
the local cluster state. If `false` the list of selected nodes are computed
1282
1286
from the cluster state of the master node. In both cases the coordinating
1283
1287
node will send requests for further information to each selected node.
1284
1288
: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.
1287
1292
:param v: When set to `true` will enable verbose output.
1288
1293
"""
1289
1294
if model_id not in SKIP_IN_PATH :
@@ -1807,8 +1812,10 @@ async def segments(
1807
1812
1808
1813
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
1809
1814
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.
1812
1819
:param format: Specifies the format to return the columnar data in, can be set
1813
1820
to `text`, `json`, `cbor`, `yaml`, or `smile`.
1814
1821
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -1887,8 +1894,10 @@ async def shards(
1887
1894
1888
1895
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
1889
1896
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.
1892
1901
:param format: Specifies the format to return the columnar data in, can be set
1893
1902
to `text`, `json`, `cbor`, `yaml`, or `smile`.
1894
1903
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -1967,13 +1976,16 @@ async def snapshots(
1967
1976
1968
1977
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
1969
1978
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.
1971
1982
:param format: Specifies the format to return the columnar data in, can be set
1972
1983
to `text`, `json`, `cbor`, `yaml`, or `smile`.
1973
1984
:param h: List of columns to appear in the response. Supports simple wildcards.
1974
1985
:param help: When set to `true` will output available columns. This option can't
1975
1986
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.
1977
1989
:param local: If `true`, the request computes the list of selected nodes from
1978
1990
the local cluster state. If `false` the list of selected nodes are computed
1979
1991
from the cluster state of the master node. In both cases the coordinating
@@ -2037,7 +2049,7 @@ async def tasks(
2037
2049
t .Union ["t.Literal[-1]" , "t.Literal[0]" , str ]
2038
2050
] = None ,
2039
2051
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 ,
2041
2053
pretty : t .Optional [bool ] = None ,
2042
2054
s : t .Optional [t .Union [str , t .Union [t .List [str ], t .Tuple [str , ...]]]] = None ,
2043
2055
v : t .Optional [bool ] = None ,
@@ -2048,9 +2060,9 @@ async def tasks(
2048
2060
2049
2061
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
2050
2062
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.
2054
2066
:param format: Specifies the format to return the columnar data in, can be set
2055
2067
to `text`, `json`, `cbor`, `yaml`, or `smile`.
2056
2068
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -2061,8 +2073,9 @@ async def tasks(
2061
2073
from the cluster state of the master node. In both cases the coordinating
2062
2074
node will send requests for further information to each selected node.
2063
2075
: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.
2066
2079
:param s: List of columns that determine how the table should be sorted. Sorting
2067
2080
defaults to ascending and can be changed by setting `:asc` or `:desc` as
2068
2081
a suffix to the column name.
@@ -2092,8 +2105,8 @@ async def tasks(
2092
2105
__query ["master_timeout" ] = master_timeout
2093
2106
if node_id is not None :
2094
2107
__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
2097
2110
if pretty is not None :
2098
2111
__query ["pretty" ] = pretty
2099
2112
if s is not None :
@@ -2131,7 +2144,8 @@ async def templates(
2131
2144
2132
2145
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
2133
2146
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.
2135
2149
:param format: Specifies the format to return the columnar data in, can be set
2136
2150
to `text`, `json`, `cbor`, `yaml`, or `smile`.
2137
2151
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -2211,8 +2225,8 @@ async def thread_pool(
2211
2225
2212
2226
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
2213
2227
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.
2216
2230
:param format: Specifies the format to return the columnar data in, can be set
2217
2231
to `text`, `json`, `cbor`, `yaml`, or `smile`.
2218
2232
:param h: List of columns to appear in the response. Supports simple wildcards.
@@ -2226,7 +2240,7 @@ async def thread_pool(
2226
2240
:param s: List of columns that determine how the table should be sorted. Sorting
2227
2241
defaults to ascending and can be changed by setting `:asc` or `:desc` as
2228
2242
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.
2230
2244
:param v: When set to `true` will enable verbose output.
2231
2245
"""
2232
2246
if thread_pool_patterns not in SKIP_IN_PATH :
@@ -2341,14 +2355,19 @@ async def transforms(
2341
2355
2342
2356
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
2343
2357
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.
2349
2368
:param format: Specifies the format to return the columnar data in, can be set
2350
2369
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.
2352
2371
:param h: Comma-separated list of column names to display.
2353
2372
:param help: When set to `true` will output available columns. This option can't
2354
2373
be combined with any other query string option.
@@ -2359,8 +2378,8 @@ async def transforms(
2359
2378
:param master_timeout: Period to wait for a connection to the master node.
2360
2379
:param s: Comma-separated list of column names or column aliases used to sort
2361
2380
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.
2364
2383
:param v: When set to `true` will enable verbose output.
2365
2384
"""
2366
2385
if transform_id not in SKIP_IN_PATH :
0 commit comments