# Cat

class elasticsearch.client.CatClient

  To use this client, access `client.cat` from an `Elasticsearch` client. For example:

      from elasticsearch import Elasticsearch

      # Create the client instance
      client = Elasticsearch(...)
      # Use the cat client
      client.cat.<method>(...)

  aliases(*, name=None, bytes=None, error_trace=None, expand_wildcards=None, filter_path=None, format=None, h=None, help=None, human=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get aliases.

    Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases.

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases

    Parameters:

      - name (str | Sequence[str] | None) – A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['alias', 'filter', 'index', 'is_write_index', 'routing.index', 'routing.search']] | str | ~typing.Literal['alias', 'filter', 'index', 'is_write_index', 'routing.index', 'routing.search'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  allocation(*, node_id=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get shard allocation information.

    Get a snapshot of the number of shards allocated to each data node and their disk space.

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation

    Parameters:

      - node_id (str | Sequence[str] | None) – A comma-separated list of node identifiers or names used to limit the returned information.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['disk.avail', 'disk.indices', 'disk.indices.forecast', 'disk.percent', 'disk.total', 'disk.used', 'host', 'ip', 'node', 'node.role', 'shards', 'shards.undesired', 'write_load.forecast']] | str | ~typing.Literal['disk.avail', 'disk.indices', 'disk.indices.forecast', 'disk.percent', 'disk.total', 'disk.used', 'host', 'ip', 'node', 'node.role', 'shards', 'shards.undesired', 'write_load.forecast'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  circuit_breaker(*, circuit_breaker_patterns=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get circuit breakers statistics.

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

    https://www.elastic.co/docs/api/doc/elasticsearch#TODO

    Parameters:

      - circuit_breaker_patterns (str | Sequence[str] | None) – A comma-separated list of regular-expressions to filter the circuit breakers in the output

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['breaker', 'estimated', 'estimated_bytes', 'limit', 'limit_bytes', 'node_id', 'node_name', 'overhead', 'tripped']] | str | ~typing.Literal['breaker', 'estimated', 'estimated_bytes', 'limit', 'limit_bytes', 'node_id', 'node_name', 'overhead', 'tripped'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  component_templates(*, name=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get component templates.

    Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates

    Parameters:

      - name (str | None) – The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['alias_count', 'included_in', 'mapping_count', 'metadata_count', 'name', 'settings_count', 'version']] | str | ~typing.Literal['alias_count', 'included_in', 'mapping_count', 'metadata_count', 'name', 'settings_count', 'version'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  count(*, index=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, pretty=None, project_routing=None, s=None, time=None, v=None, body=None)

    Get a document count.

    Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count

    Parameters:

      - index (str | Sequence[str] | None) – A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['count', 'epoch', 'timestamp']] | str | ~typing.Literal['count', 'epoch', 'timestamp'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - project_routing (str | None) – Specifies a subset of projects to target using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  fielddata(*, fields=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, pretty=None, s=None, time=None, v=None)

    Get field data cache information.

    Get the amount of heap memory currently used by the field data cache on every data node in the cluster.

    IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata

    Parameters:

      - fields (str | Sequence[str] | None) – Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['field', 'host', 'id', 'ip', 'node', 'size']] | str | ~typing.Literal['field', 'host', 'id', 'ip', 'node', 'size'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  health(*, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, pretty=None, s=None, time=None, ts=None, v=None)

    Get the cluster health status.

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health

    Parameters:

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['active_shards_percent', 'cluster', 'epoch', 'init', 'max_task_wait_time', 'node.data', 'node.total', 'pending_tasks', 'pri', 'relo', 'shards', 'status', 'timestamp', 'unassign', 'unassign.pri']] | str | ~typing.Literal['active_shards_percent', 'cluster', 'epoch', 'init', 'max_task_wait_time', 'node.data', 'node.total', 'pending_tasks', 'pri', 'relo', 'shards', 'status', 'timestamp', 'unassign', 'unassign.pri'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - ts (bool | None) – If true, returns HH:MM:SS and Unix epoch timestamps.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  help()

    Get CAT help.

    Get help for the CAT APIs.

    https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat

    Return type:

      TextApiResponse

  indices(*, index=None, bytes=None, error_trace=None, expand_wildcards=None, filter_path=None, format=None, h=None, health=None, help=None, human=None, include_unloaded_segments=None, master_timeout=None, pretty=None, pri=None, s=None, time=None, v=None)

    Get index information.

    Get high-level information about indices in a cluster, including backing indices for data streams.

    Use this request to get the following information for each index in a cluster:

    - shard count
    - document count
    - deleted document count
    - primary store size
    - total store size of all shards, including shard replicas

    These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.

    CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices

    Parameters:

      - index (str | Sequence[str] | None) – 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.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – The type of index that wildcard patterns can match.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['bulk.avg_size_in_bytes', 'bulk.avg_time', 'bulk.total_operations', 'bulk.total_size_in_bytes', 'bulk.total_time', 'completion.size', 'creation.date', 'creation.date.string', 'dataset.size', 'dense_vector.value_count', 'docs.count', 'docs.deleted', 'fielddata.evictions', 'fielddata.memory_size', 'flush.total', 'flush.total_time', 'get.current', 'get.exists_time', 'get.exists_total', 'get.missing_time', 'get.missing_total', 'get.time', 'get.total', 'health', 'index', 'indexing.delete_current', 'indexing.delete_time', 'indexing.delete_total', 'indexing.index_current', 'indexing.index_failed', 'indexing.index_failed_due_to_version_conflict', 'indexing.index_time', 'indexing.index_total', 'memory.total', 'merges.current', 'merges.current_docs', 'merges.current_size', 'merges.total', 'merges.total_docs', 'merges.total_size', 'merges.total_time', 'pri', 'pri.bulk.avg_size_in_bytes', 'pri.bulk.avg_time', 'pri.bulk.total_operations', 'pri.bulk.total_size_in_bytes', 'pri.bulk.total_time', 'pri.completion.size', 'pri.dense_vector.value_count', 'pri.fielddata.evictions', 'pri.fielddata.memory_size', 'pri.flush.total', 'pri.flush.total_time', 'pri.get.current', 'pri.get.exists_time', 'pri.get.exists_total', 'pri.get.missing_time', 'pri.get.missing_total', 'pri.get.time', 'pri.get.total', 'pri.indexing.delete_current', 'pri.indexing.delete_time', 'pri.indexing.delete_total', 'pri.indexing.index_current', 'pri.indexing.index_failed', 'pri.indexing.index_failed_due_to_version_conflict', 'pri.indexing.index_time', 'pri.indexing.index_total', 'pri.memory.total', 'pri.merges.current', 'pri.merges.current_docs', 'pri.merges.current_size', 'pri.merges.total', 'pri.merges.total_docs', 'pri.merges.total_size', 'pri.merges.total_time', 'pri.query_cache.evictions', 'pri.query_cache.memory_size', 'pri.refresh.external_time', 'pri.refresh.external_total', 'pri.refresh.listeners', 'pri.refresh.time', 'pri.refresh.total', 'pri.request_cache.evictions', 'pri.request_cache.hit_count', 'pri.request_cache.memory_size', 'pri.request_cache.miss_count', 'pri.search.fetch_current', 'pri.search.fetch_time', 'pri.search.fetch_total', 'pri.search.open_contexts', 'pri.search.query_current', 'pri.search.query_time', 'pri.search.query_total', 'pri.search.scroll_current', 'pri.search.scroll_time', 'pri.search.scroll_total', 'pri.segments.count', 'pri.segments.fixed_bitset_memory', 'pri.segments.index_writer_memory', 'pri.segments.memory', 'pri.segments.version_map_memory', 'pri.sparse_vector.value_count', 'pri.store.size', 'pri.suggest.current', 'pri.suggest.time', 'pri.suggest.total', 'pri.warmer.current', 'pri.warmer.total', 'pri.warmer.total_time', 'query_cache.evictions', 'query_cache.memory_size', 'refresh.external_time', 'refresh.external_total', 'refresh.listeners', 'refresh.time', 'refresh.total', 'rep', 'request_cache.evictions', 'request_cache.hit_count', 'request_cache.memory_size', 'request_cache.miss_count', 'search.fetch_current', 'search.fetch_time', 'search.fetch_total', 'search.open_contexts', 'search.query_current', 'search.query_time', 'search.query_total', 'search.scroll_current', 'search.scroll_time', 'search.scroll_total', 'segments.count', 'segments.fixed_bitset_memory', 'segments.index_writer_memory', 'segments.memory', 'segments.version_map_memory', 'sparse_vector.value_count', 'status', 'store.size', 'suggest.current', 'suggest.time', 'suggest.total', 'uuid', 'warmer.current', 'warmer.total', 'warmer.total_time']] | str | ~typing.Literal['bulk.avg_size_in_bytes', 'bulk.avg_time', 'bulk.total_operations', 'bulk.total_size_in_bytes', 'bulk.total_time', 'completion.size', 'creation.date', 'creation.date.string', 'dataset.size', 'dense_vector.value_count', 'docs.count', 'docs.deleted', 'fielddata.evictions', 'fielddata.memory_size', 'flush.total', 'flush.total_time', 'get.current', 'get.exists_time', 'get.exists_total', 'get.missing_time', 'get.missing_total', 'get.time', 'get.total', 'health', 'index', 'indexing.delete_current', 'indexing.delete_time', 'indexing.delete_total', 'indexing.index_current', 'indexing.index_failed', 'indexing.index_failed_due_to_version_conflict', 'indexing.index_time', 'indexing.index_total', 'memory.total', 'merges.current', 'merges.current_docs', 'merges.current_size', 'merges.total', 'merges.total_docs', 'merges.total_size', 'merges.total_time', 'pri', 'pri.bulk.avg_size_in_bytes', 'pri.bulk.avg_time', 'pri.bulk.total_operations', 'pri.bulk.total_size_in_bytes', 'pri.bulk.total_time', 'pri.completion.size', 'pri.dense_vector.value_count', 'pri.fielddata.evictions', 'pri.fielddata.memory_size', 'pri.flush.total', 'pri.flush.total_time', 'pri.get.current', 'pri.get.exists_time', 'pri.get.exists_total', 'pri.get.missing_time', 'pri.get.missing_total', 'pri.get.time', 'pri.get.total', 'pri.indexing.delete_current', 'pri.indexing.delete_time', 'pri.indexing.delete_total', 'pri.indexing.index_current', 'pri.indexing.index_failed', 'pri.indexing.index_failed_due_to_version_conflict', 'pri.indexing.index_time', 'pri.indexing.index_total', 'pri.memory.total', 'pri.merges.current', 'pri.merges.current_docs', 'pri.merges.current_size', 'pri.merges.total', 'pri.merges.total_docs', 'pri.merges.total_size', 'pri.merges.total_time', 'pri.query_cache.evictions', 'pri.query_cache.memory_size', 'pri.refresh.external_time', 'pri.refresh.external_total', 'pri.refresh.listeners', 'pri.refresh.time', 'pri.refresh.total', 'pri.request_cache.evictions', 'pri.request_cache.hit_count', 'pri.request_cache.memory_size', 'pri.request_cache.miss_count', 'pri.search.fetch_current', 'pri.search.fetch_time', 'pri.search.fetch_total', 'pri.search.open_contexts', 'pri.search.query_current', 'pri.search.query_time', 'pri.search.query_total', 'pri.search.scroll_current', 'pri.search.scroll_time', 'pri.search.scroll_total', 'pri.segments.count', 'pri.segments.fixed_bitset_memory', 'pri.segments.index_writer_memory', 'pri.segments.memory', 'pri.segments.version_map_memory', 'pri.sparse_vector.value_count', 'pri.store.size', 'pri.suggest.current', 'pri.suggest.time', 'pri.suggest.total', 'pri.warmer.current', 'pri.warmer.total', 'pri.warmer.total_time', 'query_cache.evictions', 'query_cache.memory_size', 'refresh.external_time', 'refresh.external_total', 'refresh.listeners', 'refresh.time', 'refresh.total', 'rep', 'request_cache.evictions', 'request_cache.hit_count', 'request_cache.memory_size', 'request_cache.miss_count', 'search.fetch_current', 'search.fetch_time', 'search.fetch_total', 'search.open_contexts', 'search.query_current', 'search.query_time', 'search.query_total', 'search.scroll_current', 'search.scroll_time', 'search.scroll_total', 'segments.count', 'segments.fixed_bitset_memory', 'segments.index_writer_memory', 'segments.memory', 'segments.version_map_memory', 'sparse_vector.value_count', 'status', 'store.size', 'suggest.current', 'suggest.time', 'suggest.total', 'uuid', 'warmer.current', 'warmer.total', 'warmer.total_time'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - health (str | Literal['green', 'red', 'unavailable', 'unknown', 'yellow'] | None) – The health status used to limit returned indices. By default, the response includes indices of any health status.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - include_unloaded_segments (bool | None) – If true, the response includes information from segments that are not loaded into memory.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - pri (bool | None) – If true, the response only includes information from primary shards.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  master(*, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get master node information.

    Get information about the master node, including the ID, bound IP address, and name.

    IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master

    Parameters:

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['host', 'id', 'ip', 'node']] | str | ~typing.Literal['host', 'id', 'ip', 'node'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  ml_data_frame_analytics(*, id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, pretty=None, s=None, time=None, v=None)

    Get data frame analytics jobs.

    Get configuration and usage information about data frame analytics jobs.

    IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics

    Parameters:

      - id (str | None) – The ID of the data frame analytics to fetch

      - allow_no_match (bool | None) – Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified.)

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version']] | str | ~typing.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version'] | None) – Comma-separated list of column names to display.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (Sequence[str | Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version']] | str | ~typing.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version'] | None) – Comma-separated list of column names or column aliases used to sort the response.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  ml_datafeeds(*, datafeed_id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, pretty=None, s=None, time=None, v=None)

    Get datafeeds.

    Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.

    IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds

    Parameters:

      - datafeed_id (str | None) – A numerical character string that uniquely identifies the datafeed.

      - allow_no_match (bool | None) – Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the _all string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If true, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st']] | str | ~typing.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st'] | None) – Comma-separated list of column names to display.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (Sequence[str | Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st']] | str | ~typing.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st'] | None) – Comma-separated list of column names or column aliases used to sort the response.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  ml_jobs(*, job_id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, pretty=None, s=None, time=None, v=None)

    Get anomaly detection jobs.

    Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.

    IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs

    Parameters:

      - job_id (str | None) – Identifier for the anomaly detection job.

      - allow_no_match (bool | None) – Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the _all string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If true, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state']] | str | ~typing.Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state'] | None) – Comma-separated list of column names to display.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (Sequence[str | Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state']] | str | ~typing.Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state'] | None) – Comma-separated list of column names or column aliases used to sort the response.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  ml_trained_models(*, model_id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, from_=None, h=None, help=None, human=None, pretty=None, s=None, size=None, time=None, v=None)

    Get trained models.

    Get configuration and usage information about inference trained models.

    IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models

    Parameters:

      - model_id (str | None) – A unique identifier for the trained model.

      - allow_no_match (bool | None) – Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - from – Skips the specified number of transforms.

      - h (Sequence[str | Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version']] | str | ~typing.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version'] | None) – A comma-separated list of column names to display.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (Sequence[str | Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version']] | str | ~typing.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version'] | None) – A comma-separated list of column names or aliases used to sort the response.

      - size (int | None) – The maximum number of transforms to display.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - from_ (int | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  nodeattrs(*, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get node attribute information.

    Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs

    Parameters:

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['attr', 'host', 'id', 'ip', 'node', 'pid', 'port', 'value']] | str | ~typing.Literal['attr', 'host', 'id', 'ip', 'node', 'pid', 'port', 'value'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  nodes(*, bytes=None, error_trace=None, filter_path=None, format=None, full_id=None, h=None, help=None, human=None, include_unloaded_segments=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get node information.

    Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes

    Parameters:

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - full_id (bool | None) – If true, return the full node ID. If false, return the shortened node ID.

      - h (Sequence[str | Literal['available_processors', 'build', 'completion.size', 'cpu', 'disk.avail', 'disk.total', 'disk.used', 'disk.used_percent', 'fielddata.evictions', 'fielddata.memory_size', 'file_desc.current', 'file_desc.max', 'file_desc.percent', 'flush.total', 'flush.total_time', 'get.current', 'get.exists_time', 'get.exists_total', 'get.missing_time', 'get.missing_total', 'get.time', 'get.total', 'heap.current', 'heap.max', 'heap.percent', 'http_address', 'id', 'indexing.delete_current', 'indexing.delete_time', 'indexing.delete_total', 'indexing.index_current', 'indexing.index_failed', 'indexing.index_failed_due_to_version_conflict', 'indexing.index_time', 'indexing.index_total', 'ip', 'jdk', 'load_15m', 'load_1m', 'load_5m', 'mappings.total_count', 'mappings.total_estimated_overhead_in_bytes', 'master', 'merges.current', 'merges.current_docs', 'merges.current_size', 'merges.total', 'merges.total_docs', 'merges.total_size', 'merges.total_time', 'name', 'node.role', 'pid', 'port', 'query_cache.evictions', 'query_cache.hit_count', 'query_cache.memory_size', 'query_cache.miss_count', 'ram.current', 'ram.max', 'ram.percent', 'refresh.time', 'refresh.total', 'request_cache.evictions', 'request_cache.hit_count', 'request_cache.memory_size', 'request_cache.miss_count', 'script.cache_evictions', 'script.compilations', 'search.fetch_current', 'search.fetch_time', 'search.fetch_total', 'search.open_contexts', 'search.query_current', 'search.query_time', 'search.query_total', 'search.scroll_current', 'search.scroll_time', 'search.scroll_total', 'segments.count', 'segments.fixed_bitset_memory', 'segments.index_writer_memory', 'segments.memory', 'segments.version_map_memory', 'shard_stats.total_count', 'suggest.current', 'suggest.time', 'suggest.total', 'uptime', 'version']] | str | ~typing.Literal['available_processors', 'build', 'completion.size', 'cpu', 'disk.avail', 'disk.total', 'disk.used', 'disk.used_percent', 'fielddata.evictions', 'fielddata.memory_size', 'file_desc.current', 'file_desc.max', 'file_desc.percent', 'flush.total', 'flush.total_time', 'get.current', 'get.exists_time', 'get.exists_total', 'get.missing_time', 'get.missing_total', 'get.time', 'get.total', 'heap.current', 'heap.max', 'heap.percent', 'http_address', 'id', 'indexing.delete_current', 'indexing.delete_time', 'indexing.delete_total', 'indexing.index_current', 'indexing.index_failed', 'indexing.index_failed_due_to_version_conflict', 'indexing.index_time', 'indexing.index_total', 'ip', 'jdk', 'load_15m', 'load_1m', 'load_5m', 'mappings.total_count', 'mappings.total_estimated_overhead_in_bytes', 'master', 'merges.current', 'merges.current_docs', 'merges.current_size', 'merges.total', 'merges.total_docs', 'merges.total_size', 'merges.total_time', 'name', 'node.role', 'pid', 'port', 'query_cache.evictions', 'query_cache.hit_count', 'query_cache.memory_size', 'query_cache.miss_count', 'ram.current', 'ram.max', 'ram.percent', 'refresh.time', 'refresh.total', 'request_cache.evictions', 'request_cache.hit_count', 'request_cache.memory_size', 'request_cache.miss_count', 'script.cache_evictions', 'script.compilations', 'search.fetch_current', 'search.fetch_time', 'search.fetch_total', 'search.open_contexts', 'search.query_current', 'search.query_time', 'search.query_total', 'search.scroll_current', 'search.scroll_time', 'search.scroll_total', 'segments.count', 'segments.fixed_bitset_memory', 'segments.index_writer_memory', 'segments.memory', 'segments.version_map_memory', 'shard_stats.total_count', 'suggest.current', 'suggest.time', 'suggest.total', 'uptime', 'version'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - include_unloaded_segments (bool | None) – If true, the response includes information from segments that are not loaded into memory.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  pending_tasks(*, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get pending task information.

    Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks

    Parameters:

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['insertOrder', 'priority', 'source', 'timeInQueue']] | str | ~typing.Literal['insertOrder', 'priority', 'source', 'timeInQueue'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  plugins(*, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, include_bootstrap=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get plugin information.

    Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins

    Parameters:

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['component', 'description', 'id', 'name', 'version']] | str | ~typing.Literal['component', 'description', 'id', 'name', 'version'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - include_bootstrap (bool | None) – Include bootstrap plugins in the response

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  recovery(*, index=None, active_only=None, bytes=None, detailed=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, pretty=None, s=None, time=None, v=None)

    Get shard recovery information.

    Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery

    Parameters:

      - index (str | Sequence[str] | None) – A 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.

      - active_only (bool | None) – If true, the response only includes ongoing shard recoveries.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - detailed (bool | None) – If true, the response includes detailed information about shard recoveries.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['bytes', 'bytes_percent', 'bytes_recovered', 'bytes_total', 'files', 'files_percent', 'files_recovered', 'files_total', 'index', 'repository', 'shard', 'snapshot', 'source_host', 'source_node', 'stage', 'start_time', 'start_time_millis', 'stop_time', 'stop_time_millis', 'target_host', 'target_node', 'time', 'translog_ops', 'translog_ops_percent', 'translog_ops_recovered', 'type']] | str | ~typing.Literal['bytes', 'bytes_percent', 'bytes_recovered', 'bytes_total', 'files', 'files_percent', 'files_recovered', 'files_total', 'index', 'repository', 'shard', 'snapshot', 'source_host', 'source_node', 'stage', 'start_time', 'start_time_millis', 'stop_time', 'stop_time_millis', 'target_host', 'target_node', 'time', 'translog_ops', 'translog_ops_percent', 'translog_ops_recovered', 'type'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (str | Sequence[str] | None) – A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  repositories(*, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get snapshot repository information.

    Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories

    Parameters:

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  segments(*, index=None, allow_closed=None, allow_no_indices=None, bytes=None, error_trace=None, expand_wildcards=None, filter_path=None, format=None, h=None, help=None, human=None, ignore_throttled=None, ignore_unavailable=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get segment information.

    Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments

    Parameters:

      - index (str | Sequence[str] | None) – A 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.

      - allow_closed (bool | None) – If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['committed', 'compound', 'docs.count', 'docs.deleted', 'generation', 'id', 'index', 'ip', 'prirep', 'searchable', 'segment', 'shard', 'size', 'size.memory', 'version']] | str | ~typing.Literal['committed', 'compound', 'docs.count', 'docs.deleted', 'generation', 'id', 'index', 'ip', 'prirep', 'searchable', 'segment', 'shard', 'size', 'size.memory', 'version'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - ignore_throttled (bool | None) – If true, concrete, expanded or aliased indices are ignored when frozen.

      - ignore_unavailable (bool | None) – If true, missing or closed indices are not included in the response.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  shards(*, index=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get shard information.

    Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards

    Parameters:

      - index (str | Sequence[str] | None) – A 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.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['completion.size', 'dataset.size', 'dense_vector.value_count', 'docs', 'dsparse_vector.value_count', 'fielddata.evictions', 'fielddata.memory_size', 'flush.total', 'flush.total_time', 'get.current', 'get.exists_time', 'get.exists_total', 'get.missing_time', 'get.missing_total', 'get.time', 'get.total', 'id', 'index', 'indexing.delete_current', 'indexing.delete_time', 'indexing.delete_total', 'indexing.index_current', 'indexing.index_failed', 'indexing.index_failed_due_to_version_conflict', 'indexing.index_time', 'indexing.index_total', 'ip', 'merges.current', 'merges.current_docs', 'merges.current_size', 'merges.total', 'merges.total_docs', 'merges.total_size', 'merges.total_time', 'node', 'prirep', 'query_cache.evictions', 'query_cache.memory_size', 'recoverysource.type', 'refresh.time', 'refresh.total', 'search.fetch_current', 'search.fetch_time', 'search.fetch_total', 'search.open_contexts', 'search.query_current', 'search.query_time', 'search.query_total', 'search.scroll_current', 'search.scroll_time', 'search.scroll_total', 'segments.count', 'segments.fixed_bitset_memory', 'segments.index_writer_memory', 'segments.memory', 'segments.version_map_memory', 'seq_no.global_checkpoint', 'seq_no.local_checkpoint', 'seq_no.max', 'shard', 'state', 'store', 'suggest.current', 'suggest.time', 'suggest.total', 'sync_id', 'unassigned.at', 'unassigned.details', 'unassigned.for', 'unassigned.reason']] | str | ~typing.Literal['completion.size', 'dataset.size', 'dense_vector.value_count', 'docs', 'dsparse_vector.value_count', 'fielddata.evictions', 'fielddata.memory_size', 'flush.total', 'flush.total_time', 'get.current', 'get.exists_time', 'get.exists_total', 'get.missing_time', 'get.missing_total', 'get.time', 'get.total', 'id', 'index', 'indexing.delete_current', 'indexing.delete_time', 'indexing.delete_total', 'indexing.index_current', 'indexing.index_failed', 'indexing.index_failed_due_to_version_conflict', 'indexing.index_time', 'indexing.index_total', 'ip', 'merges.current', 'merges.current_docs', 'merges.current_size', 'merges.total', 'merges.total_docs', 'merges.total_size', 'merges.total_time', 'node', 'prirep', 'query_cache.evictions', 'query_cache.memory_size', 'recoverysource.type', 'refresh.time', 'refresh.total', 'search.fetch_current', 'search.fetch_time', 'search.fetch_total', 'search.open_contexts', 'search.query_current', 'search.query_time', 'search.query_total', 'search.scroll_current', 'search.scroll_time', 'search.scroll_total', 'segments.count', 'segments.fixed_bitset_memory', 'segments.index_writer_memory', 'segments.memory', 'segments.version_map_memory', 'seq_no.global_checkpoint', 'seq_no.local_checkpoint', 'seq_no.max', 'shard', 'state', 'store', 'suggest.current', 'suggest.time', 'suggest.total', 'sync_id', 'unassigned.at', 'unassigned.details', 'unassigned.for', 'unassigned.reason'] | None) – List of columns to appear in the response. Supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  snapshots(*, repository=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get snapshot information.

    Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots

    Parameters:

      - repository (str | Sequence[str] | None) – A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['duration', 'end_epoch', 'end_time', 'failed_shards', 'id', 'indices', 'reason', 'repository', 'start_epoch', 'start_time', 'status', 'successful_shards', 'total_shards']] | str | ~typing.Literal['duration', 'end_epoch', 'end_time', 'failed_shards', 'id', 'indices', 'reason', 'repository', 'start_epoch', 'start_time', 'status', 'successful_shards', 'total_shards'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - ignore_unavailable (bool | None) – If true, the response does not include information from unavailable snapshots.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  tasks(*, actions=None, bytes=None, detailed=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, nodes=None, parent_task_id=None, pretty=None, s=None, time=None, timeout=None, v=None, wait_for_completion=None)

    Get task information.

    Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks

    Parameters:

      - actions (Sequence[str] | None) – The task action names, which are used to limit the response.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - detailed (bool | None) – If true, the response includes detailed information about shard recoveries.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['action', 'id', 'ip', 'node', 'node_id', 'parent_task_id', 'port', 'running_time', 'running_time_ns', 'start_time', 'task_id', 'timestamp', 'type', 'version', 'x_opaque_id']] | str | ~typing.Literal['action', 'id', 'ip', 'node', 'node_id', 'parent_task_id', 'port', 'running_time', 'running_time_ns', 'start_time', 'task_id', 'timestamp', 'type', 'version', 'x_opaque_id'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - nodes (Sequence[str] | None) – Unique node identifiers, which are used to limit the response.

      - parent_task_id (str | None) – The parent task identifier, which is used to limit the response.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - v (bool | None) – When set to true will enable verbose output.

      - wait_for_completion (bool | None) – If true, the request blocks until the task has completed.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  templates(*, name=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get index template information.

    Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates

    Parameters:

      - name (str | None) – The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['composed_of', 'index_patterns', 'name', 'order', 'version']] | str | ~typing.Literal['composed_of', 'index_patterns', 'name', 'order', 'version'] | None) – A comma-separated list of columns names to display. It supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – 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.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  thread_pool(*, thread_pool_patterns=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

    Get thread pool statistics.

    Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool

    Parameters:

      - thread_pool_patterns (str | Sequence[str] | None) – A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - h (Sequence[str | Literal['active', 'completed', 'core', 'ephemeral_id', 'host', 'ip', 'keep_alive', 'largest', 'max', 'name', 'node_id', 'node_name', 'pid', 'pool_size', 'port', 'queue', 'queue_size', 'rejected', 'size', 'type']] | str | ~typing.Literal['active', 'completed', 'core', 'ephemeral_id', 'host', 'ip', 'keep_alive', 'largest', 'max', 'name', 'node_id', 'node_name', 'pid', 'pool_size', 'port', 'queue', 'queue_size', 'rejected', 'size', 'type'] | None) – List of columns to appear in the response. Supports simple wildcards.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - local (bool | None) – 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.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - s (str | Sequence[str] | None) – A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse

  transforms(*, transform_id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, from_=None, h=None, help=None, human=None, pretty=None, s=None, size=None, time=None, v=None)

    Get transform information.

    Get configuration and usage information about transforms.

    CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms

    Parameters:

      - transform_id (str | None) – A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.

      - allow_no_match (bool | None) – Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.

      - bytes (str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None) – Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      - format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

      - from – Skips the specified number of transforms.

      - h (Sequence[str | Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version']] | str | ~typing.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version'] | None) – Comma-separated list of column names to display.

      - help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

      - s (Sequence[str | Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version']] | str | ~typing.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version'] | None) – Comma-separated list of column names or column aliases used to sort the response.

      - size (int | None) – The maximum number of transforms to obtain.

      - time (str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None) – Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      - v (bool | None) – When set to true will enable verbose output.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - from_ (int | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any] | TextApiResponse