elasticsearch/_async/client/cat.py [955:1114]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
datafeed_id: t.Optional[str] = None,
allow_no_match: t.Optional[bool] = 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[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
]
],
t.Union[
str,
t.Literal[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
],
]
] = 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[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
]
],
t.Union[
str,
t.Literal[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
],
]
] = 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 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.
``_
:param datafeed_id: A numerical character string that uniquely identifies the
datafeed.
:param allow_no_match: 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.
: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: The unit used to display time values.
:param v: When set to `true` will enable verbose output.
"""
__path_parts: t.Dict[str, str]
if datafeed_id not in SKIP_IN_PATH:
__path_parts = {"datafeed_id": _quote(datafeed_id)}
__path = f'/_cat/ml/datafeeds/{__path_parts["datafeed_id"]}'
else:
__path_parts = {}
__path = "/_cat/ml/datafeeds"
__query: t.Dict[str, t.Any] = {}
if allow_no_match is not None:
__query["allow_no_match"] = allow_no_match
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 [955:1114]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
datafeed_id: t.Optional[str] = None,
allow_no_match: t.Optional[bool] = 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[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
]
],
t.Union[
str,
t.Literal[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
],
]
] = 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[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
]
],
t.Union[
str,
t.Literal[
"ae",
"bc",
"id",
"na",
"ne",
"ni",
"nn",
"s",
"sba",
"sc",
"seah",
"st",
],
],
]
] = 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 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.
``_
:param datafeed_id: A numerical character string that uniquely identifies the
datafeed.
:param allow_no_match: 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.
: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: The unit used to display time values.
:param v: When set to `true` will enable verbose output.
"""
__path_parts: t.Dict[str, str]
if datafeed_id not in SKIP_IN_PATH:
__path_parts = {"datafeed_id": _quote(datafeed_id)}
__path = f'/_cat/ml/datafeeds/{__path_parts["datafeed_id"]}'
else:
__path_parts = {}
__path = "/_cat/ml/datafeeds"
__query: t.Dict[str, t.Any] = {}
if allow_no_match is not None:
__query["allow_no_match"] = allow_no_match
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"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -