Auto-generated API code

Author: elasticmachine

elasticsearch/_async/client/cat.py

@@ -69,7 +69,8 @@ async def aliases(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
 
-        :param name: A comma-separated list of alias names to return
+        :param name: A comma-separated list of aliases to retrieve. Supports wildcards
+            (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
         :param expand_wildcards: Whether to expand wildcard expression to concrete indices
             that are open, closed or both.
         :param format: Specifies the format to return the columnar data in, can be set
@@ -153,9 +154,9 @@ async def allocation(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
 
-        :param node_id: A comma-separated list of node IDs or names to limit the returned
-            information
-        :param bytes: The unit in which to display byte values
+        :param node_id: Comma-separated list of node identifiers or names used to limit
+            the returned information.
+        :param bytes: The unit used to display byte values.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -231,7 +232,8 @@ async def component_templates(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
 
-        :param name: A pattern that returned component template names must match
+        :param name: The name of the component template. Accepts wildcard expressions.
+            If omitted, all component templates are returned.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -306,7 +308,9 @@ async def count(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
 
-        :param index: A comma-separated list of index names to limit the returned information
+        :param index: Comma-separated list of data streams, indices, and aliases used
+            to limit the request. Supports wildcards (`*`). To target all data streams
+            and indices, omit this parameter or use `*` or `_all`.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -386,8 +390,9 @@ async def fielddata(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
 
-        :param fields: A comma-separated list of fields to return the fielddata size
-        :param bytes: The unit in which to display byte values
+        :param fields: Comma-separated list of fields used to limit returned information.
+            To retrieve all fields, omit this parameter.
+        :param bytes: The unit used to display byte values.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -455,6 +460,9 @@ async def health(
         ] = None,
         pretty: t.Optional[bool] = None,
         s: t.Optional[t.Union[str, t.Union[t.List[str], t.Tuple[str, ...]]]] = None,
+        time: t.Optional[
+            t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
+        ] = None,
         ts: t.Optional[bool] = None,
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
@@ -476,7 +484,8 @@ async def health(
         :param s: List of columns that determine how the table should be sorted. Sorting
             defaults to ascending and can be changed by setting `:asc` or `:desc` as
             a suffix to the column name.
-        :param ts: Set to false to disable timestamping
+        :param time: The unit used to display time values.
+        :param ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
         :param v: When set to `true` will enable verbose output.
         """
         __path = "/_cat/health"
@@ -501,6 +510,8 @@ async def health(
             __query["pretty"] = pretty
         if s is not None:
             __query["s"] = s
+        if time is not None:
+            __query["time"] = time
         if ts is not None:
             __query["ts"] = ts
         if v is not None:
@@ -633,29 +644,30 @@ async def indices(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
 
-        :param index: A comma-separated list of index names to limit the returned information
-        :param bytes: The unit in which to display byte values
-        :param expand_wildcards: Whether to expand wildcard expression to concrete indices
-            that are open, closed or both.
+        :param index: Comma-separated list of data streams, indices, and aliases used
+            to limit the request. Supports wildcards (`*`). To target all data streams
+            and indices, omit this parameter or use `*` or `_all`.
+        :param bytes: The unit used to display byte values.
+        :param expand_wildcards: The type of index that wildcard patterns can match.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
-        :param health: A health status ("green", "yellow", or "red" to filter only indices
-            matching the specified health status
+        :param health: The health status used to limit returned indices. By default,
+            the response includes indices of any health status.
         :param help: When set to `true` will output available columns. This option can't
             be combined with any other query string option.
-        :param include_unloaded_segments: If set to true segment stats will include stats
-            for segments that are not currently loaded into memory
+        :param include_unloaded_segments: If true, the response includes information
+            from segments that are not loaded into memory.
         :param local: If `true`, the request computes the list of selected nodes from
             the local cluster state. If `false` the list of selected nodes are computed
             from the cluster state of the master node. In both cases the coordinating
             node will send requests for further information to each selected node.
         :param master_timeout: Period to wait for a connection to the master node.
-        :param pri: Set to true to return stats only for primary shards
+        :param pri: If true, the response only includes information from primary shards.
         :param s: List of columns that determine how the table should be sorted. Sorting
             defaults to ascending and can be changed by setting `:asc` or `:desc` as
             a suffix to the column name.
-        :param time: The unit in which to display time values
+        :param time: The unit used to display time values.
         :param v: When set to `true` will enable verbose output.
         """
         if index not in SKIP_IN_PATH:

elasticsearch/_sync/client/cat.py

@@ -69,7 +69,8 @@ def aliases(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
 
-        :param name: A comma-separated list of alias names to return
+        :param name: A comma-separated list of aliases to retrieve. Supports wildcards
+            (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
         :param expand_wildcards: Whether to expand wildcard expression to concrete indices
             that are open, closed or both.
         :param format: Specifies the format to return the columnar data in, can be set
@@ -153,9 +154,9 @@ def allocation(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
 
-        :param node_id: A comma-separated list of node IDs or names to limit the returned
-            information
-        :param bytes: The unit in which to display byte values
+        :param node_id: Comma-separated list of node identifiers or names used to limit
+            the returned information.
+        :param bytes: The unit used to display byte values.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -231,7 +232,8 @@ def component_templates(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
 
-        :param name: A pattern that returned component template names must match
+        :param name: The name of the component template. Accepts wildcard expressions.
+            If omitted, all component templates are returned.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -306,7 +308,9 @@ def count(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
 
-        :param index: A comma-separated list of index names to limit the returned information
+        :param index: Comma-separated list of data streams, indices, and aliases used
+            to limit the request. Supports wildcards (`*`). To target all data streams
+            and indices, omit this parameter or use `*` or `_all`.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -386,8 +390,9 @@ def fielddata(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
 
-        :param fields: A comma-separated list of fields to return the fielddata size
-        :param bytes: The unit in which to display byte values
+        :param fields: Comma-separated list of fields used to limit returned information.
+            To retrieve all fields, omit this parameter.
+        :param bytes: The unit used to display byte values.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -455,6 +460,9 @@ def health(
         ] = None,
         pretty: t.Optional[bool] = None,
         s: t.Optional[t.Union[str, t.Union[t.List[str], t.Tuple[str, ...]]]] = None,
+        time: t.Optional[
+            t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
+        ] = None,
         ts: t.Optional[bool] = None,
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
@@ -476,7 +484,8 @@ def health(
         :param s: List of columns that determine how the table should be sorted. Sorting
             defaults to ascending and can be changed by setting `:asc` or `:desc` as
             a suffix to the column name.
-        :param ts: Set to false to disable timestamping
+        :param time: The unit used to display time values.
+        :param ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
         :param v: When set to `true` will enable verbose output.
         """
         __path = "/_cat/health"
@@ -501,6 +510,8 @@ def health(
             __query["pretty"] = pretty
         if s is not None:
             __query["s"] = s
+        if time is not None:
+            __query["time"] = time
         if ts is not None:
             __query["ts"] = ts
         if v is not None:
@@ -633,29 +644,30 @@ def indices(
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
 
-        :param index: A comma-separated list of index names to limit the returned information
-        :param bytes: The unit in which to display byte values
-        :param expand_wildcards: Whether to expand wildcard expression to concrete indices
-            that are open, closed or both.
+        :param index: Comma-separated list of data streams, indices, and aliases used
+            to limit the request. Supports wildcards (`*`). To target all data streams
+            and indices, omit this parameter or use `*` or `_all`.
+        :param bytes: The unit used to display byte values.
+        :param expand_wildcards: The type of index that wildcard patterns can match.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param h: List of columns to appear in the response. Supports simple wildcards.
-        :param health: A health status ("green", "yellow", or "red" to filter only indices
-            matching the specified health status
+        :param health: The health status used to limit returned indices. By default,
+            the response includes indices of any health status.
         :param help: When set to `true` will output available columns. This option can't
             be combined with any other query string option.
-        :param include_unloaded_segments: If set to true segment stats will include stats
-            for segments that are not currently loaded into memory
+        :param include_unloaded_segments: If true, the response includes information
+            from segments that are not loaded into memory.
         :param local: If `true`, the request computes the list of selected nodes from
             the local cluster state. If `false` the list of selected nodes are computed
             from the cluster state of the master node. In both cases the coordinating
             node will send requests for further information to each selected node.
         :param master_timeout: Period to wait for a connection to the master node.
-        :param pri: Set to true to return stats only for primary shards
+        :param pri: If true, the response only includes information from primary shards.
         :param s: List of columns that determine how the table should be sorted. Sorting
             defaults to ascending and can be changed by setting `:asc` or `:desc` as
             a suffix to the column name.
-        :param time: The unit in which to display time values
+        :param time: The unit used to display time values.
         :param v: When set to `true` will enable verbose output.
         """
         if index not in SKIP_IN_PATH: