Fix /cluster/stats in a backwards compatible way (#851)
* Ran nox -s generate. Signed-off-by: dblock <[email protected]> * Fix: backwards compatible parameter order in cluster stats. Signed-off-by: dblock <[email protected]> * Moved Updated APIs section to the correct set. Signed-off-by: dblock <[email protected]> --------- Signed-off-by: dblock <[email protected]>
This commit is contained in:
@@ -52,18 +52,20 @@ class NodesClient(NamespacedClient):
|
||||
Reloads secure settings.
|
||||
|
||||
|
||||
:arg body: An object containing the password for the opensearch
|
||||
keystore
|
||||
:arg body: An object containing the password for the OpenSearch
|
||||
keystore.
|
||||
:arg node_id: The names of particular nodes in the cluster to
|
||||
target.
|
||||
:arg error_trace: Whether to include the stack trace of returned
|
||||
errors.
|
||||
:arg filter_path: Comma-separated list of filters used to reduce
|
||||
the response.
|
||||
errors. Default is false.
|
||||
:arg filter_path: Used to reduce the response. This parameter
|
||||
takes a comma-separated list of filters. It supports using wildcards to
|
||||
match any field or part of a field’s name. You can also exclude fields
|
||||
with "-".
|
||||
:arg human: Whether to return human readable values for
|
||||
statistics.
|
||||
statistics. Default is True.
|
||||
:arg pretty: Whether to pretty format the returned JSON
|
||||
response.
|
||||
response. Default is false.
|
||||
:arg source: The URL-encoded request definition. Useful for
|
||||
libraries that do not accept a request body for non-POST requests.
|
||||
:arg timeout: Period to wait for a response. If no response is
|
||||
@@ -91,6 +93,7 @@ class NodesClient(NamespacedClient):
|
||||
self,
|
||||
node_id: Any = None,
|
||||
metric: Any = None,
|
||||
node_id_or_metric: Any = None,
|
||||
params: Any = None,
|
||||
headers: Any = None,
|
||||
) -> Any:
|
||||
@@ -101,17 +104,22 @@ class NodesClient(NamespacedClient):
|
||||
:arg node_id: Comma-separated list of node IDs or names used to
|
||||
limit returned information.
|
||||
:arg metric: Limits the information returned to the specific
|
||||
metrics. Supports a comma-separated list, such as http,ingest.
|
||||
metrics. Supports a comma-separated list, such as `http,ingest`.
|
||||
:arg node_id_or_metric: Limits the information returned to a
|
||||
list of node IDs or specific metrics. Supports a comma-separated list,
|
||||
such as `node1,node2` or `http,ingest`.
|
||||
:arg error_trace: Whether to include the stack trace of returned
|
||||
errors.
|
||||
:arg filter_path: Comma-separated list of filters used to reduce
|
||||
the response.
|
||||
:arg flat_settings: If true, returns settings in flat format.
|
||||
errors. Default is false.
|
||||
:arg filter_path: Used to reduce the response. This parameter
|
||||
takes a comma-separated list of filters. It supports using wildcards to
|
||||
match any field or part of a field’s name. You can also exclude fields
|
||||
with "-".
|
||||
:arg flat_settings: If `true`, returns settings in flat format.
|
||||
Default is false.
|
||||
:arg human: Whether to return human readable values for
|
||||
statistics.
|
||||
statistics. Default is True.
|
||||
:arg pretty: Whether to pretty format the returned JSON
|
||||
response.
|
||||
response. Default is false.
|
||||
:arg source: The URL-encoded request definition. Useful for
|
||||
libraries that do not accept a request body for non-POST requests.
|
||||
:arg timeout: Period to wait for a response. If no response is
|
||||
@@ -153,31 +161,33 @@ class NodesClient(NamespacedClient):
|
||||
limit returned information.
|
||||
:arg metric: Limit the information returned to the specified
|
||||
metrics
|
||||
:arg index_metric: Limit the information returned for indices
|
||||
metric to the specific index metrics. It can be used only if indices (or
|
||||
:arg index_metric: Limit the information returned for indexes
|
||||
metric to the specific index metrics. It can be used only if indexes (or
|
||||
all) metric is specified.
|
||||
:arg completion_fields: Comma-separated list or wildcard
|
||||
expressions of fields to include in fielddata and suggest statistics.
|
||||
expressions of fields to include in field data and suggest statistics.
|
||||
:arg error_trace: Whether to include the stack trace of returned
|
||||
errors.
|
||||
errors. Default is false.
|
||||
:arg fielddata_fields: Comma-separated list or wildcard
|
||||
expressions of fields to include in fielddata statistics.
|
||||
expressions of fields to include in field data statistics.
|
||||
:arg fields: Comma-separated list or wildcard expressions of
|
||||
fields to include in the statistics.
|
||||
:arg filter_path: Comma-separated list of filters used to reduce
|
||||
the response.
|
||||
:arg filter_path: Used to reduce the response. This parameter
|
||||
takes a comma-separated list of filters. It supports using wildcards to
|
||||
match any field or part of a field’s name. You can also exclude fields
|
||||
with "-".
|
||||
:arg groups: Comma-separated list of search groups to include in
|
||||
the search statistics.
|
||||
:arg human: Whether to return human readable values for
|
||||
statistics.
|
||||
:arg include_segment_file_sizes: If true, the call reports the
|
||||
statistics. Default is True.
|
||||
:arg include_segment_file_sizes: If `true`, the call reports the
|
||||
aggregated disk usage of each one of the Lucene index files (only
|
||||
applies if segment stats are requested). Default is false.
|
||||
:arg level: Indicates whether statistics are aggregated at the
|
||||
cluster, index, or shard level. Valid choices are cluster, indices,
|
||||
shards.
|
||||
:arg pretty: Whether to pretty format the returned JSON
|
||||
response.
|
||||
response. Default is false.
|
||||
:arg source: The URL-encoded request definition. Useful for
|
||||
libraries that do not accept a request body for non-POST requests.
|
||||
:arg timeout: Period to wait for a response. If no response is
|
||||
@@ -223,18 +233,20 @@ class NodesClient(NamespacedClient):
|
||||
:arg doc_type: The type to sample. Valid choices are block, cpu,
|
||||
wait.
|
||||
:arg error_trace: Whether to include the stack trace of returned
|
||||
errors.
|
||||
:arg filter_path: Comma-separated list of filters used to reduce
|
||||
the response.
|
||||
errors. Default is false.
|
||||
:arg filter_path: Used to reduce the response. This parameter
|
||||
takes a comma-separated list of filters. It supports using wildcards to
|
||||
match any field or part of a field’s name. You can also exclude fields
|
||||
with "-".
|
||||
:arg human: Whether to return human readable values for
|
||||
statistics.
|
||||
statistics. Default is True.
|
||||
:arg ignore_idle_threads: Don't show threads that are in known-
|
||||
idle places, such as waiting on a socket select or pulling from an empty
|
||||
task queue. Default is True.
|
||||
:arg interval: The interval for the second sampling of threads.
|
||||
:arg pretty: Whether to pretty format the returned JSON
|
||||
response.
|
||||
:arg snapshots: Number of samples of thread stacktrace. Default
|
||||
response. Default is false.
|
||||
:arg snapshots: Number of samples of thread stack trace. Default
|
||||
is 10.
|
||||
:arg source: The URL-encoded request definition. Useful for
|
||||
libraries that do not accept a request body for non-POST requests.
|
||||
@@ -273,13 +285,15 @@ class NodesClient(NamespacedClient):
|
||||
metrics. A comma-separated list of the following options: `_all`,
|
||||
`rest_actions`.
|
||||
:arg error_trace: Whether to include the stack trace of returned
|
||||
errors.
|
||||
:arg filter_path: Comma-separated list of filters used to reduce
|
||||
the response.
|
||||
errors. Default is false.
|
||||
:arg filter_path: Used to reduce the response. This parameter
|
||||
takes a comma-separated list of filters. It supports using wildcards to
|
||||
match any field or part of a field’s name. You can also exclude fields
|
||||
with "-".
|
||||
:arg human: Whether to return human readable values for
|
||||
statistics.
|
||||
statistics. Default is True.
|
||||
:arg pretty: Whether to pretty format the returned JSON
|
||||
response.
|
||||
response. Default is false.
|
||||
:arg source: The URL-encoded request definition. Useful for
|
||||
libraries that do not accept a request body for non-POST requests.
|
||||
:arg timeout: Period to wait for a response. If no response is
|
||||
|
||||
Reference in New Issue
Block a user