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 <dblock@amazon.com>

* Fix: backwards compatible parameter order in cluster stats.

Signed-off-by: dblock <dblock@amazon.com>

* Moved Updated APIs section to the correct set.

Signed-off-by: dblock <dblock@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>
This commit is contained in:
Daniel (dB.) Doubrovkine
2024-11-25 17:54:03 -05: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
CHANGELOG.md
+2
View File
@@ -9,6 +9,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Changed ### Changed
### Deprecated ### Deprecated
### Removed ### Removed
### Updated APIs
- Updated opensearch-py APIs to reflect [opensearch-api-specification@4615564](https://github.com/opensearch-project/opensearch-api-specification/commit/4615564b05d410575bb6ed3ed34ea136bf2e4312)
### Fixed ### Fixed
- Fix `Transport.perform_request`'s arguments `timeout` and `ignore` variable usage ([810](https://github.com/opensearch-project/opensearch-py/pull/810)) - Fix `Transport.perform_request`'s arguments `timeout` and `ignore` variable usage ([810](https://github.com/opensearch-project/opensearch-py/pull/810))
- Fix `Index.save` not passing through aliases to the underlying index ([823](https://github.com/opensearch-project/opensearch-py/pull/823)) - Fix `Index.save` not passing through aliases to the underlying index ([823](https://github.com/opensearch-project/opensearch-py/pull/823))
opensearchpy/_async/client/__init__.py
+516 -337
View File
File diff suppressed because it is too large Load Diff
opensearchpy/_async/client/cat.py
+270 -224
View File
@@ -61,30 +61,31 @@ class CatClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Shows information about currently configured aliases to indices including Shows information about currently configured aliases to indexes including
filter and routing infos. filter and routing info.
:arg name: A comma-separated list of aliases to retrieve. :arg name: A comma-separated list of aliases to retrieve.
Supports wildcards (`*`). To retrieve all aliases, omit this parameter Supports wildcards (`*`). To retrieve all aliases, omit this parameter
or use `*` or `_all`. or use `*` or `_all`.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. match any field or part of a field’s name. You can also exclude fields
:arg format: A short version of the Accept header, e.g. json, with "-".
yaml. :arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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 :arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -175,22 +178,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -231,22 +236,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -277,24 +284,26 @@ class CatClient(NamespacedClient):
) -> Any: ) -> Any:
""" """
Provides quick access to the document count of the entire cluster, or 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 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -325,7 +334,7 @@ class CatClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> 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. node in the cluster.
@@ -334,17 +343,19 @@ class CatClient(NamespacedClient):
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg time: The unit used to display time values. Valid choices :arg time: The unit used to display time values. Valid choices
are d, h, m, micros, ms, nanos, s. are d, h, m, micros, ms, nanos, s.
:arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps. :arg ts: If `true`, returns `HH:MM:SS` and Unix epoch
Default is True. timestamps. Default is True.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -418,13 +431,15 @@ class CatClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -460,43 +475,45 @@ class CatClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Returns information about indices: number of primaries and replicas, document Returns information about indexes: number of primaries and replicas, document
counts, disk size, ... 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 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 :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: The type of index that wildcard patterns
can match. Valid choices are all, closed, hidden, none, open. can match.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg health: The health status used to limit returned indices. :arg health: The health status used to limit returned indexes.
By default, the response includes indices of any health status. Valid By default, the response includes indexes of any health status. Valid
choices are green, red, yellow. choices are green, red, yellow.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_unloaded_segments: If true, the response includes :arg include_unloaded_segments: If `true`, the response includes
information from segments that are not loaded into memory. Default is information from segments that are not loaded into memory. Default is
false. false.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg pri: If true, the response only includes information from :arg pri: If `true`, the response only includes information from
primary shards. Default is false. primary shards. Default is false.
:arg s: Comma-separated list of column names or column aliases :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
@@ -537,22 +554,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -562,7 +581,7 @@ class CatClient(NamespacedClient):
from warnings import warn from warnings import warn
warn( warn(
"Deprecated: To promote inclusive language, please use '/_cat/cluster_manager' instead." "Deprecated: To promote inclusive language, use '/_cat/cluster_manager' instead."
) )
return await self.transport.perform_request( return await self.transport.perform_request(
"GET", "/_cat/master", params=params, headers=headers "GET", "/_cat/master", params=params, headers=headers
@@ -595,22 +614,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -653,25 +674,27 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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`, :arg full_id: If `true`, return the full node ID. If `false`,
return the shortened node ID. Default is false. return the shortened node ID. Default is false.
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local (Deprecated: This parameter does not cause this API :arg local (Deprecated: This parameter does not cause this API
to act locally.): Return local information, do not retrieve the state to act locally.): Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -712,22 +735,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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 :arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -814,22 +841,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -875,17 +904,19 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -925,22 +956,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -989,9 +1022,9 @@ class CatClient(NamespacedClient):
names to limit the returned information. names to limit the returned information.
:arg active_only: If `true`, the response only includes ongoing :arg active_only: If `true`, the response only includes ongoing
segment replication events. Default is false. segment replication events. Default is false.
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indexes. (This includes `_all`
string or when no indices have been specified). string or when no indexes have been specified).
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg completed_only: If `true`, the response only includes :arg completed_only: If `true`, the response only includes
@@ -999,24 +1032,25 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about segment replications. Default is false. information about segment replications. Default is false.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. match any field or part of a field’s name. You can also exclude fields
:arg format: A short version of the Accept header, e.g. json, with "-".
yaml. :arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_throttled: Whether specified concrete, expanded or :arg ignore_throttled: Whether specified concrete, expanded or
aliased indices should be ignored when throttled. aliased indexes should be ignored when throttled.
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed). should be ignored when unavailable (missing or closed).
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg shards: Comma-separated list of shards to display. :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. 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 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 :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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. 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 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 :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1186,22 +1224,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg size: The multiplier in which to display values. :arg size: The multiplier in which to display values.
@@ -1249,22 +1289,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: If `true`, the response does not :arg ignore_unavailable: If `true`, the response does not
include information from unavailable snapshots. Default is false. include information from unavailable snapshots. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1312,15 +1354,17 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :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 :arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all 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 :arg parent_task_id: The parent task identifier, which is used
to limit the response. to limit the response.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1371,22 +1415,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
opensearchpy/_async/client/cluster.py
+223 -170
View File
@@ -70,35 +70,36 @@ class ClusterClient(NamespacedClient):
Returns basic information about the health of the cluster. 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 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 `*`. this parameter or use `_all` or `*`.
:arg awareness_attribute: The awareness attribute for which the :arg awareness_attribute: The awareness attribute for which the
health is required. health is required.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg level: Can be one of cluster, indices or shards. Controls :arg level: Can be one of cluster, indexes or shards. Controls
the details level of the health information returned. Valid choices are the details level of the health information returned. Valid choices are
awareness_attributes, cluster, indices, shards. awareness_attributes, cluster, indices, shards.
:arg local: If true, the request retrieves information from the :arg local: If `true`, the request retrieves information from
local node only. Defaults to false, which means information is retrieved the local node only. Defaults to false, which means information is
from the master node. Default is false. retrieved from the cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 normal, low, languid. Wait until all currently queued events with the
given priority are processed. Valid choices are high, immediate, given priority are processed. Valid choices are high, immediate,
languid, low, normal, urgent. 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 controls whether to wait (until the timeout provided) for the cluster to
have no shard initializations. Defaults to false, which means it will have no shard initializations. Defaults to false, which means it will
not wait for initializing shards. 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 controls whether to wait (until the timeout provided) for the cluster to
have no shard relocations. Defaults to false, which means it will not have no shard relocations. Defaults to false, which means it will not
wait for relocating shards. wait for relocating shards.
@@ -158,20 +159,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. If `false`, information is retrieved from the 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, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg metric: Limit the information returned to the specified
metrics metrics
:arg index: A comma-separated list of index names; use `_all` or :arg index: A comma-separated list of index names; use `_all` or
empty string to perform the operation on all indices empty string to perform the operation on all indexes
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indexes. (This includes `_all`
string or when no indices have been specified) string or when no indexes have been specified)
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. 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 :arg flat_settings: Return settings in flat format. Default is
false. false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed) should be ignored when unavailable (missing or closed)
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection use `cluster_manager_timeout` instead.): Specify timeout for connection
to master to cluster manager.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_metadata_version: Wait for the metadata version to :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 :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: if index and metric in SKIP_IN_PATH:
metric = "_all" metric = "_all"
@@ -266,23 +270,32 @@ class ClusterClient(NamespacedClient):
node_id: Any = None, node_id: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
metric: Any = None,
index_metric: Any = None,
) -> Any: ) -> Any:
""" """
Returns high-level overview of cluster statistics. 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 :arg node_id: Comma-separated list of node filters used to limit
returned information. Defaults to all nodes in the cluster. returned information. Defaults to all nodes in the cluster.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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. :arg flat_settings: If `true`, returns settings in flat format.
Default is false. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg timeout: Period to wait for each node to respond. If a node
@@ -295,7 +308,9 @@ class ClusterClient(NamespacedClient):
( (
"/_cluster/stats" "/_cluster/stats"
if node_id in SKIP_IN_PATH 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, params=params,
headers=headers, headers=headers,
@@ -329,25 +344,27 @@ class ClusterClient(NamespacedClient):
`cancel`, `allocate`) `cancel`, `allocate`)
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg dry_run: If true, then the request simulates the operation :arg dry_run: If `true`, then the request simulates the
only and returns the resulting state. operation only and returns the resulting state.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg explain: If true, then the response contains an explanation :arg explain: If `true`, then the response contains an
of why the commands can or cannot be executed. explanation of why the commands can or cannot be executed.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg metric: Limits the information returned to the specified :arg metric: Limits the information returned to the specified
metrics. metrics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg retry_failed: If true, then retries allocation of shards :arg retry_failed: If `true`, then retries allocation of shards
that are blocked due to too many subsequent allocation failures. that are blocked due to too many subsequent allocation failures.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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. :arg flat_settings: If `true`, returns settings in flat format.
Default is false. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_defaults: If `true`, returns default cluster :arg include_defaults: If `true`, returns default cluster
settings from the local node. Default is false. settings from the local node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg flat_settings: Return settings in flat format. Default is
false. false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -468,13 +489,15 @@ class ClusterClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg body: The index, shard, and primary flag to explain. Empty
means 'explain the first unassigned shard' means 'explain the first unassigned shard'
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_disk_info: If true, returns information about disk :arg include_disk_info: If `true`, returns information about
usage and shard sizes. Default is false. disk usage and shard sizes. Default is false.
:arg include_yes_decisions: If true, returns YES decisions in :arg include_yes_decisions: If `true`, returns YES decisions in
explanation. Default is false. explanation. Default is false.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. If `false`, information is retrieved from the 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, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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`; includes the following built-in component templates: `logs-mappings`;
'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics- 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-
mapping`; `synthetics-settings`. OpenSearch Agent uses these templates 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` Agent and want to overwrite one of these templates, set the `version`
for your replacement template higher than the current version. If you for your replacement template higher than the current version. If you
don't use OpenSearch Agent and want to disable all built-in component 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 :arg create: If `true`, this request cannot replace or update
existing component templates. Default is false. existing component templates. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
@@ -717,20 +748,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: If true, the request retrieves information from the :arg local: If `true`, the request retrieves information from
local node only. Defaults to false, which means information is retrieved the local node only. Defaults to false, which means information is
from the master node. Default is false. retrieved from the cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_removal: Specifies whether to wait for all :arg wait_for_removal: Specifies whether to wait for all
excluded nodes to be removed from the cluster before clearing the voting excluded nodes to be removed from the cluster before clearing the voting
configuration exclusions list. Defaults to true, meaning that all configuration exclusions list. Defaults to true, meaning that all
excluded nodes must be removed from the cluster before this API takes 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. list is cleared even if some excluded nodes are still in the cluster.
Default is True. Default is True.
""" """
@@ -801,19 +836,21 @@ class ClusterClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :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 :arg node_ids: A comma-separated list of the persistent ids of
the nodes to exclude from the voting configuration. If specified, you 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 :arg node_names: A comma-separated list of the names of the
nodes to exclude from the voting configuration. If specified, you may 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 :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: When adding a voting configuration exclusion, the :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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") @query_params("error_trace", "filter_path", "human", "pretty", "source")
async def delete_weighted_routing( async def delete_weighted_routing(
self, self,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -862,13 +902,15 @@ class ClusterClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -877,6 +919,7 @@ class ClusterClient(NamespacedClient):
"/_cluster/routing/awareness/weights", "/_cluster/routing/awareness/weights",
params=params, params=params,
headers=headers, headers=headers,
body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
@@ -892,13 +935,15 @@ class ClusterClient(NamespacedClient):
:arg awareness_attribute_name: Awareness attribute name. :arg awareness_attribute_name: Awareness attribute name.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 attribute: Awareness attribute name.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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_name: Awareness attribute name.
:arg awareness_attribute_value: Awareness attribute value. :arg awareness_attribute_value: Awareness attribute value.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -999,6 +1048,7 @@ class ClusterClient(NamespacedClient):
async def put_weighted_routing( async def put_weighted_routing(
self, self,
attribute: Any, attribute: Any,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -1008,13 +1058,15 @@ class ClusterClient(NamespacedClient):
:arg attribute: Awareness attribute name. :arg attribute: Awareness attribute name.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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"), _make_path("_cluster", "routing", "awareness", attribute, "weights"),
params=params, params=params,
headers=headers, headers=headers,
body=body,
) )
opensearchpy/_async/client/dangling_indices.py
+32 -26
View File
@@ -61,25 +61,27 @@ class DanglingIndicesClient(NamespacedClient):
Deletes the specified dangling index. 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 :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection use `cluster_manager_timeout` instead.): Specify timeout for connection
to master to cluster manager.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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: if index_uuid in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index_uuid'.") raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -112,25 +114,27 @@ class DanglingIndicesClient(NamespacedClient):
Imports the specified dangling index. 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 :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection use `cluster_manager_timeout` instead.): Specify timeout for connection
to master to cluster manager.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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: if index_uuid in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index_uuid'.") raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -146,17 +150,19 @@ class DanglingIndicesClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Returns all dangling indices. Returns all dangling indexes.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/client/indices.py
+566 -479
View File
File diff suppressed because it is too large Load Diff
opensearchpy/_async/client/ingest.py
+46 -35
View File
@@ -65,17 +65,19 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg id: Pipeline to test. If you don't specify a `pipeline` in
the request body, this parameter is required. the request body, this parameter is required.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg verbose: If `true`, the response includes output data for :arg verbose: If `true`, the response includes output data for
@@ -230,7 +238,7 @@ class IngestClient(NamespacedClient):
body=body, body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "s", "source")
async def processor_grok( async def processor_grok(
self, self,
params: Any = None, params: Any = None,
@@ -241,13 +249,16 @@ class IngestClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/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")
async 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 await self.transport.perform_request(
"GET", "/_insights/top_queries", params=params, headers=headers
)
opensearchpy/_async/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")
async 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 await 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",
)
async 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 await 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",
)
async 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 await self.transport.perform_request(
"GET", _make_path("_list", "shards", index), params=params, headers=headers
)
opensearchpy/_async/client/nodes.py
+49 -35
View File
@@ -52,18 +52,20 @@ class NodesClient(NamespacedClient):
Reloads secure settings. Reloads secure settings.
:arg body: An object containing the password for the opensearch :arg body: An object containing the password for the OpenSearch
keystore keystore.
:arg node_id: The names of particular nodes in the cluster to :arg node_id: The names of particular nodes in the cluster to
target. target.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
@@ -91,6 +93,7 @@ class NodesClient(NamespacedClient):
self, self,
node_id: Any = None, node_id: Any = None,
metric: Any = None, metric: Any = None,
node_id_or_metric: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -101,17 +104,22 @@ class NodesClient(NamespacedClient):
:arg node_id: Comma-separated list of node IDs or names used to :arg node_id: Comma-separated list of node IDs or names used to
limit returned information. limit returned information.
:arg metric: Limits the information returned to the specific :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg flat_settings: If true, returns settings in flat format. 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. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
@@ -153,31 +161,33 @@ class NodesClient(NamespacedClient):
limit returned information. limit returned information.
:arg metric: Limit the information returned to the specified :arg metric: Limit the information returned to the specified
metrics metrics
:arg index_metric: Limit the information returned for indices :arg index_metric: Limit the information returned for indexes
metric to the specific index metrics. It can be used only if indices (or metric to the specific index metrics. It can be used only if indexes (or
all) metric is specified. all) metric is specified.
:arg completion_fields: Comma-separated list or wildcard :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg fielddata_fields: Comma-separated list or wildcard :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 :arg fields: Comma-separated list or wildcard expressions of
fields to include in the statistics. fields to include in the statistics.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg groups: Comma-separated list of search groups to include in
the search statistics. the search statistics.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_segment_file_sizes: If true, the call reports the :arg include_segment_file_sizes: If `true`, the call reports the
aggregated disk usage of each one of the Lucene index files (only aggregated disk usage of each one of the Lucene index files (only
applies if segment stats are requested). Default is false. applies if segment stats are requested). Default is false.
:arg level: Indicates whether statistics are aggregated at the :arg level: Indicates whether statistics are aggregated at the
cluster, index, or shard level. Valid choices are cluster, indices, cluster, index, or shard level. Valid choices are cluster, indices,
shards. shards.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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, :arg doc_type: The type to sample. Valid choices are block, cpu,
wait. wait.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :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- :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 idle places, such as waiting on a socket select or pulling from an empty
task queue. Default is True. task queue. Default is True.
:arg interval: The interval for the second sampling of threads. :arg interval: The interval for the second sampling of threads.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg snapshots: Number of samples of thread stacktrace. Default :arg snapshots: Number of samples of thread stack trace. Default
is 10. is 10.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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`, metrics. A comma-separated list of the following options: `_all`,
`rest_actions`. `rest_actions`.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
opensearchpy/_async/client/plugins.py
+10
View File
@@ -11,6 +11,8 @@ import warnings
from typing import Any from typing import Any
from ..plugins.alerting import AlertingClient 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.index_management import IndexManagementClient
from ..plugins.knn import KnnClient from ..plugins.knn import KnnClient
from ..plugins.ml import MlClient from ..plugins.ml import MlClient
@@ -18,6 +20,7 @@ from ..plugins.notifications import NotificationsClient
from ..plugins.observability import ObservabilityClient from ..plugins.observability import ObservabilityClient
from ..plugins.ppl import PplClient from ..plugins.ppl import PplClient
from ..plugins.query import QueryClient from ..plugins.query import QueryClient
from ..plugins.replication import ReplicationClient
from ..plugins.rollups import RollupsClient from ..plugins.rollups import RollupsClient
from ..plugins.sql import SqlClient from ..plugins.sql import SqlClient
from ..plugins.transforms import TransformsClient from ..plugins.transforms import TransformsClient
@@ -26,6 +29,7 @@ from .utils import NamespacedClient
class PluginsClient(NamespacedClient): class PluginsClient(NamespacedClient):
asynchronous_search: Any
alerting: Any alerting: Any
index_management: Any index_management: Any
knn: Any knn: Any
@@ -41,6 +45,9 @@ class PluginsClient(NamespacedClient):
def __init__(self, client: Client) -> None: def __init__(self, client: Client) -> None:
super().__init__(client) super().__init__(client)
self.replication = ReplicationClient(client)
self.flow_framework = FlowFrameworkClient(client)
self.asynchronous_search = AsynchronousSearchClient(client)
self.alerting = AlertingClient(client) self.alerting = AlertingClient(client)
self.index_management = IndexManagementClient(client) self.index_management = IndexManagementClient(client)
self.knn = KnnClient(client) self.knn = KnnClient(client)
@@ -59,6 +66,9 @@ class PluginsClient(NamespacedClient):
# Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742 # Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742
plugins = [ plugins = [
"replication",
"flow_framework",
"asynchronous_search",
"alerting", "alerting",
"index_management", "index_management",
"knn", "knn",
opensearchpy/_async/client/remote_store.py
+7 -5
View File
@@ -45,13 +45,15 @@ class RemoteStoreClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
opensearchpy/_async/client/search_pipeline.py
+21 -15
View File
@@ -45,13 +45,15 @@ class SearchPipelineClient(NamespacedClient):
:arg cluster_manager_timeout: operation timeout for connection :arg cluster_manager_timeout: operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
@@ -127,13 +131,15 @@ class SearchPipelineClient(NamespacedClient):
:arg cluster_manager_timeout: operation timeout for connection :arg cluster_manager_timeout: operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
opensearchpy/_async/client/security.py
+551 -397
View File
File diff suppressed because it is too large Load Diff
opensearchpy/_async/client/snapshot.py
+112 -90
View File
@@ -69,17 +69,19 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: If `true`, the request returns a :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg repository: Comma-separated list of snapshot repository
names used to limit the request. Wildcard (*) expressions are supported. names used to limit the request. Wildcard (*) expressions are supported.
:arg snapshot: Comma-separated list of snapshot names to :arg snapshot: Comma-separated list of snapshot names to
retrieve. Also accepts wildcards (*). - To get information about all retrieve. Also accepts wildcards (`*`). - To get information about all
snapshots in a registered repository, use a wildcard (*) or _all. - To snapshots in a registered repository, use a wildcard (`*`) or `_all`. -
get information about any snapshots that are currently running, use To get information about any snapshots that are currently running, use
_current. `_current`.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: If false, the request returns an error :arg ignore_unavailable: If `false`, the request returns an
for any snapshots that are unavailable. Default is false. error for any snapshots that are unavailable. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg verbose: If true, returns additional information about each :arg verbose: If `true`, returns additional information about
snapshot such as the version of OpenSearch which took the snapshot, the each snapshot such as the version of OpenSearch which took the snapshot,
start and end times of the snapshot, and the number of shards the start and end times of the snapshot, and the number of shards
snapshotted. snapshotted.
""" """
for param in (repository, snapshot): for param in (repository, snapshot):
@@ -235,16 +241,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -283,18 +291,20 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -384,16 +396,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: Should this request wait until the :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: Whether to ignore unavailable :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. thrown Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -532,16 +550,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. to the cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. :arg timeout: Period to wait for a response.
@@ -575,7 +595,7 @@ class SnapshotClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> 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 :arg repository: A repository name
@@ -585,16 +605,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/client/tasks.py
+21 -15
View File
@@ -69,13 +69,15 @@ class TasksClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg group_by: Key used to group tasks in the response. Valid
choices are nodes, none, parents. choices are nodes, none, parents.
:arg human: Whether to return human readable values for :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 :arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all 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 information. To return all tasks, omit this parameter or use a value of
`-1`. `-1`.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg actions: Comma-separated list or wildcard expression of
actions used to limit the request. actions used to limit the request.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :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 :arg nodes: Comma-separated list of node IDs or names used to
limit the request. limit the request.
:arg parent_task_id: Parent task ID used to limit the tasks. :arg parent_task_id: Parent task ID used to limit the tasks.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: Should the request block until the :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 task_id: ID of the task.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
opensearchpy/_async/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")
async 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 await self.transport.perform_request(
"PUT", "/_wlm/query_group", params=params, headers=headers, body=body
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async 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 await self.transport.perform_request(
"DELETE",
_make_path("_wlm", "query_group", name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async 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 await self.transport.perform_request(
"GET",
_make_path("_wlm", "query_group", name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async 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 await self.transport.perform_request(
"PUT",
_make_path("_wlm", "query_group", name),
params=params,
headers=headers,
body=body,
)
opensearchpy/_async/plugins/asynchronous_search.py
+171
View File
@@ -0,0 +1,171 @@
# 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 ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class AsynchronousSearchClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def delete(
self,
id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Delete asynchronous search.
: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 id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'id'.")
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_asynchronous_search", id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def get(
self,
id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get partial responses from asynchronous search.
: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 id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'id'.")
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_asynchronous_search", id),
params=params,
headers=headers,
)
@query_params(
"error_trace",
"filter_path",
"human",
"index",
"keep_alive",
"keep_on_completion",
"pretty",
"source",
"wait_for_completion_timeout",
)
async def search(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Perform an asynchronous search.
: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 index: The name of the index to be searched.
:arg keep_alive: The amount of time that the result is saved in
the cluster.
:arg keep_on_completion: Whether you want to save the results in
the cluster after the search is complete.
: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.
:arg wait_for_completion_timeout: The amount of time that you
plan to wait for the results.
"""
return await self.transport.perform_request(
"POST",
"/_plugins/_asynchronous_search",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Monitoring of asynchronous searches that are running, completed, and/or
persisted.
: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 await self.transport.perform_request(
"GET",
"/_plugins/_asynchronous_search/stats",
params=params,
headers=headers,
)
opensearchpy/_async/plugins/flow_framework.py
+417
View File
@@ -0,0 +1,417 @@
# 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 ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class FlowFrameworkClient(NamespacedClient):
@query_params(
"error_trace",
"filter_path",
"human",
"pretty",
"provision",
"reprovision",
"source",
"update_fields",
"use_case",
"validation",
)
async def create(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Create a workflow.
: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.
:arg use_case: To use a workflow template, specify it in the
`use_case` query parameter when creating a workflow.
"""
return await self.transport.perform_request(
"POST",
"/_plugins/_flow_framework/workflow",
params=params,
headers=headers,
body=body,
)
@query_params(
"clear_status", "error_trace", "filter_path", "human", "pretty", "source"
)
async def delete(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Delete a workflow.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_flow_framework", "workflow", workflow_id),
params=params,
headers=headers,
)
@query_params(
"allow_delete", "error_trace", "filter_path", "human", "pretty", "source"
)
async def deprovision(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deprovision workflow's resources when you no longer need it.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return await self.transport.perform_request(
"POST",
_make_path(
"_plugins", "_flow_framework", "workflow", workflow_id, "_deprovision"
),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def get(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get a workflow.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_flow_framework", "workflow", workflow_id),
params=params,
headers=headers,
)
@query_params("all", "error_trace", "filter_path", "human", "pretty", "source")
async def get_status(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get the provisioning deployment status until it is complete.
:arg all: The all parameter specifies whether the response
should return all fields. Default is false.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return await self.transport.perform_request(
"GET",
_make_path(
"_plugins", "_flow_framework", "workflow", workflow_id, "_status"
),
params=params,
headers=headers,
)
@query_params(
"error_trace", "filter_path", "human", "pretty", "source", "workflow_step"
)
async def get_steps(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get a list of workflow steps.
: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 await self.transport.perform_request(
"GET",
"/_plugins/_flow_framework/workflow/_steps",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def provision(
self,
workflow_id: Any,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Provisioning a workflow. This API is also executed when the Create or Update
Workflow API is called with the provision parameter set to true.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return await self.transport.perform_request(
"POST",
_make_path(
"_plugins", "_flow_framework", "workflow", workflow_id, "_provision"
),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def search(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Search for workflows by using a query matching a field.
: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 await self.transport.perform_request(
"POST",
"/_plugins/_flow_framework/workflow/_search",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def search_state(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Search for workflows by using a query matching a field.
: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 await self.transport.perform_request(
"POST",
"/_plugins/_flow_framework/workflow/state/_search",
params=params,
headers=headers,
body=body,
)
@query_params(
"error_trace",
"filter_path",
"human",
"pretty",
"provision",
"reprovision",
"source",
"update_fields",
"use_case",
"validation",
)
async def update(
self,
workflow_id: Any,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Update a workflow. You can only update a complete workflow if it has not yet
been provisioned.
: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.
:arg use_case: To use a workflow template, specify it in the
`use_case` query parameter when creating a workflow.
"""
if workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return await self.transport.perform_request(
"PUT",
_make_path("_plugins", "_flow_framework", "workflow", workflow_id),
params=params,
headers=headers,
body=body,
)
opensearchpy/_async/plugins/knn.py
+59 -48
View File
@@ -35,13 +35,15 @@ class KnnClient(NamespacedClient):
:arg model_id: The id of the model. :arg model_id: The id of the model.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class KnnClient(NamespacedClient):
:arg model_id: The id of the model. :arg model_id: The id of the model.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -147,15 +151,15 @@ class KnnClient(NamespacedClient):
Use an OpenSearch query to search for models in the index. Use an OpenSearch query to search for models in the index.
:arg _source: True or false to return the _source field or not, :arg _source: Set to `true` or `false` to return the `_source`
or a list of fields to return. field or not, or a list of fields to return.
:arg _source_excludes: List of fields to exclude from the :arg _source_excludes: List of fields to exclude from the
returned _source field. returned `_source` field.
:arg _source_includes: List of fields to extract and return from :arg _source_includes: List of fields to extract and return from
the _source field. the `_source` field.
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indexes. (This includes `_all`
string or when no indices have been specified). string or when no indexes have been specified).
:arg allow_partial_search_results: Indicate if an error should :arg allow_partial_search_results: Indicate if an error should
be returned if there is a partial search failure or timeout. Default is be returned if there is a partial search failure or timeout. Default is
True. True.
@@ -177,20 +181,21 @@ class KnnClient(NamespacedClient):
:arg docvalue_fields: Comma-separated list of fields to return :arg docvalue_fields: Comma-separated list of fields to return
as the docvalue representation of a field for each hit. as the docvalue representation of a field for each hit.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open.
:arg explain: Specify whether to return detailed information :arg explain: Specify whether to return detailed information
about score computation as part of a hit. about score computation as part of a hit.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 from_: Starting offset. Default is 0. :arg from_: Starting offset. Default is 0.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_throttled: Whether specified concrete, expanded or :arg ignore_throttled: Whether specified concrete, expanded or
aliased indices should be ignored when throttled. aliased indexes should be ignored when throttled.
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed). should be ignored when unavailable (missing or closed).
:arg lenient: Specify whether format-based query failures (such :arg lenient: Specify whether format-based query failures (such
as providing text to a numeric field) should be ignored. as providing text to a numeric field) should be ignored.
@@ -203,18 +208,18 @@ class KnnClient(NamespacedClient):
number of shards the search request expands to exceeds the threshold. number of shards the search request expands to exceeds the threshold.
This filter round-trip can limit the number of shards significantly if This filter round-trip can limit the number of shards significantly if
for instance a shard can not match any documents based on its rewrite for instance a shard can not match any documents based on its rewrite
method ie. if date filters are mandatory to match but the shard bounds method, that is if date filters are mandatory to match but the shard
and the query are disjoint. bounds and the query are disjoint.
:arg preference: Specify the node or shard the operation should :arg preference: Specify the node or shard the operation should
be performed on. Default is random. be performed on. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
:arg request_cache: Specify if request cache should be used for :arg request_cache: Specify if request cache should be used for
this request or not, defaults to index level setting. this request or not, defaults to index level setting.
:arg rest_total_hits_as_int: Indicates whether hits.total should :arg rest_total_hits_as_int: Indicates whether `hits.total`
be rendered as an integer or an object in the rest search response. should be rendered as an integer or an object in the rest search
Default is false. response. Default is false.
:arg routing: Comma-separated list of specific routing values. :arg routing: Comma-separated list of specific routing values.
:arg scroll: Specify how long a consistent view of the index :arg scroll: Specify how long a consistent view of the index
should be maintained for scrolled search. should be maintained for scrolled search.
@@ -280,13 +285,15 @@ class KnnClient(NamespacedClient):
:arg stat: Comma-separated list of stats to retrieve; use `_all` :arg stat: Comma-separated list of stats to retrieve; use `_all`
or empty string to retrieve all stats. or empty string to retrieve all stats.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
@@ -315,14 +322,16 @@ class KnnClient(NamespacedClient):
:arg model_id: The id of the model. :arg model_id: The id of the model.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg preference: Preferred node to execute training. :arg preference: Preferred node to execute training.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -349,16 +358,18 @@ class KnnClient(NamespacedClient):
specified indexes. specified indexes.
:arg index: Comma-separated list of indices; use `_all` or empty :arg index: Comma-separated list of indexes; use `_all` or empty
string to perform the operation on all indices. string to perform the operation on all indexes.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/plugins/ml.py
+231 -45
View File
@@ -34,13 +34,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -66,13 +68,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -100,13 +104,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -134,13 +140,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -166,13 +174,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -196,13 +206,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -226,13 +238,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -256,13 +270,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -288,13 +304,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -307,3 +325,171 @@ class MlClient(NamespacedClient):
params=params, params=params,
headers=headers, headers=headers,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def create_connector(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Creates a standalone connector.
: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 await self.transport.perform_request(
"POST",
"/_plugins/_ml/connectors/_create",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def delete_agent(
self,
agent_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Delete an agent.
: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 agent_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'agent_id'.")
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_ml", "agents", agent_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def delete_connector(
self,
connector_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes a standalone connector.
: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 connector_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'connector_id'."
)
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_ml", "connectors", connector_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def delete_task(
self,
task_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes a task.
: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 task_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'task_id'.")
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_ml", "tasks", task_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def register_agents(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Register an agent.
: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 await self.transport.perform_request(
"POST",
"/_plugins/_ml/agents/_register",
params=params,
headers=headers,
body=body,
)
opensearchpy/_async/plugins/notifications.py
+67 -45
View File
@@ -34,13 +34,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class NotificationsClient(NamespacedClient):
:arg config_id: The ID of the channel configuration to delete. :arg config_id: The ID of the channel configuration to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -110,13 +114,15 @@ class NotificationsClient(NamespacedClient):
:arg config_id_list: A comma-separated list of channel IDs to :arg config_id_list: A comma-separated list of channel IDs to
delete. delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -136,13 +142,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -159,6 +167,8 @@ class NotificationsClient(NamespacedClient):
@query_params( @query_params(
"chime.url", "chime.url",
"chime.url.keyword", "chime.url.keyword",
"config_id",
"config_id_list",
"config_type", "config_type",
"created_time_ms", "created_time_ms",
"description", "description",
@@ -211,17 +221,21 @@ class NotificationsClient(NamespacedClient):
Get multiple channel configurations with filtering. Get multiple channel configurations with filtering.
:arg config_id: Notification configuration ID.
:arg config_id_list: Notification configuration IDs.
:arg config_type: Type of notification configuration. Valid :arg config_type: Type of notification configuration. Valid
choices are chime, email, email_group, microsoft_teams, ses_account, choices are chime, email, email_group, microsoft_teams, ses_account,
slack, smtp_account, sns, webhook. slack, smtp_account, sns, webhook.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -244,13 +258,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -270,13 +286,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -303,13 +321,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -336,13 +356,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/plugins/observability.py
+49 -35
View File
@@ -34,13 +34,15 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -65,13 +67,15 @@ class ObservabilityClient(NamespacedClient):
:arg object_id: The ID of the Observability Object. :arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -104,17 +108,19 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg objectId: The ID of a single Observability Object to :arg objectId: The ID of a single Observability Object to
delete. delete.
:arg objectIdList: A comma-separated list of Observability :arg objectIdList: A comma-separated list of Observability
Object IDs to delete. Object IDs to delete.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -133,13 +139,15 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -163,13 +171,15 @@ class ObservabilityClient(NamespacedClient):
:arg object_id: The ID of the Observability Object. :arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -194,13 +204,15 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -222,13 +234,15 @@ class ObservabilityClient(NamespacedClient):
:arg object_id: The ID of the Observability Object. :arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/plugins/ppl.py
+36 -28
View File
@@ -36,15 +36,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -70,15 +72,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -103,15 +107,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -138,15 +144,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
opensearchpy/_async/plugins/query.py
+35 -25
View File
@@ -35,13 +35,15 @@ class QueryClient(NamespacedClient):
:arg datasource_name: The Name of the DataSource to delete. :arg datasource_name: The Name of the DataSource to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -70,13 +72,15 @@ class QueryClient(NamespacedClient):
:arg datasource_name: The Name of the DataSource to retrieve. :arg datasource_name: The Name of the DataSource to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -104,13 +108,15 @@ class QueryClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -133,13 +139,15 @@ class QueryClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -159,13 +167,15 @@ class QueryClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/plugins/replication.py
+413
View File
@@ -0,0 +1,413 @@
# 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 ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class ReplicationClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def autofollow_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets information about auto-follow activity and any replication rules
configured on the specified cluster.
: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 await self.transport.perform_request(
"GET",
"/_plugins/_replication/autofollow_stats",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def create_replication_rule(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Automatically starts replication on indexes matching a specified pattern.
: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 await self.transport.perform_request(
"POST",
"/_plugins/_replication/_autofollow",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def delete_replication_rule(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes the specified replication rule.
: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 await self.transport.perform_request(
"DELETE",
"/_plugins/_replication/_autofollow",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def follower_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets information about follower (syncing) indexes on a specified cluster.
: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 await self.transport.perform_request(
"GET",
"/_plugins/_replication/follower_stats",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def leader_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets information about replicated leader indexes on a specified cluster.
: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 await self.transport.perform_request(
"GET", "/_plugins/_replication/leader_stats", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def pause(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Pauses replication of the leader index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return await self.transport.perform_request(
"POST",
_make_path("_plugins", "_replication", index, "_pause"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def resume(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Resumes replication of the leader index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return await self.transport.perform_request(
"POST",
_make_path("_plugins", "_replication", index, "_resume"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def start(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Initiate replication of an index from the leader cluster to the follower
cluster.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return await self.transport.perform_request(
"PUT",
_make_path("_plugins", "_replication", index, "_start"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def status(
self,
index: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets the status of index replication.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 index in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index'.")
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_replication", index, "_status"),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def stop(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Terminates replication and converts the follower index to a standard index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return await self.transport.perform_request(
"POST",
_make_path("_plugins", "_replication", index, "_stop"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def update_settings(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Updates settings on the follower index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return await self.transport.perform_request(
"PUT",
_make_path("_plugins", "_replication", index, "_update"),
params=params,
headers=headers,
body=body,
)
opensearchpy/_async/plugins/rollups.py
+42 -30
View File
@@ -35,13 +35,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -101,13 +105,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -143,17 +149,19 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg if_primary_term: Only perform the operation if the document :arg if_primary_term: Only perform the operation if the document
has this primary term. has this primary term.
:arg if_seq_no: Only perform the operation if the document has :arg if_seq_no: Only perform the operation if the document has
this sequence number. this sequence number.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -181,13 +189,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -214,13 +224,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/_async/plugins/sql.py
+60 -63
View File
@@ -18,7 +18,7 @@
from typing import Any from typing import Any
from ..client.utils import SKIP_IN_PATH, NamespacedClient, query_params from ..client.utils import NamespacedClient, query_params
class SqlClient(NamespacedClient): class SqlClient(NamespacedClient):
@@ -27,7 +27,7 @@ class SqlClient(NamespacedClient):
) )
async def close( async def close(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -36,23 +36,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 await self.transport.perform_request( return await self.transport.perform_request(
"POST", "/_plugins/_sql/close", params=params, headers=headers, body=body "POST", "/_plugins/_sql/close", params=params, headers=headers, body=body
) )
@@ -62,7 +61,7 @@ class SqlClient(NamespacedClient):
) )
async def explain( async def explain(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -71,23 +70,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 await self.transport.perform_request( return await self.transport.perform_request(
"POST", "/_plugins/_sql/_explain", params=params, headers=headers, body=body "POST", "/_plugins/_sql/_explain", params=params, headers=headers, body=body
) )
@@ -105,15 +103,17 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -128,7 +128,7 @@ class SqlClient(NamespacedClient):
) )
async def post_stats( async def post_stats(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -138,23 +138,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 await self.transport.perform_request( return await self.transport.perform_request(
"POST", "/_plugins/_sql/stats", params=params, headers=headers, body=body "POST", "/_plugins/_sql/stats", params=params, headers=headers, body=body
) )
@@ -164,7 +163,7 @@ class SqlClient(NamespacedClient):
) )
async def query( async def query(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -173,23 +172,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 await self.transport.perform_request( return await self.transport.perform_request(
"POST", "/_plugins/_sql", params=params, headers=headers, body=body "POST", "/_plugins/_sql", params=params, headers=headers, body=body
) )
@@ -197,7 +195,7 @@ class SqlClient(NamespacedClient):
@query_params("error_trace", "filter_path", "format", "human", "pretty", "source") @query_params("error_trace", "filter_path", "format", "human", "pretty", "source")
async def settings( async def settings(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -206,21 +204,20 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 await self.transport.perform_request( return await self.transport.perform_request(
"PUT", "PUT",
"/_plugins/_query/settings", "/_plugins/_query/settings",
opensearchpy/_async/plugins/transforms.py
+64 -43
View File
@@ -35,13 +35,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to delete :arg id: Transform to delete
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to explain :arg id: Transform to explain
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -101,13 +105,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to access :arg id: Transform to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -124,6 +130,7 @@ class TransformsClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
async def preview( async def preview(
self, self,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -132,18 +139,24 @@ class TransformsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
"GET", "/_plugins/_transform/_preview", params=params, headers=headers "POST",
"/_plugins/_transform/_preview",
params=params,
headers=headers,
body=body,
) )
@query_params( @query_params(
@@ -163,23 +176,25 @@ class TransformsClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Create an index transform, or update a transform if if_seq_no and Create an index transform, or update a transform if `if_seq_no` and
if_primary_term are provided. `if_primary_term` are provided.
:arg id: Transform to create/update :arg id: Transform to create/update
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg if_primary_term: Only perform the operation if the document :arg if_primary_term: Only perform the operation if the document
has this primary term. has this primary term.
:arg if_seq_no: Only perform the operation if the document has :arg if_seq_no: Only perform the operation if the document has
this sequence number. this sequence number.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -216,14 +231,16 @@ class TransformsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 from_: The starting transform to return. Default is `0`. :arg from_: The starting transform to return. Default is `0`.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg search: The search term to use to filter results. :arg search: The search term to use to filter results.
:arg size: Specifies the number of transforms to return. Default :arg size: Specifies the number of transforms to return. Default
is `10`. is `10`.
@@ -254,13 +271,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to start :arg id: Transform to start
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -287,13 +306,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to stop :arg id: Transform to stop
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
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, headers: Any = None,
) -> Any: ) -> Any:
""" """
Shows information about currently configured aliases to indices including Shows information about currently configured aliases to indexes including
filter and routing infos. filter and routing info.
:arg name: A comma-separated list of aliases to retrieve. :arg name: A comma-separated list of aliases to retrieve.
Supports wildcards (`*`). To retrieve all aliases, omit this parameter Supports wildcards (`*`). To retrieve all aliases, omit this parameter
or use `*` or `_all`. or use `*` or `_all`.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. match any field or part of a field’s name. You can also exclude fields
:arg format: A short version of the Accept header, e.g. json, with "-".
yaml. :arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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 :arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -175,22 +178,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -231,22 +236,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -277,24 +284,26 @@ class CatClient(NamespacedClient):
) -> Any: ) -> Any:
""" """
Provides quick access to the document count of the entire cluster, or 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 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -325,7 +334,7 @@ class CatClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> 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. node in the cluster.
@@ -334,17 +343,19 @@ class CatClient(NamespacedClient):
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg time: The unit used to display time values. Valid choices :arg time: The unit used to display time values. Valid choices
are d, h, m, micros, ms, nanos, s. are d, h, m, micros, ms, nanos, s.
:arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps. :arg ts: If `true`, returns `HH:MM:SS` and Unix epoch
Default is True. timestamps. Default is True.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -418,13 +431,15 @@ class CatClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -460,43 +475,45 @@ class CatClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Returns information about indices: number of primaries and replicas, document Returns information about indexes: number of primaries and replicas, document
counts, disk size, ... 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 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 :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: The type of index that wildcard patterns
can match. Valid choices are all, closed, hidden, none, open. can match.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg health: The health status used to limit returned indices. :arg health: The health status used to limit returned indexes.
By default, the response includes indices of any health status. Valid By default, the response includes indexes of any health status. Valid
choices are green, red, yellow. choices are green, red, yellow.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_unloaded_segments: If true, the response includes :arg include_unloaded_segments: If `true`, the response includes
information from segments that are not loaded into memory. Default is information from segments that are not loaded into memory. Default is
false. false.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg pri: If true, the response only includes information from :arg pri: If `true`, the response only includes information from
primary shards. Default is false. primary shards. Default is false.
:arg s: Comma-separated list of column names or column aliases :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
@@ -537,22 +554,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -562,7 +581,7 @@ class CatClient(NamespacedClient):
from warnings import warn from warnings import warn
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( return self.transport.perform_request(
"GET", "/_cat/master", params=params, headers=headers "GET", "/_cat/master", params=params, headers=headers
@@ -595,22 +614,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -653,25 +674,27 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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`, :arg full_id: If `true`, return the full node ID. If `false`,
return the shortened node ID. Default is false. return the shortened node ID. Default is false.
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local (Deprecated: This parameter does not cause this API :arg local (Deprecated: This parameter does not cause this API
to act locally.): Return local information, do not retrieve the state to act locally.): Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -712,22 +735,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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 :arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -814,22 +841,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -875,17 +904,19 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -925,22 +956,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -989,9 +1022,9 @@ class CatClient(NamespacedClient):
names to limit the returned information. names to limit the returned information.
:arg active_only: If `true`, the response only includes ongoing :arg active_only: If `true`, the response only includes ongoing
segment replication events. Default is false. segment replication events. Default is false.
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indexes. (This includes `_all`
string or when no indices have been specified). string or when no indexes have been specified).
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg completed_only: If `true`, the response only includes :arg completed_only: If `true`, the response only includes
@@ -999,24 +1032,25 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about segment replications. Default is false. information about segment replications. Default is false.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. match any field or part of a field’s name. You can also exclude fields
:arg format: A short version of the Accept header, e.g. json, with "-".
yaml. :arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_throttled: Whether specified concrete, expanded or :arg ignore_throttled: Whether specified concrete, expanded or
aliased indices should be ignored when throttled. aliased indexes should be ignored when throttled.
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed). should be ignored when unavailable (missing or closed).
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg shards: Comma-separated list of shards to display. :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. 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 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 :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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. 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 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 :arg bytes: The unit used to display byte values. Valid choices
are b, g, gb, k, kb, m, mb, p, pb, t, tb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1186,22 +1224,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg size: The multiplier in which to display values. :arg size: The multiplier in which to display values.
@@ -1249,22 +1289,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: If `true`, the response does not :arg ignore_unavailable: If `true`, the response does not
include information from unavailable snapshots. Default is false. include information from unavailable snapshots. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1312,15 +1354,17 @@ class CatClient(NamespacedClient):
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :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 :arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all 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 :arg parent_task_id: The parent task identifier, which is used
to limit the response. to limit the response.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1371,22 +1415,24 @@ class CatClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. 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 h: Comma-separated list of column names to display.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for use `cluster_manager_timeout` instead.): Operation timeout for
connection to master node. connection to cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :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 :arg s: Comma-separated list of column names or column aliases
to sort by. to sort by.
:arg source: The URL-encoded request definition. Useful for :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. 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 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 `*`. this parameter or use `_all` or `*`.
:arg awareness_attribute: The awareness attribute for which the :arg awareness_attribute: The awareness attribute for which the
health is required. health is required.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg level: Can be one of cluster, indices or shards. Controls :arg level: Can be one of cluster, indexes or shards. Controls
the details level of the health information returned. Valid choices are the details level of the health information returned. Valid choices are
awareness_attributes, cluster, indices, shards. awareness_attributes, cluster, indices, shards.
:arg local: If true, the request retrieves information from the :arg local: If `true`, the request retrieves information from
local node only. Defaults to false, which means information is retrieved the local node only. Defaults to false, which means information is
from the master node. Default is false. retrieved from the cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 normal, low, languid. Wait until all currently queued events with the
given priority are processed. Valid choices are high, immediate, given priority are processed. Valid choices are high, immediate,
languid, low, normal, urgent. 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 controls whether to wait (until the timeout provided) for the cluster to
have no shard initializations. Defaults to false, which means it will have no shard initializations. Defaults to false, which means it will
not wait for initializing shards. 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 controls whether to wait (until the timeout provided) for the cluster to
have no shard relocations. Defaults to false, which means it will not have no shard relocations. Defaults to false, which means it will not
wait for relocating shards. wait for relocating shards.
@@ -158,20 +159,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. If `false`, information is retrieved from the 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, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg metric: Limit the information returned to the specified
metrics metrics
:arg index: A comma-separated list of index names; use `_all` or :arg index: A comma-separated list of index names; use `_all` or
empty string to perform the operation on all indices empty string to perform the operation on all indexes
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indexes. (This includes `_all`
string or when no indices have been specified) string or when no indexes have been specified)
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open. :arg filter_path: Used to reduce the response. This parameter
:arg filter_path: Comma-separated list of filters used to reduce takes a comma-separated list of filters. It supports using wildcards to
the response. 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 :arg flat_settings: Return settings in flat format. Default is
false. false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed) should be ignored when unavailable (missing or closed)
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection use `cluster_manager_timeout` instead.): Specify timeout for connection
to master to cluster manager.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_metadata_version: Wait for the metadata version to :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 :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: if index and metric in SKIP_IN_PATH:
metric = "_all" metric = "_all"
@@ -266,23 +270,32 @@ class ClusterClient(NamespacedClient):
node_id: Any = None, node_id: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
metric: Any = None,
index_metric: Any = None,
) -> Any: ) -> Any:
""" """
Returns high-level overview of cluster statistics. 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 :arg node_id: Comma-separated list of node filters used to limit
returned information. Defaults to all nodes in the cluster. returned information. Defaults to all nodes in the cluster.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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. :arg flat_settings: If `true`, returns settings in flat format.
Default is false. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg timeout: Period to wait for each node to respond. If a node
@@ -295,7 +308,9 @@ class ClusterClient(NamespacedClient):
( (
"/_cluster/stats" "/_cluster/stats"
if node_id in SKIP_IN_PATH 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, params=params,
headers=headers, headers=headers,
@@ -329,25 +344,27 @@ class ClusterClient(NamespacedClient):
`cancel`, `allocate`) `cancel`, `allocate`)
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg dry_run: If true, then the request simulates the operation :arg dry_run: If `true`, then the request simulates the
only and returns the resulting state. operation only and returns the resulting state.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg explain: If true, then the response contains an explanation :arg explain: If `true`, then the response contains an
of why the commands can or cannot be executed. explanation of why the commands can or cannot be executed.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg metric: Limits the information returned to the specified :arg metric: Limits the information returned to the specified
metrics. metrics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg retry_failed: If true, then retries allocation of shards :arg retry_failed: If `true`, then retries allocation of shards
that are blocked due to too many subsequent allocation failures. that are blocked due to too many subsequent allocation failures.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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. :arg flat_settings: If `true`, returns settings in flat format.
Default is false. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_defaults: If `true`, returns default cluster :arg include_defaults: If `true`, returns default cluster
settings from the local node. Default is false. settings from the local node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg flat_settings: Return settings in flat format. Default is
false. false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -468,13 +489,15 @@ class ClusterClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg body: The index, shard, and primary flag to explain. Empty
means 'explain the first unassigned shard' means 'explain the first unassigned shard'
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_disk_info: If true, returns information about disk :arg include_disk_info: If `true`, returns information about
usage and shard sizes. Default is false. disk usage and shard sizes. Default is false.
:arg include_yes_decisions: If true, returns YES decisions in :arg include_yes_decisions: If `true`, returns YES decisions in
explanation. Default is false. explanation. Default is false.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. If `false`, information is retrieved from the 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, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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`; includes the following built-in component templates: `logs-mappings`;
'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics- 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-
mapping`; `synthetics-settings`. OpenSearch Agent uses these templates 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` Agent and want to overwrite one of these templates, set the `version`
for your replacement template higher than the current version. If you for your replacement template higher than the current version. If you
don't use OpenSearch Agent and want to disable all built-in component 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 :arg create: If `true`, this request cannot replace or update
existing component templates. Default is false. existing component templates. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
@@ -717,20 +748,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: If true, the request retrieves information from the :arg local: If `true`, the request retrieves information from
local node only. Defaults to false, which means information is retrieved the local node only. Defaults to false, which means information is
from the master node. Default is false. retrieved from the cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_removal: Specifies whether to wait for all :arg wait_for_removal: Specifies whether to wait for all
excluded nodes to be removed from the cluster before clearing the voting excluded nodes to be removed from the cluster before clearing the voting
configuration exclusions list. Defaults to true, meaning that all configuration exclusions list. Defaults to true, meaning that all
excluded nodes must be removed from the cluster before this API takes 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. list is cleared even if some excluded nodes are still in the cluster.
Default is True. Default is True.
""" """
@@ -801,19 +836,21 @@ class ClusterClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :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 :arg node_ids: A comma-separated list of the persistent ids of
the nodes to exclude from the voting configuration. If specified, you 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 :arg node_names: A comma-separated list of the names of the
nodes to exclude from the voting configuration. If specified, you may 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 :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: When adding a voting configuration exclusion, the :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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") @query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_weighted_routing( def delete_weighted_routing(
self, self,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -862,13 +902,15 @@ class ClusterClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -877,6 +919,7 @@ class ClusterClient(NamespacedClient):
"/_cluster/routing/awareness/weights", "/_cluster/routing/awareness/weights",
params=params, params=params,
headers=headers, headers=headers,
body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
@@ -892,13 +935,15 @@ class ClusterClient(NamespacedClient):
:arg awareness_attribute_name: Awareness attribute name. :arg awareness_attribute_name: Awareness attribute name.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 attribute: Awareness attribute name.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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_name: Awareness attribute name.
:arg awareness_attribute_value: Awareness attribute value. :arg awareness_attribute_value: Awareness attribute value.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -999,6 +1048,7 @@ class ClusterClient(NamespacedClient):
def put_weighted_routing( def put_weighted_routing(
self, self,
attribute: Any, attribute: Any,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -1008,13 +1058,15 @@ class ClusterClient(NamespacedClient):
:arg attribute: Awareness attribute name. :arg attribute: Awareness attribute name.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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"), _make_path("_cluster", "routing", "awareness", attribute, "weights"),
params=params, params=params,
headers=headers, 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. 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 :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection use `cluster_manager_timeout` instead.): Specify timeout for connection
to master to cluster manager.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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: if index_uuid in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index_uuid'.") raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -112,25 +114,27 @@ class DanglingIndicesClient(NamespacedClient):
Imports the specified dangling index. 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 :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Specify timeout for connection use `cluster_manager_timeout` instead.): Specify timeout for connection
to master to cluster manager.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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: if index_uuid in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index_uuid'.") raise ValueError("Empty value passed for a required argument 'index_uuid'.")
@@ -146,17 +150,19 @@ class DanglingIndicesClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Returns all dangling indices. Returns all dangling indexes.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg id: Pipeline to test. If you don't specify a `pipeline` in
the request body, this parameter is required. the request body, this parameter is required.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg verbose: If `true`, the response includes output data for :arg verbose: If `true`, the response includes output data for
@@ -230,7 +238,7 @@ class IngestClient(NamespacedClient):
body=body, body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "s", "source")
def processor_grok( def processor_grok(
self, self,
params: Any = None, params: Any = None,
@@ -241,13 +249,16 @@ class IngestClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :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 :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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. Reloads secure settings.
:arg body: An object containing the password for the opensearch :arg body: An object containing the password for the OpenSearch
keystore keystore.
:arg node_id: The names of particular nodes in the cluster to :arg node_id: The names of particular nodes in the cluster to
target. target.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
@@ -91,6 +93,7 @@ class NodesClient(NamespacedClient):
self, self,
node_id: Any = None, node_id: Any = None,
metric: Any = None, metric: Any = None,
node_id_or_metric: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -101,17 +104,22 @@ class NodesClient(NamespacedClient):
:arg node_id: Comma-separated list of node IDs or names used to :arg node_id: Comma-separated list of node IDs or names used to
limit returned information. limit returned information.
:arg metric: Limits the information returned to the specific :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg flat_settings: If true, returns settings in flat format. 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. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
@@ -153,31 +161,33 @@ class NodesClient(NamespacedClient):
limit returned information. limit returned information.
:arg metric: Limit the information returned to the specified :arg metric: Limit the information returned to the specified
metrics metrics
:arg index_metric: Limit the information returned for indices :arg index_metric: Limit the information returned for indexes
metric to the specific index metrics. It can be used only if indices (or metric to the specific index metrics. It can be used only if indexes (or
all) metric is specified. all) metric is specified.
:arg completion_fields: Comma-separated list or wildcard :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 :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg fielddata_fields: Comma-separated list or wildcard :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 :arg fields: Comma-separated list or wildcard expressions of
fields to include in the statistics. fields to include in the statistics.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg groups: Comma-separated list of search groups to include in
the search statistics. the search statistics.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg include_segment_file_sizes: If true, the call reports the :arg include_segment_file_sizes: If `true`, the call reports the
aggregated disk usage of each one of the Lucene index files (only aggregated disk usage of each one of the Lucene index files (only
applies if segment stats are requested). Default is false. applies if segment stats are requested). Default is false.
:arg level: Indicates whether statistics are aggregated at the :arg level: Indicates whether statistics are aggregated at the
cluster, index, or shard level. Valid choices are cluster, indices, cluster, index, or shard level. Valid choices are cluster, indices,
shards. shards.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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, :arg doc_type: The type to sample. Valid choices are block, cpu,
wait. wait.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :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- :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 idle places, such as waiting on a socket select or pulling from an empty
task queue. Default is True. task queue. Default is True.
:arg interval: The interval for the second sampling of threads. :arg interval: The interval for the second sampling of threads.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg snapshots: Number of samples of thread stacktrace. Default :arg snapshots: Number of samples of thread stack trace. Default
is 10. is 10.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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`, metrics. A comma-separated list of the following options: `_all`,
`rest_actions`. `rest_actions`.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 typing import Any
from ..plugins.alerting import AlertingClient 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.index_management import IndexManagementClient
from ..plugins.knn import KnnClient from ..plugins.knn import KnnClient
from ..plugins.ml import MlClient from ..plugins.ml import MlClient
@@ -18,6 +20,7 @@ from ..plugins.notifications import NotificationsClient
from ..plugins.observability import ObservabilityClient from ..plugins.observability import ObservabilityClient
from ..plugins.ppl import PplClient from ..plugins.ppl import PplClient
from ..plugins.query import QueryClient from ..plugins.query import QueryClient
from ..plugins.replication import ReplicationClient
from ..plugins.rollups import RollupsClient from ..plugins.rollups import RollupsClient
from ..plugins.sql import SqlClient from ..plugins.sql import SqlClient
from ..plugins.transforms import TransformsClient from ..plugins.transforms import TransformsClient
@@ -26,12 +29,25 @@ from .utils import NamespacedClient
class PluginsClient(NamespacedClient): class PluginsClient(NamespacedClient):
asynchronous_search: Any
alerting: Any alerting: Any
index_management: 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: def __init__(self, client: Client) -> None:
super().__init__(client) super().__init__(client)
self.replication = ReplicationClient(client)
self.flow_framework = FlowFrameworkClient(client)
self.asynchronous_search = AsynchronousSearchClient(client)
self.alerting = AlertingClient(client) self.alerting = AlertingClient(client)
self.index_management = IndexManagementClient(client) self.index_management = IndexManagementClient(client)
self.knn = KnnClient(client) self.knn = KnnClient(client)
@@ -50,13 +66,20 @@ class PluginsClient(NamespacedClient):
# Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742 # Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742
plugins = [ plugins = [
# "query_workbench", "replication",
# "reporting", "flow_framework",
# "notebooks", "asynchronous_search",
"alerting", "alerting",
# "anomaly_detection",
# "trace_analytics",
"index_management", "index_management",
"knn",
"ml",
"notifications",
"observability",
"ppl",
"query",
"rollups",
"sql",
"transforms",
] ]
for plugin in plugins: for plugin in plugins:
if not hasattr(client, plugin): 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: Should this request wait until the :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 :arg cluster_manager_timeout: operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
@@ -127,13 +131,15 @@ class SearchPipelineClient(NamespacedClient):
:arg cluster_manager_timeout: operation timeout for connection :arg cluster_manager_timeout: operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: If `true`, the request returns a :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg repository: Comma-separated list of snapshot repository
names used to limit the request. Wildcard (*) expressions are supported. names used to limit the request. Wildcard (*) expressions are supported.
:arg snapshot: Comma-separated list of snapshot names to :arg snapshot: Comma-separated list of snapshot names to
retrieve. Also accepts wildcards (*). - To get information about all retrieve. Also accepts wildcards (`*`). - To get information about all
snapshots in a registered repository, use a wildcard (*) or _all. - To snapshots in a registered repository, use a wildcard (`*`) or `_all`. -
get information about any snapshots that are currently running, use To get information about any snapshots that are currently running, use
_current. `_current`.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: If false, the request returns an error :arg ignore_unavailable: If `false`, the request returns an
for any snapshots that are unavailable. Default is false. error for any snapshots that are unavailable. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the cluster-manager node. If no response is received before the
expires, the request fails and returns an error. timeout expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg verbose: If true, returns additional information about each :arg verbose: If `true`, returns additional information about
snapshot such as the version of OpenSearch which took the snapshot, the each snapshot such as the version of OpenSearch which took the snapshot,
start and end times of the snapshot, and the number of shards the start and end times of the snapshot, and the number of shards
snapshotted. snapshotted.
""" """
for param in (repository, snapshot): for param in (repository, snapshot):
@@ -235,16 +241,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -283,18 +291,20 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg local: Return local information, do not retrieve the state :arg local: Return local information, do not retrieve the state
from cluster-manager node. Default is false. from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -384,16 +396,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: Should this request wait until the :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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_unavailable: Whether to ignore unavailable :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. thrown Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Explicit operation timeout :arg timeout: Explicit operation timeout
@@ -532,16 +550,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use `cluster_manager_timeout` instead.): Period to wait for a connection
to the master node. to the cluster-manager node.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. :arg timeout: Period to wait for a response.
@@ -575,7 +595,7 @@ class SnapshotClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> 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 :arg repository: A repository name
@@ -585,16 +605,18 @@ class SnapshotClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Explicit operation timeout for use `cluster_manager_timeout` instead.): Explicit operation timeout for
connection to master node connection to cluster-manager node
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg group_by: Key used to group tasks in the response. Valid
choices are nodes, none, parents. choices are nodes, none, parents.
:arg human: Whether to return human readable values for :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 :arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all 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 information. To return all tasks, omit this parameter or use a value of
`-1`. `-1`.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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 :arg actions: Comma-separated list or wildcard expression of
actions used to limit the request. actions used to limit the request.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :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 :arg nodes: Comma-separated list of node IDs or names used to
limit the request. limit the request.
:arg parent_task_id: Parent task ID used to limit the tasks. :arg parent_task_id: Parent task ID used to limit the tasks.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_completion: Should the request block until the :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 task_id: ID of the task.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :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,
)
opensearchpy/plugins/asynchronous_search.py
+171
View File
@@ -0,0 +1,171 @@
# 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 ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class AsynchronousSearchClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete(
self,
id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Delete asynchronous search.
: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 id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'id'.")
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_asynchronous_search", id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def get(
self,
id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get partial responses from asynchronous search.
: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 id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'id'.")
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_asynchronous_search", id),
params=params,
headers=headers,
)
@query_params(
"error_trace",
"filter_path",
"human",
"index",
"keep_alive",
"keep_on_completion",
"pretty",
"source",
"wait_for_completion_timeout",
)
def search(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Perform an asynchronous search.
: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 index: The name of the index to be searched.
:arg keep_alive: The amount of time that the result is saved in
the cluster.
:arg keep_on_completion: Whether you want to save the results in
the cluster after the search is complete.
: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.
:arg wait_for_completion_timeout: The amount of time that you
plan to wait for the results.
"""
return self.transport.perform_request(
"POST",
"/_plugins/_asynchronous_search",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Monitoring of asynchronous searches that are running, completed, and/or
persisted.
: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",
"/_plugins/_asynchronous_search/stats",
params=params,
headers=headers,
)
opensearchpy/plugins/flow_framework.py
+417
View File
@@ -0,0 +1,417 @@
# 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 ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class FlowFrameworkClient(NamespacedClient):
@query_params(
"error_trace",
"filter_path",
"human",
"pretty",
"provision",
"reprovision",
"source",
"update_fields",
"use_case",
"validation",
)
def create(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Create a workflow.
: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.
:arg use_case: To use a workflow template, specify it in the
`use_case` query parameter when creating a workflow.
"""
return self.transport.perform_request(
"POST",
"/_plugins/_flow_framework/workflow",
params=params,
headers=headers,
body=body,
)
@query_params(
"clear_status", "error_trace", "filter_path", "human", "pretty", "source"
)
def delete(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Delete a workflow.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_flow_framework", "workflow", workflow_id),
params=params,
headers=headers,
)
@query_params(
"allow_delete", "error_trace", "filter_path", "human", "pretty", "source"
)
def deprovision(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deprovision workflow's resources when you no longer need it.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return self.transport.perform_request(
"POST",
_make_path(
"_plugins", "_flow_framework", "workflow", workflow_id, "_deprovision"
),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def get(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get a workflow.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_flow_framework", "workflow", workflow_id),
params=params,
headers=headers,
)
@query_params("all", "error_trace", "filter_path", "human", "pretty", "source")
def get_status(
self,
workflow_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get the provisioning deployment status until it is complete.
:arg all: The all parameter specifies whether the response
should return all fields. Default is false.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return self.transport.perform_request(
"GET",
_make_path(
"_plugins", "_flow_framework", "workflow", workflow_id, "_status"
),
params=params,
headers=headers,
)
@query_params(
"error_trace", "filter_path", "human", "pretty", "source", "workflow_step"
)
def get_steps(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Get a list of workflow steps.
: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",
"/_plugins/_flow_framework/workflow/_steps",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def provision(
self,
workflow_id: Any,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Provisioning a workflow. This API is also executed when the Create or Update
Workflow API is called with the provision parameter set to true.
: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 workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return self.transport.perform_request(
"POST",
_make_path(
"_plugins", "_flow_framework", "workflow", workflow_id, "_provision"
),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def search(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Search for workflows by using a query matching a field.
: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(
"POST",
"/_plugins/_flow_framework/workflow/_search",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def search_state(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Search for workflows by using a query matching a field.
: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(
"POST",
"/_plugins/_flow_framework/workflow/state/_search",
params=params,
headers=headers,
body=body,
)
@query_params(
"error_trace",
"filter_path",
"human",
"pretty",
"provision",
"reprovision",
"source",
"update_fields",
"use_case",
"validation",
)
def update(
self,
workflow_id: Any,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Update a workflow. You can only update a complete workflow if it has not yet
been provisioned.
: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.
:arg use_case: To use a workflow template, specify it in the
`use_case` query parameter when creating a workflow.
"""
if workflow_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'workflow_id'."
)
return self.transport.perform_request(
"PUT",
_make_path("_plugins", "_flow_framework", "workflow", workflow_id),
params=params,
headers=headers,
body=body,
)
opensearchpy/plugins/knn.py
+59 -48
View File
@@ -35,13 +35,15 @@ class KnnClient(NamespacedClient):
:arg model_id: The id of the model. :arg model_id: The id of the model.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class KnnClient(NamespacedClient):
:arg model_id: The id of the model. :arg model_id: The id of the model.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -147,15 +151,15 @@ class KnnClient(NamespacedClient):
Use an OpenSearch query to search for models in the index. Use an OpenSearch query to search for models in the index.
:arg _source: True or false to return the _source field or not, :arg _source: Set to `true` or `false` to return the `_source`
or a list of fields to return. field or not, or a list of fields to return.
:arg _source_excludes: List of fields to exclude from the :arg _source_excludes: List of fields to exclude from the
returned _source field. returned `_source` field.
:arg _source_includes: List of fields to extract and return from :arg _source_includes: List of fields to extract and return from
the _source field. the `_source` field.
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indexes
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indexes. (This includes `_all`
string or when no indices have been specified). string or when no indexes have been specified).
:arg allow_partial_search_results: Indicate if an error should :arg allow_partial_search_results: Indicate if an error should
be returned if there is a partial search failure or timeout. Default is be returned if there is a partial search failure or timeout. Default is
True. True.
@@ -177,20 +181,21 @@ class KnnClient(NamespacedClient):
:arg docvalue_fields: Comma-separated list of fields to return :arg docvalue_fields: Comma-separated list of fields to return
as the docvalue representation of a field for each hit. as the docvalue representation of a field for each hit.
:arg error_trace: Whether to include the stack trace of returned :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 :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indexes that are open, closed or both.
closed, hidden, none, open.
:arg explain: Specify whether to return detailed information :arg explain: Specify whether to return detailed information
about score computation as part of a hit. about score computation as part of a hit.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 from_: Starting offset. Default is 0. :arg from_: Starting offset. Default is 0.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg ignore_throttled: Whether specified concrete, expanded or :arg ignore_throttled: Whether specified concrete, expanded or
aliased indices should be ignored when throttled. aliased indexes should be ignored when throttled.
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indexes
should be ignored when unavailable (missing or closed). should be ignored when unavailable (missing or closed).
:arg lenient: Specify whether format-based query failures (such :arg lenient: Specify whether format-based query failures (such
as providing text to a numeric field) should be ignored. as providing text to a numeric field) should be ignored.
@@ -203,18 +208,18 @@ class KnnClient(NamespacedClient):
number of shards the search request expands to exceeds the threshold. number of shards the search request expands to exceeds the threshold.
This filter round-trip can limit the number of shards significantly if This filter round-trip can limit the number of shards significantly if
for instance a shard can not match any documents based on its rewrite for instance a shard can not match any documents based on its rewrite
method ie. if date filters are mandatory to match but the shard bounds method, that is if date filters are mandatory to match but the shard
and the query are disjoint. bounds and the query are disjoint.
:arg preference: Specify the node or shard the operation should :arg preference: Specify the node or shard the operation should
be performed on. Default is random. be performed on. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
:arg request_cache: Specify if request cache should be used for :arg request_cache: Specify if request cache should be used for
this request or not, defaults to index level setting. this request or not, defaults to index level setting.
:arg rest_total_hits_as_int: Indicates whether hits.total should :arg rest_total_hits_as_int: Indicates whether `hits.total`
be rendered as an integer or an object in the rest search response. should be rendered as an integer or an object in the rest search
Default is false. response. Default is false.
:arg routing: Comma-separated list of specific routing values. :arg routing: Comma-separated list of specific routing values.
:arg scroll: Specify how long a consistent view of the index :arg scroll: Specify how long a consistent view of the index
should be maintained for scrolled search. should be maintained for scrolled search.
@@ -280,13 +285,15 @@ class KnnClient(NamespacedClient):
:arg stat: Comma-separated list of stats to retrieve; use `_all` :arg stat: Comma-separated list of stats to retrieve; use `_all`
or empty string to retrieve all stats. or empty string to retrieve all stats.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
@@ -315,14 +322,16 @@ class KnnClient(NamespacedClient):
:arg model_id: The id of the model. :arg model_id: The id of the model.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg preference: Preferred node to execute training. :arg preference: Preferred node to execute training.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -349,16 +358,18 @@ class KnnClient(NamespacedClient):
specified indexes. specified indexes.
:arg index: Comma-separated list of indices; use `_all` or empty :arg index: Comma-separated list of indexes; use `_all` or empty
string to perform the operation on all indices. string to perform the operation on all indexes.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/plugins/ml.py
+231 -45
View File
@@ -34,13 +34,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -66,13 +68,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -100,13 +104,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -134,13 +140,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -166,13 +174,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -196,13 +206,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -226,13 +238,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -256,13 +270,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -288,13 +304,15 @@ class MlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -307,3 +325,171 @@ class MlClient(NamespacedClient):
params=params, params=params,
headers=headers, headers=headers,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def create_connector(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Creates a standalone connector.
: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(
"POST",
"/_plugins/_ml/connectors/_create",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_agent(
self,
agent_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Delete an agent.
: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 agent_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'agent_id'.")
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_ml", "agents", agent_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_connector(
self,
connector_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes a standalone connector.
: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 connector_id in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'connector_id'."
)
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_ml", "connectors", connector_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_task(
self,
task_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes a task.
: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 task_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'task_id'.")
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_ml", "tasks", task_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def register_agents(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Register an agent.
: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(
"POST",
"/_plugins/_ml/agents/_register",
params=params,
headers=headers,
body=body,
)
opensearchpy/plugins/notifications.py
+67 -45
View File
@@ -34,13 +34,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class NotificationsClient(NamespacedClient):
:arg config_id: The ID of the channel configuration to delete. :arg config_id: The ID of the channel configuration to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -110,13 +114,15 @@ class NotificationsClient(NamespacedClient):
:arg config_id_list: A comma-separated list of channel IDs to :arg config_id_list: A comma-separated list of channel IDs to
delete. delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -136,13 +142,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -159,6 +167,8 @@ class NotificationsClient(NamespacedClient):
@query_params( @query_params(
"chime.url", "chime.url",
"chime.url.keyword", "chime.url.keyword",
"config_id",
"config_id_list",
"config_type", "config_type",
"created_time_ms", "created_time_ms",
"description", "description",
@@ -211,17 +221,21 @@ class NotificationsClient(NamespacedClient):
Get multiple channel configurations with filtering. Get multiple channel configurations with filtering.
:arg config_id: Notification configuration ID.
:arg config_id_list: Notification configuration IDs.
:arg config_type: Type of notification configuration. Valid :arg config_type: Type of notification configuration. Valid
choices are chime, email, email_group, microsoft_teams, ses_account, choices are chime, email, email_group, microsoft_teams, ses_account,
slack, smtp_account, sns, webhook. slack, smtp_account, sns, webhook.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -244,13 +258,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -270,13 +286,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -303,13 +321,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -336,13 +356,15 @@ class NotificationsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/plugins/observability.py
+49 -35
View File
@@ -34,13 +34,15 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -65,13 +67,15 @@ class ObservabilityClient(NamespacedClient):
:arg object_id: The ID of the Observability Object. :arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -104,17 +108,19 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg objectId: The ID of a single Observability Object to :arg objectId: The ID of a single Observability Object to
delete. delete.
:arg objectIdList: A comma-separated list of Observability :arg objectIdList: A comma-separated list of Observability
Object IDs to delete. Object IDs to delete.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -133,13 +139,15 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -163,13 +171,15 @@ class ObservabilityClient(NamespacedClient):
:arg object_id: The ID of the Observability Object. :arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -194,13 +204,15 @@ class ObservabilityClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -222,13 +234,15 @@ class ObservabilityClient(NamespacedClient):
:arg object_id: The ID of the Observability Object. :arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/plugins/ppl.py
+36 -28
View File
@@ -36,15 +36,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -70,15 +72,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -103,15 +107,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -138,15 +144,17 @@ class PplClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results. Default is True. the results. Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
opensearchpy/plugins/query.py
+35 -25
View File
@@ -35,13 +35,15 @@ class QueryClient(NamespacedClient):
:arg datasource_name: The Name of the DataSource to delete. :arg datasource_name: The Name of the DataSource to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -70,13 +72,15 @@ class QueryClient(NamespacedClient):
:arg datasource_name: The Name of the DataSource to retrieve. :arg datasource_name: The Name of the DataSource to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -104,13 +108,15 @@ class QueryClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -133,13 +139,15 @@ class QueryClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -159,13 +167,15 @@ class QueryClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/plugins/replication.py
+413
View File
@@ -0,0 +1,413 @@
# 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 ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class ReplicationClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def autofollow_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets information about auto-follow activity and any replication rules
configured on the specified cluster.
: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",
"/_plugins/_replication/autofollow_stats",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def create_replication_rule(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Automatically starts replication on indexes matching a specified pattern.
: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(
"POST",
"/_plugins/_replication/_autofollow",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_replication_rule(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes the specified replication rule.
: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(
"DELETE",
"/_plugins/_replication/_autofollow",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def follower_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets information about follower (syncing) indexes on a specified cluster.
: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",
"/_plugins/_replication/follower_stats",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def leader_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets information about replicated leader indexes on a specified cluster.
: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", "/_plugins/_replication/leader_stats", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def pause(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Pauses replication of the leader index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return self.transport.perform_request(
"POST",
_make_path("_plugins", "_replication", index, "_pause"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def resume(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Resumes replication of the leader index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return self.transport.perform_request(
"POST",
_make_path("_plugins", "_replication", index, "_resume"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def start(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Initiate replication of an index from the leader cluster to the follower
cluster.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return self.transport.perform_request(
"PUT",
_make_path("_plugins", "_replication", index, "_start"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def status(
self,
index: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Gets the status of index replication.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 index in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index'.")
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_replication", index, "_status"),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def stop(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Terminates replication and converts the follower index to a standard index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return self.transport.perform_request(
"POST",
_make_path("_plugins", "_replication", index, "_stop"),
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def update_settings(
self,
index: Any,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Updates settings on the follower index.
:arg index: Name of the data stream, index, or index alias to
perform bulk actions on.
: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 (index, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
return self.transport.perform_request(
"PUT",
_make_path("_plugins", "_replication", index, "_update"),
params=params,
headers=headers,
body=body,
)
opensearchpy/plugins/rollups.py
+42 -30
View File
@@ -35,13 +35,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -101,13 +105,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -143,17 +149,19 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg if_primary_term: Only perform the operation if the document :arg if_primary_term: Only perform the operation if the document
has this primary term. has this primary term.
:arg if_seq_no: Only perform the operation if the document has :arg if_seq_no: Only perform the operation if the document has
this sequence number. this sequence number.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -181,13 +189,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -214,13 +224,15 @@ class RollupsClient(NamespacedClient):
:arg id: Rollup to access :arg id: Rollup to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
opensearchpy/plugins/sql.py
+60 -63
View File
@@ -18,7 +18,7 @@
from typing import Any from typing import Any
from ..client.utils import SKIP_IN_PATH, NamespacedClient, query_params from ..client.utils import NamespacedClient, query_params
class SqlClient(NamespacedClient): class SqlClient(NamespacedClient):
@@ -27,7 +27,7 @@ class SqlClient(NamespacedClient):
) )
def close( def close(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -36,23 +36,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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( return self.transport.perform_request(
"POST", "/_plugins/_sql/close", params=params, headers=headers, body=body "POST", "/_plugins/_sql/close", params=params, headers=headers, body=body
) )
@@ -62,7 +61,7 @@ class SqlClient(NamespacedClient):
) )
def explain( def explain(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -71,23 +70,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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( return self.transport.perform_request(
"POST", "/_plugins/_sql/_explain", params=params, headers=headers, body=body "POST", "/_plugins/_sql/_explain", params=params, headers=headers, body=body
) )
@@ -105,15 +103,17 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -128,7 +128,7 @@ class SqlClient(NamespacedClient):
) )
def post_stats( def post_stats(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -138,23 +138,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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( return self.transport.perform_request(
"POST", "/_plugins/_sql/stats", params=params, headers=headers, body=body "POST", "/_plugins/_sql/stats", params=params, headers=headers, body=body
) )
@@ -164,7 +163,7 @@ class SqlClient(NamespacedClient):
) )
def query( def query(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -173,23 +172,22 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg sanitize: Specifies whether to escape special characters in :arg sanitize: Specifies whether to escape special characters in
the results Default is True. the results Default is True.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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( return self.transport.perform_request(
"POST", "/_plugins/_sql", params=params, headers=headers, body=body "POST", "/_plugins/_sql", params=params, headers=headers, body=body
) )
@@ -197,7 +195,7 @@ class SqlClient(NamespacedClient):
@query_params("error_trace", "filter_path", "format", "human", "pretty", "source") @query_params("error_trace", "filter_path", "format", "human", "pretty", "source")
def settings( def settings(
self, self,
body: Any, body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -206,21 +204,20 @@ class SqlClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. takes a comma-separated list of filters. It supports using wildcards to
:arg format: A short version of the Accept header, e.g. json, match any field or part of a field’s name. You can also exclude fields
yaml. with "-".
:arg format: A short version of the Accept header (for example,
`json`, `yaml`).
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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( return self.transport.perform_request(
"PUT", "PUT",
"/_plugins/_query/settings", "/_plugins/_query/settings",
opensearchpy/plugins/transforms.py
+64 -43
View File
@@ -35,13 +35,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to delete :arg id: Transform to delete
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -68,13 +70,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to explain :arg id: Transform to explain
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -101,13 +105,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to access :arg id: Transform to access
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -124,6 +130,7 @@ class TransformsClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
def preview( def preview(
self, self,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -132,18 +139,24 @@ class TransformsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
return self.transport.perform_request( return self.transport.perform_request(
"GET", "/_plugins/_transform/_preview", params=params, headers=headers "POST",
"/_plugins/_transform/_preview",
params=params,
headers=headers,
body=body,
) )
@query_params( @query_params(
@@ -163,23 +176,25 @@ class TransformsClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Create an index transform, or update a transform if if_seq_no and Create an index transform, or update a transform if `if_seq_no` and
if_primary_term are provided. `if_primary_term` are provided.
:arg id: Transform to create/update :arg id: Transform to create/update
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg if_primary_term: Only perform the operation if the document :arg if_primary_term: Only perform the operation if the document
has this primary term. has this primary term.
:arg if_seq_no: Only perform the operation if the document has :arg if_seq_no: Only perform the operation if the document has
this sequence number. this sequence number.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -216,14 +231,16 @@ class TransformsClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 from_: The starting transform to return. Default is `0`. :arg from_: The starting transform to return. Default is `0`.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg search: The search term to use to filter results. :arg search: The search term to use to filter results.
:arg size: Specifies the number of transforms to return. Default :arg size: Specifies the number of transforms to return. Default
is `10`. is `10`.
@@ -254,13 +271,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to start :arg id: Transform to start
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -287,13 +306,15 @@ class TransformsClient(NamespacedClient):
:arg id: Transform to stop :arg id: Transform to stop
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors. Default is false.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Used to reduce the response. This parameter
the response. 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 :arg human: Whether to return human readable values for
statistics. statistics. Default is True.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response. Default is false.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
test_opensearchpy/test_client/test_overrides.py
+10
View File
@@ -98,6 +98,16 @@ class TestOverriddenUrlTargets(OpenSearchTestCase):
self.client.cluster.stats(node_id="test-node") self.client.cluster.stats(node_id="test-node")
self.assert_url_called("GET", "/_cluster/stats/nodes/test-node") self.assert_url_called("GET", "/_cluster/stats/nodes/test-node")
self.client.cluster.stats(node_id="test-node", metric="indices")
self.assert_url_called("GET", "/_cluster/stats/indices/nodes/test-node")
self.client.cluster.stats(
node_id="test-node", metric="indices", index_metric="analysis"
)
self.assert_url_called(
"GET", "/_cluster/stats/indices/analysis/nodes/test-node"
)
def test_indices_put_mapping(self) -> None: def test_indices_put_mapping(self) -> None:
self.client.indices.put_mapping(body={}) self.client.indices.put_mapping(body={})
self.assert_url_called("PUT", "/_all/_mapping") self.assert_url_called("PUT", "/_all/_mapping")
utils/templates/overrides/cluster/stats
+8 -1
View File
@@ -1,5 +1,12 @@
{% extends "base" %} {% extends "base" %}
{% block func_params %}
node_id: Any = None,
params: Any = None,
headers: Any = None,
metric: Any = None,
index_metric: Any = None,
{% endblock %}
{% block request %} {% block request %}
return await self.transport.perform_request("{{ api.method }}", "/_cluster/stats" if node_id in SKIP_IN_PATH else _make_path("_cluster", "stats", "nodes", node_id), params=params, headers=headers) return await self.transport.perform_request("{{ api.method }}", "/_cluster/stats" if node_id in SKIP_IN_PATH else _make_path("_cluster", "stats", metric, index_metric, "nodes", node_id), params=params, headers=headers)
{% endblock%} {% endblock%}