elasticsearch/_async/client/cat.py [771:943]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
id: t.Optional[str] = None,
allow_no_match: t.Optional[bool] = None,
bytes: t.Optional[
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
format: t.Optional[str] = None,
h: t.Optional[
t.Union[
t.Sequence[
t.Union[
str,
t.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",
],
]
],
t.Union[
str,
t.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,
help: t.Optional[bool] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
s: t.Optional[
t.Union[
t.Sequence[
t.Union[
str,
t.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",
],
]
],
t.Union[
str,
t.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,
time: t.Optional[
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
] = None,
v: t.Optional[bool] = None,
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
"""
.. raw:: html
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.
``_
:param id: The ID of the data frame analytics to fetch
:param allow_no_match: Whether to ignore if a wildcard expression matches no
configs. (This includes `_all` string or when no configs have been specified)
:param bytes: The unit in which to display byte values
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
:param h: Comma-separated list of column names to display.
:param help: When set to `true` will output available columns. This option can't
be combined with any other query string option.
:param s: Comma-separated list of column names or column aliases used to sort
the response.
:param time: Unit used to display time values.
:param v: When set to `true` will enable verbose output.
"""
__path_parts: t.Dict[str, str]
if id not in SKIP_IN_PATH:
__path_parts = {"id": _quote(id)}
__path = f'/_cat/ml/data_frame/analytics/{__path_parts["id"]}'
else:
__path_parts = {}
__path = "/_cat/ml/data_frame/analytics"
__query: t.Dict[str, t.Any] = {}
if allow_no_match is not None:
__query["allow_no_match"] = allow_no_match
if bytes is not None:
__query["bytes"] = bytes
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if format is not None:
__query["format"] = format
if h is not None:
__query["h"] = h
if help is not None:
__query["help"] = help
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if s is not None:
__query["s"] = s
if time is not None:
__query["time"] = time
if v is not None:
__query["v"] = v
__headers = {"accept": "text/plain,application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elasticsearch/_sync/client/cat.py [771:943]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
id: t.Optional[str] = None,
allow_no_match: t.Optional[bool] = None,
bytes: t.Optional[
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
format: t.Optional[str] = None,
h: t.Optional[
t.Union[
t.Sequence[
t.Union[
str,
t.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",
],
]
],
t.Union[
str,
t.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,
help: t.Optional[bool] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
s: t.Optional[
t.Union[
t.Sequence[
t.Union[
str,
t.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",
],
]
],
t.Union[
str,
t.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,
time: t.Optional[
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
] = None,
v: t.Optional[bool] = None,
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
"""
.. raw:: html
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.
``_
:param id: The ID of the data frame analytics to fetch
:param allow_no_match: Whether to ignore if a wildcard expression matches no
configs. (This includes `_all` string or when no configs have been specified)
:param bytes: The unit in which to display byte values
:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
:param h: Comma-separated list of column names to display.
:param help: When set to `true` will output available columns. This option can't
be combined with any other query string option.
:param s: Comma-separated list of column names or column aliases used to sort
the response.
:param time: Unit used to display time values.
:param v: When set to `true` will enable verbose output.
"""
__path_parts: t.Dict[str, str]
if id not in SKIP_IN_PATH:
__path_parts = {"id": _quote(id)}
__path = f'/_cat/ml/data_frame/analytics/{__path_parts["id"]}'
else:
__path_parts = {}
__path = "/_cat/ml/data_frame/analytics"
__query: t.Dict[str, t.Any] = {}
if allow_no_match is not None:
__query["allow_no_match"] = allow_no_match
if bytes is not None:
__query["bytes"] = bytes
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if format is not None:
__query["format"] = format
if h is not None:
__query["h"] = h
if help is not None:
__query["help"] = help
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if s is not None:
__query["s"] = s
if time is not None:
__query["time"] = time
if v is not None:
__query["v"] = v
__headers = {"accept": "text/plain,application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -