actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fix /cluster/stats in a backwards compatible way (#851)

Browse Source 
* 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:
Daniel (dB.) Doubrovkine
2024-11-25 14:54:03 -08:00
committed by GitHub
parent 12c379d32d
commit bf9add4eed
59 changed files with 9023 additions and 4389 deletions
Download Patch File Download Diff File Expand all files Collapse all files
opensearchpy/client/__init__.py
+521 -340
View File
File diff suppressed because it is too large Load Diff
opensearchpy/client/cat.py
+270 -224
View File
@@ -61,30 +61,31 @@ class CatClient(NamespacedClient):
headers: Any = None,
) -> Any:
"""
Shows information about currently configured aliases to indices including
filter and routing infos.
Shows information about currently configured aliases to indexes including
filter and routing info.
:arg name: A comma-separated list of aliases to retrieve.
Supports wildcards (`*`). To retrieve all aliases, omit this parameter
or use `*` or `_all`.
:arg error_trace: Whether to include the stack trace of returned
errors.
errors. Default is false.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all,
closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
concrete indexes that are open, closed or both.
: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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -120,17 +121,19 @@ class CatClient(NamespacedClient):
:arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. 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 s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -175,22 +178,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -231,22 +236,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -277,24 +284,26 @@ class CatClient(NamespacedClient):
) -> Any:
"""
Provides quick access to the document count of the entire cluster, or
individual indices.
individual indexes.
:arg index: Comma-separated list of data streams, indices, and
:arg index: Comma-separated list of data streams, indexes, and
aliases used to limit the request. Supports wildcards (`*`). To target
all data streams and indices, omit this parameter or use `*` or `_all`.
all data streams and indexes, omit this parameter or use `*` or `_all`.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. 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 s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -325,7 +334,7 @@ class CatClient(NamespacedClient):
headers: Any = None,
) -> Any:
"""
Shows how much heap memory is currently being used by fielddata on every data
Shows how much heap memory is currently being used by field data on every data
node in the cluster.
@@ -334,17 +343,19 @@ class CatClient(NamespacedClient):
:arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. 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 s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -382,25 +393,27 @@ class CatClient(NamespacedClient):
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. 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 s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
:arg time: The unit used to display time values. Valid choices
are d, h, m, micros, ms, nanos, s.
:arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
Default is True.
:arg ts: If `true`, returns `HH:MM:SS` and Unix epoch
timestamps. Default is True.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
@@ -418,13 +431,15 @@ class CatClient(NamespacedClient):
: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.
"""
@@ -460,43 +475,45 @@ class CatClient(NamespacedClient):
headers: Any = None,
) -> Any:
"""
Returns information about indices: number of primaries and replicas, document
Returns information about indexes: number of primaries and replicas, document
counts, disk size, ...
:arg index: Comma-separated list of data streams, indices, and
:arg index: Comma-separated list of data streams, indexes, and
aliases used to limit the request. Supports wildcards (`*`). To target
all data streams and indices, omit this parameter or use `*` or `_all`.
all data streams and indexes, omit this parameter or use `*` or `_all`.
:arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned
errors.
errors. Default is false.
:arg expand_wildcards: The type of index that wildcard patterns
can match. Valid choices are all, closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
can match.
: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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg health: The health status used to limit returned indices.
By default, the response includes indices of any health status. Valid
:arg health: The health status used to limit returned indexes.
By default, the response includes indexes of any health status. Valid
choices are green, red, yellow.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
:arg include_unloaded_segments: If true, the response includes
statistics. Default is True.
:arg include_unloaded_segments: If `true`, the response includes
information from segments that are not loaded into memory. Default is
false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg pri: If true, the response only includes information from
response. Default is false.
:arg pri: If `true`, the response only includes information from
primary shards. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
@@ -537,22 +554,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -562,7 +581,7 @@ class CatClient(NamespacedClient):
from warnings import warn
warn(
"Deprecated: To promote inclusive language, please use '/_cat/cluster_manager' instead."
"Deprecated: To promote inclusive language, use '/_cat/cluster_manager' instead."
)
return self.transport.perform_request(
"GET", "/_cat/master", params=params, headers=headers
@@ -595,22 +614,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -653,25 +674,27 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg full_id: If `true`, return the full node ID. If `false`,
return the shortened node ID. Default is false.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local (Deprecated: This parameter does not cause this API
to act locally.): Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -712,22 +735,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -766,17 +791,19 @@ class CatClient(NamespacedClient):
:arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. 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 s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -814,22 +841,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -875,17 +904,19 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. 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 s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -925,22 +956,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -989,9 +1022,9 @@ class CatClient(NamespacedClient):
names to limit the returned information.
:arg active_only: If `true`, the response only includes ongoing
segment replication events. Default is false.
:arg allow_no_indices: Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified).
:arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indexes. (This includes `_all`
string or when no indexes have been specified).
:arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg completed_only: If `true`, the response only includes
@@ -999,24 +1032,25 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed
information about segment replications. Default is false.
:arg error_trace: Whether to include the stack trace of returned
errors.
errors. Default is false.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all,
closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
concrete indexes that are open, closed or both.
: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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg ignore_throttled: Whether specified concrete, expanded or
aliased indices should be ignored when throttled.
:arg ignore_unavailable: Whether specified concrete indices
aliased indexes should be ignored when throttled.
:arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed).
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg shards: Comma-separated list of shards to display.
@@ -1059,28 +1093,30 @@ class CatClient(NamespacedClient):
Provides low-level information about the segments in the shards of an index.
:arg index: A comma-separated list of data streams, indices, and
:arg index: A comma-separated list of data streams, indexes, and
aliases used to limit the request. Supports wildcards (`*`). To target
all data streams and indices, omit this parameter or use `*` or `_all`.
all data streams and indexes, omit this parameter or use `*` or `_all`.
:arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -1118,30 +1154,32 @@ class CatClient(NamespacedClient):
Provides a detailed view of shard allocation on nodes.
:arg index: A comma-separated list of data streams, indices, and
:arg index: A comma-separated list of data streams, indexes, and
aliases used to limit the request. Supports wildcards (`*`). To target
all data streams and indices, omit this parameter or use `*` or `_all`.
all data streams and indexes, omit this parameter or use `*` or `_all`.
:arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -1186,22 +1224,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg size: The multiplier in which to display values.
@@ -1249,22 +1289,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg ignore_unavailable: If `true`, the response does not
include information from unavailable snapshots. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -1312,15 +1354,17 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
@@ -1328,7 +1372,7 @@ class CatClient(NamespacedClient):
:arg parent_task_id: The parent task identifier, which is used
to limit the response.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
@@ -1371,22 +1415,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 format: A short version of the Accept header, e.g. json,
yaml.
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 format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON
response.
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg source: The URL-encoded request definition. Useful for
opensearchpy/client/cluster.py
+223 -170
View File
@@ -70,35 +70,36 @@ class ClusterClient(NamespacedClient):
Returns basic information about the health of the cluster.
:arg index: Comma-separated list of data streams, indices, and
:arg index: Comma-separated list of data streams, indexes, and
index aliases used to limit the request. Wildcard expressions (*) are
supported. To target all data streams and indices in a cluster, omit
supported. To target all data streams and indexes in a cluster, omit
this parameter or use `_all` or `*`.
:arg awareness_attribute: The awareness attribute for which the
health is required.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned
errors.
errors. Default is false.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all,
closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
concrete indexes that are open, closed or both.
: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.
:arg level: Can be one of cluster, indices or shards. Controls
statistics. Default is True.
:arg level: Can be one of cluster, indexes or shards. Controls
the details level of the health information returned. Valid choices are
awareness_attributes, cluster, indices, shards.
:arg local: If true, the request retrieves information from the
local node only. Defaults to false, which means information is retrieved
from the master node. Default is false.
:arg local: If `true`, the request retrieves information from
the local node only. Defaults to false, which means information is
retrieved from the cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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
@@ -111,11 +112,11 @@ class ClusterClient(NamespacedClient):
normal, low, languid. Wait until all currently queued events with the
given priority are processed. Valid choices are high, immediate,
languid, low, normal, urgent.
:arg wait_for_no_initializing_shards: A boolean value which
:arg wait_for_no_initializing_shards: A Boolean value which
controls whether to wait (until the timeout provided) for the cluster to
have no shard initializations. Defaults to false, which means it will
not wait for initializing shards.
:arg wait_for_no_relocating_shards: A boolean value which
:arg wait_for_no_relocating_shards: A Boolean value which
controls whether to wait (until the timeout provided) for the cluster to
have no shard relocations. Defaults to false, which means it will not
wait for relocating shards.
@@ -158,20 +159,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 local: If `true`, the request retrieves information from
the local node only. If `false`, information is retrieved from the
master node. Default is false.
cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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.
"""
@@ -209,38 +212,39 @@ class ClusterClient(NamespacedClient):
:arg metric: Limit the information returned to the specified
metrics
:arg index: A comma-separated list of index names; use `_all` or
empty string to perform the operation on all indices
:arg allow_no_indices: Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified)
empty string to perform the operation on all indexes
:arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indexes. (This includes `_all`
string or when no indexes have been specified)
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned
errors.
errors. Default is false.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all,
closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
concrete indexes that are open, closed or both.
: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: Return settings in flat format. Default is
false.
:arg human: Whether to return human readable values for
statistics.
:arg ignore_unavailable: Whether specified concrete indices
statistics. Default is True.
:arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed)
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection
to master
use `cluster_manager_timeout` instead.): Specify timeout for connection
to cluster manager.
: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 wait_for_metadata_version: Wait for the metadata version to
be equal or greater than the specified metadata version
be equal or greater than the specified metadata version.
:arg wait_for_timeout: The maximum time to wait for
wait_for_metadata_version before timing out
`wait_for_metadata_version` before timing out.
"""
if index and metric in SKIP_IN_PATH:
metric = "_all"
@@ -266,23 +270,32 @@ class ClusterClient(NamespacedClient):
node_id: Any = None,
params: Any = None,
headers: Any = None,
metric: Any = None,
index_metric: Any = None,
) -> Any:
"""
Returns high-level overview of cluster statistics.
:arg metric: Limit the information returned to the specified
metrics.
: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 node_id: Comma-separated list of node filters used to limit
returned information. Defaults to all nodes in the cluster.
: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 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 each node to respond. If a node
@@ -295,7 +308,9 @@ class ClusterClient(NamespacedClient):
(
"/_cluster/stats"
if node_id in SKIP_IN_PATH
else _make_path("_cluster", "stats", "nodes", node_id)
else _make_path(
"_cluster", "stats", metric, index_metric, "nodes", node_id
)
),
params=params,
headers=headers,
@@ -329,25 +344,27 @@ class ClusterClient(NamespacedClient):
`cancel`, `allocate`)
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg dry_run: If true, then the request simulates the operation
only and returns the resulting state.
:arg dry_run: If `true`, then the request simulates the
operation only and returns the resulting state.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg explain: If true, then the response contains an explanation
of why the commands can or cannot be executed.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
errors. Default is false.
:arg explain: If `true`, then the response contains an
explanation of why the commands can or cannot be executed.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
:arg metric: Limits the information returned to the specified
metrics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg retry_failed: If true, then retries allocation of shards
response. Default is false.
:arg retry_failed: If `true`, then retries allocation of shards
that are blocked due to too many subsequent allocation failures.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
@@ -383,21 +400,23 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 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 include_defaults: If `true`, returns default cluster
settings from the local node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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
@@ -434,18 +453,20 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 flat_settings: Return settings in flat format. Default is
false.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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: Explicit operation timeout
@@ -468,13 +489,15 @@ class ClusterClient(NamespacedClient):
: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.
"""
@@ -504,17 +527,19 @@ class ClusterClient(NamespacedClient):
:arg body: The index, shard, and primary flag to explain. Empty
means 'explain the first unassigned shard'
: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.
:arg include_disk_info: If true, returns information about disk
usage and shard sizes. Default is false.
:arg include_yes_decisions: If true, returns YES decisions in
statistics. Default is True.
:arg include_disk_info: If `true`, returns information about
disk usage and shard sizes. Default is false.
:arg include_yes_decisions: If `true`, returns YES decisions in
explanation. Default is false.
: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.
"""
@@ -551,17 +576,19 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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
@@ -603,20 +630,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 local: If `true`, the request retrieves information from
the local node only. If `false`, information is retrieved from the
master node. Default is false.
cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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.
"""
@@ -653,7 +682,7 @@ class ClusterClient(NamespacedClient):
includes the following built-in component templates: `logs-mappings`;
'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-
mapping`; `synthetics-settings`. OpenSearch Agent uses these templates
to configure backing indices for its data streams. If you use OpenSearch
to configure backing indexes for its data streams. If you use OpenSearch
Agent and want to overwrite one of these templates, set the `version`
for your replacement template higher than the current version. If you
don't use OpenSearch Agent and want to disable all built-in component
@@ -665,17 +694,19 @@ class ClusterClient(NamespacedClient):
:arg create: If `true`, this request cannot replace or update
existing component templates. Default is false.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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: Operation timeout.
@@ -717,20 +748,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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.
:arg local: If true, the request retrieves information from the
local node only. Defaults to false, which means information is retrieved
from the master node. Default is false.
statistics. Default is True.
:arg local: If `true`, the request retrieves information from
the local node only. Defaults to false, which means information is
retrieved from the cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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.
"""
@@ -757,20 +790,22 @@ class ClusterClient(NamespacedClient):
: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 wait_for_removal: Specifies whether to wait for all
excluded nodes to be removed from the cluster before clearing the voting
configuration exclusions list. Defaults to true, meaning that all
excluded nodes must be removed from the cluster before this API takes
any action. If set to false then the voting configuration exclusions
any action. If set to `false` then the voting configuration exclusions
list is cleared even if some excluded nodes are still in the cluster.
Default is True.
"""
@@ -801,19 +836,21 @@ class ClusterClient(NamespacedClient):
: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 node_ids: A comma-separated list of the persistent ids of
the nodes to exclude from the voting configuration. If specified, you
may not also specify node_names.
may not also specify `node_names`.
:arg node_names: A comma-separated list of the names of the
nodes to exclude from the voting configuration. If specified, you may
not also specify node_ids.
not also specify `node_ids`.
: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: When adding a voting configuration exclusion, the
@@ -837,13 +874,15 @@ class ClusterClient(NamespacedClient):
: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.
"""
@@ -854,6 +893,7 @@ class ClusterClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_weighted_routing(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
@@ -862,13 +902,15 @@ class ClusterClient(NamespacedClient):
: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.
"""
@@ -877,6 +919,7 @@ class ClusterClient(NamespacedClient):
"/_cluster/routing/awareness/weights",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
@@ -892,13 +935,15 @@ class ClusterClient(NamespacedClient):
:arg awareness_attribute_name: Awareness attribute name.
: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.
"""
@@ -933,13 +978,15 @@ class ClusterClient(NamespacedClient):
:arg attribute: Awareness attribute name.
: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.
"""
@@ -968,13 +1015,15 @@ class ClusterClient(NamespacedClient):
:arg awareness_attribute_name: Awareness attribute name.
:arg awareness_attribute_value: Awareness attribute value.
: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.
"""
@@ -999,6 +1048,7 @@ class ClusterClient(NamespacedClient):
def put_weighted_routing(
self,
attribute: Any,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
@@ -1008,13 +1058,15 @@ class ClusterClient(NamespacedClient):
:arg attribute: Awareness attribute name.
: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.
"""
@@ -1026,4 +1078,5 @@ class ClusterClient(NamespacedClient):
_make_path("_cluster", "routing", "awareness", attribute, "weights"),
params=params,
headers=headers,
body=body,
)
opensearchpy/client/dangling_indices.py
+32 -26
View File
@@ -61,25 +61,27 @@ class DanglingIndicesClient(NamespacedClient):
Deletes the specified dangling index.
:arg index_uuid: The UUID of the dangling index
:arg index_uuid: The UUID of the dangling index.
:arg accept_data_loss: Must be set to true in order to delete
the dangling index
the dangling index.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection
to master
use `cluster_manager_timeout` instead.): Specify timeout for connection
to cluster manager.
: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: Explicit operation timeout
:arg timeout: Explicit operation timeout.
"""
if index_uuid in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -112,25 +114,27 @@ class DanglingIndicesClient(NamespacedClient):
Imports the specified dangling index.
:arg index_uuid: The UUID of the dangling index
:arg index_uuid: The UUID of the dangling index.
:arg accept_data_loss: Must be set to true in order to import
the dangling index
the dangling index.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection
to master
use `cluster_manager_timeout` instead.): Specify timeout for connection
to cluster manager.
: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: Explicit operation timeout
:arg timeout: Explicit operation timeout.
"""
if index_uuid in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -146,17 +150,19 @@ class DanglingIndicesClient(NamespacedClient):
headers: Any = None,
) -> Any:
"""
Returns all dangling indices.
Returns all dangling indexes.
: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.
"""
opensearchpy/client/indices.py
+566 -479
View File
File diff suppressed because it is too large Load Diff
opensearchpy/client/ingest.py
+46 -35
View File
@@ -65,17 +65,19 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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.
"""
@@ -109,17 +111,19 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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
@@ -164,17 +168,19 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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
@@ -207,13 +213,15 @@ class IngestClient(NamespacedClient):
:arg id: Pipeline to test. If you don't specify a `pipeline` in
the request body, this parameter is required.
: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 verbose: If `true`, the response includes output data for
@@ -230,7 +238,7 @@ class IngestClient(NamespacedClient):
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
@query_params("error_trace", "filter_path", "human", "pretty", "s", "source")
def processor_grok(
self,
params: Any = None,
@@ -241,13 +249,16 @@ class IngestClient(NamespacedClient):
: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 s: Sort returned patterns by key name. Default is false.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
opensearchpy/client/insights.py
+51
View File
@@ -0,0 +1,51 @@
# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# ------------------------------------------------------------------------------------------
# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST
#
# To contribute, kindly make modifications in the opensearch-py client generator
# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md
# and https://github.com/opensearch-project/opensearch-api-specification for details.
# -----------------------------------------------------------------------------------------+
from typing import Any
from .utils import NamespacedClient, query_params
class InsightsClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def top_queries(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves the top queries based on the given metric type (latency, CPU, or
memory).
:arg error_trace: Whether to include the stack trace of returned
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. Default is True.
:arg pretty: Whether to pretty format the returned JSON
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.
"""
return self.transport.perform_request(
"GET", "/_insights/top_queries", params=params, headers=headers
)
opensearchpy/client/list.py
+211
View File
@@ -0,0 +1,211 @@
# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# ------------------------------------------------------------------------------------------
# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST
#
# To contribute, kindly make modifications in the opensearch-py client generator
# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md
# and https://github.com/opensearch-project/opensearch-api-specification for details.
# -----------------------------------------------------------------------------------------+
from typing import Any
from .utils import NamespacedClient, _make_path, query_params
class ListClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def help(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Returns help for the List APIs.
:arg error_trace: Whether to include the stack trace of returned
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. Default is True.
:arg pretty: Whether to pretty format the returned JSON
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.
"""
return self.transport.perform_request(
"GET", "/_list", params=params, headers=headers
)
@query_params(
"bytes",
"cluster_manager_timeout",
"error_trace",
"expand_wildcards",
"filter_path",
"format",
"h",
"health",
"help",
"human",
"include_unloaded_segments",
"local",
"master_timeout",
"next_token",
"pretty",
"pri",
"s",
"size",
"sort",
"source",
"time",
"v",
)
def indices(
self,
index: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Returns paginated information about indexes including number of primaries and
replicas, document counts, disk size.
:arg index: Comma-separated list of data streams, indexes, and
aliases used to limit the request. Supports wildcards (`*`). To target
all data streams and indexes, omit this parameter or use `*` or `_all`.
:arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned
errors. Default is false.
:arg expand_wildcards: The type of index that wildcard patterns
can match.
: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 format: A short version of the Accept header, such as
`JSON`, `YAML`.
:arg h: Comma-separated list of column names to display.
:arg health: The health status used to limit returned indexes.
By default, the response includes indexes of any health status. Valid
choices are green, red, yellow.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics. Default is True.
:arg include_unloaded_segments: If `true`, the response includes
information from segments that are not loaded into memory. Default is
false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg next_token: Token to retrieve next page of indexes.
:arg pretty: Whether to pretty format the returned JSON
response. Default is false.
:arg pri: If `true`, the response only includes information from
primary shards. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg size: Maximum number of indexes to be displayed in a page.
:arg sort: Defines order in which indexes will be displayed.
Accepted values are `asc` and `desc`. If `desc`, most recently created
indexes would be displayed first. Valid choices are asc, desc.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
:arg time: The unit used to display time values. Valid choices
are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_list", "indices", index), params=params, headers=headers
)
@query_params(
"bytes",
"cluster_manager_timeout",
"error_trace",
"filter_path",
"format",
"h",
"help",
"human",
"local",
"master_timeout",
"next_token",
"pretty",
"s",
"size",
"sort",
"source",
"time",
"v",
)
def shards(
self,
index: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Returns paginated details of shard allocation on nodes.
:arg index: A comma-separated list of data streams, indexes, and
aliases used to limit the request. Supports wildcards (`*`). To target
all data streams and indexes, omit this parameter or use `*` or `_all`.
:arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned
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 format: A short version of the Accept header, such as
`JSON`, `YAML`.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for
statistics. Default is True.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use `cluster_manager_timeout` instead.): Operation timeout for
connection to cluster-manager node.
:arg next_token: Token to retrieve next page of shards.
:arg pretty: Whether to pretty format the returned JSON
response. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg size: Maximum number of shards to be displayed in a page.
:arg sort: Defines order in which shards will be displayed.
Accepted values are `asc` and `desc`. If `desc`, most recently created
shards would be displayed first. Valid choices are asc, desc.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
:arg time: The unit in which to display time values. Valid
choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_list", "shards", index), params=params, headers=headers
)
opensearchpy/client/nodes.py
+49 -35
View File
@@ -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
opensearchpy/client/plugins.py
+28 -5
View File
@@ -11,6 +11,8 @@ import warnings
from typing import Any
from ..plugins.alerting import AlertingClient
from ..plugins.asynchronous_search import AsynchronousSearchClient
from ..plugins.flow_framework import FlowFrameworkClient
from ..plugins.index_management import IndexManagementClient
from ..plugins.knn import KnnClient
from ..plugins.ml import MlClient
@@ -18,6 +20,7 @@ from ..plugins.notifications import NotificationsClient
from ..plugins.observability import ObservabilityClient
from ..plugins.ppl import PplClient
from ..plugins.query import QueryClient
from ..plugins.replication import ReplicationClient
from ..plugins.rollups import RollupsClient
from ..plugins.sql import SqlClient
from ..plugins.transforms import TransformsClient
@@ -26,12 +29,25 @@ from .utils import NamespacedClient
class PluginsClient(NamespacedClient):
asynchronous_search: Any
alerting: Any
index_management: Any
knn: Any
ml: Any
notifications: Any
observability: Any
ppl: Any
query: Any
rollups: Any
sql: Any
transforms: Any
def __init__(self, client: Client) -> None:
super().__init__(client)
self.replication = ReplicationClient(client)
self.flow_framework = FlowFrameworkClient(client)
self.asynchronous_search = AsynchronousSearchClient(client)
self.alerting = AlertingClient(client)
self.index_management = IndexManagementClient(client)
self.knn = KnnClient(client)
@@ -50,13 +66,20 @@ class PluginsClient(NamespacedClient):
# Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742
plugins = [
# "query_workbench",
# "reporting",
# "notebooks",
"replication",
"flow_framework",
"asynchronous_search",
"alerting",
# "anomaly_detection",
# "trace_analytics",
"index_management",
"knn",
"ml",
"notifications",
"observability",
"ppl",
"query",
"rollups",
"sql",
"transforms",
]
for plugin in plugins:
if not hasattr(client, plugin):
opensearchpy/client/remote_store.py
+7 -5
View File
@@ -45,13 +45,15 @@ class RemoteStoreClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 wait_for_completion: Should this request wait until the
opensearchpy/client/search_pipeline.py
+21 -15
View File
@@ -45,13 +45,15 @@ class SearchPipelineClient(NamespacedClient):
:arg cluster_manager_timeout: operation timeout for connection
to cluster-manager node.
: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.
"""
@@ -82,13 +84,15 @@ class SearchPipelineClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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: Operation timeout.
@@ -127,13 +131,15 @@ class SearchPipelineClient(NamespacedClient):
:arg cluster_manager_timeout: operation timeout for connection
to cluster-manager node.
: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: Operation timeout.
opensearchpy/client/security.py
+551 -397
View File
File diff suppressed because it is too large Load Diff
opensearchpy/client/snapshot.py
+112 -90
View File
@@ -69,17 +69,19 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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 wait_for_completion: If `true`, the request returns a
@@ -123,16 +125,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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.
"""
@@ -172,31 +176,33 @@ class SnapshotClient(NamespacedClient):
:arg repository: Comma-separated list of snapshot repository
names used to limit the request. Wildcard (*) expressions are supported.
:arg snapshot: Comma-separated list of snapshot names to
retrieve. Also accepts wildcards (*). - To get information about all
snapshots in a registered repository, use a wildcard (*) or _all. - To
get information about any snapshots that are currently running, use
_current.
retrieve. Also accepts wildcards (`*`). - To get information about all
snapshots in a registered repository, use a wildcard (`*`) or `_all`. -
To get information about any snapshots that are currently running, use
`_current`.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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.
:arg ignore_unavailable: If false, the request returns an error
for any snapshots that are unavailable. Default is false.
statistics. Default is True.
:arg ignore_unavailable: If `false`, the request returns an
error for any snapshots that are unavailable. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout
expires, the request fails and returns an error.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node. If no response is received before the
timeout expires, the request fails and returns an error.
: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 verbose: If true, returns additional information about each
snapshot such as the version of OpenSearch which took the snapshot, the
start and end times of the snapshot, and the number of shards
:arg verbose: If `true`, returns additional information about
each snapshot such as the version of OpenSearch which took the snapshot,
the start and end times of the snapshot, and the number of shards
snapshotted.
"""
for param in (repository, snapshot):
@@ -235,16 +241,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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: Explicit operation timeout
@@ -283,18 +291,20 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 local: Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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.
"""
@@ -329,16 +339,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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: Explicit operation timeout
@@ -384,16 +396,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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 wait_for_completion: Should this request wait until the
@@ -437,19 +451,21 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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_unavailable: Whether to ignore unavailable
snapshots, defaults to false which means a SnapshotMissingException is
snapshots, defaults to `false` which means a SnapshotMissingException is
thrown Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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.
"""
@@ -484,16 +500,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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: Explicit operation timeout
@@ -532,16 +550,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.
use `cluster_manager_timeout` instead.): Period to wait for a connection
to the cluster-manager node.
: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.
@@ -575,7 +595,7 @@ class SnapshotClient(NamespacedClient):
headers: Any = None,
) -> Any:
"""
Clones indices from one snapshot into another snapshot in the same repository.
Clones indexes from one snapshot into another snapshot in the same repository.
:arg repository: A repository name
@@ -585,16 +605,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
: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 master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for
connection to master node
use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to cluster-manager node
: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.
"""
opensearchpy/client/tasks.py
+21 -15
View File
@@ -69,13 +69,15 @@ class TasksClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false.
: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 group_by: Key used to group tasks in the response. Valid
choices are nodes, none, parents.
:arg human: Whether to return human readable values for
statistics.
statistics. Default is True.
:arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
@@ -84,7 +86,7 @@ class TasksClient(NamespacedClient):
information. To return all tasks, omit this parameter or use a value of
`-1`.
: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
@@ -122,16 +124,18 @@ class TasksClient(NamespacedClient):
:arg actions: Comma-separated list or wildcard expression of
actions used to limit the request.
: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 nodes: Comma-separated list of node IDs or names used to
limit the request.
:arg parent_task_id: Parent task ID used to limit the tasks.
: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 wait_for_completion: Should the request block until the
@@ -166,13 +170,15 @@ class TasksClient(NamespacedClient):
:arg task_id: ID of the task.
: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
opensearchpy/client/wlm.py
+160
View File
@@ -0,0 +1,160 @@
# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# ------------------------------------------------------------------------------------------
# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST
#
# To contribute, kindly make modifications in the opensearch-py client generator
# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md
# and https://github.com/opensearch-project/opensearch-api-specification for details.
# -----------------------------------------------------------------------------------------+
from typing import Any
from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class WlmClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def create_query_group(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Creates a new query group and sets the resource limits for the new query group.
:arg error_trace: Whether to include the stack trace of returned
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. Default is True.
:arg pretty: Whether to pretty format the returned JSON
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.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PUT", "/_wlm/query_group", params=params, headers=headers, body=body
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_query_group(
self,
name: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes the specified query group.
:arg name: The name of the query group.
:arg error_trace: Whether to include the stack trace of returned
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. Default is True.
:arg pretty: Whether to pretty format the returned JSON
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.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'name'.")
return self.transport.perform_request(
"DELETE",
_make_path("_wlm", "query_group", name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def get_query_group(
self,
name: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves the specified query group. If no query group is specified, all query
groups in the cluster are retrieved.
:arg name: The name of the query group.
:arg error_trace: Whether to include the stack trace of returned
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. Default is True.
:arg pretty: Whether to pretty format the returned JSON
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.
"""
return self.transport.perform_request(
"GET",
_make_path("_wlm", "query_group", name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def update_query_group(
self,
name: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Updates the specified query group.
:arg name: The name of the query group.
:arg error_trace: Whether to include the stack trace of returned
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. Default is True.
:arg pretty: Whether to pretty format the returned JSON
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.
"""
for param in (name, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return self.transport.perform_request(
"PUT",
_make_path("_wlm", "query_group", name),
params=params,
headers=headers,
body=body,
)