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

Generate opensearch-py client from API specs (#551)

Browse Source 
Signed-off-by: saimedhi <saimedhi@amazon.com>
This commit is contained in:
Sai Medhini Reddy Maryada
2023-10-26 07:58:33 -07:00
committed by GitHub
parent 59072a67b8
commit 1190079f51
34 changed files with 4496 additions and 3967 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+1
View File
@@ -17,6 +17,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Generate `cluster` client from API specs ([#530](https://github.com/opensearch-project/opensearch-py/pull/530))
- Generate `nodes` client from API specs ([#514](https://github.com/opensearch-project/opensearch-py/pull/514))
- Generate `cat` client from API specs ([#529](https://github.com/opensearch-project/opensearch-py/pull/529))
- Use API generator for all APIs ([#551](https://github.com/opensearch-project/opensearch-py/pull/551))
### Deprecated
- Deprecated point-in-time APIs (list_all_point_in_time, create_point_in_time, delete_point_in_time) and Security Client APIs (health_check and update_audit_config) ([#502](https://github.com/opensearch-project/opensearch-py/pull/502))
### Removed
opensearchpy/_async/client/__init__.py
+522 -565
View File
File diff suppressed because it is too large Load Diff
opensearchpy/_async/client/__init__.pyi
+12 -23
View File
@@ -25,6 +25,15 @@
# specific language governing permissions and limitations
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from __future__ import unicode_literals
import logging
@@ -333,8 +342,8 @@ class AsyncOpenSearch(object):
self,
id: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -490,8 +499,8 @@ class AsyncOpenSearch(object):
self,
id: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -642,8 +651,8 @@ class AsyncOpenSearch(object):
*,
body: Any,
context: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -802,7 +811,6 @@ class AsyncOpenSearch(object):
ignore_unavailable: Optional[Any] = ...,
lenient: Optional[Any] = ...,
max_concurrent_shard_requests: Optional[Any] = ...,
min_compatible_shard_node: Optional[Any] = ...,
pre_filter_shard_size: Optional[Any] = ...,
preference: Optional[Any] = ...,
q: Optional[Any] = ...,
@@ -991,7 +999,6 @@ class AsyncOpenSearch(object):
terminate_after: Optional[Any] = ...,
timeout: Optional[Any] = ...,
version: Optional[Any] = ...,
version_type: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
wait_for_completion: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -1128,21 +1135,3 @@ class AsyncOpenSearch(object):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def terms_enum(
self,
index: Any,
*,
body: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
opensearchpy/_async/client/cat.py
+138 -138
View File
@@ -48,17 +48,17 @@ class CatClient(NamespacedClient):
:arg name: Comma-separated list of alias names.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", _make_path("_cat", "aliases", name), params=params, headers=headers
@@ -83,22 +83,22 @@ class CatClient(NamespacedClient):
:arg node_id: Comma-separated list of node IDs or names to limit
the returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET",
@@ -119,10 +119,10 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", _make_path("_cat", "count", index), params=params, headers=headers
@@ -137,13 +137,13 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg ts: Set to false to disable timestamping. (default: True)
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg ts: Set to false to disable timestamping. Default is True.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/health", params=params, headers=headers
@@ -155,7 +155,7 @@ class CatClient(NamespacedClient):
Returns help for the Cat APIs.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
"""
@@ -187,35 +187,35 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list of indices to limit the
returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg health: Health status ('green', 'yellow', or 'red') to
filter only indices matching the specified health status. Valid
choices: green, yellow, red
:arg help: Return help information. (default: false)
filter only indices matching the specified health status. Valid choices
are green, yellow, red.
:arg help: Return help information. Default is false.
:arg include_unloaded_segments: If set to true segment stats
will include stats for segments that are not currently loaded into
memory. (default: false)
memory. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg pri: Set to true to return stats only for primary shards.
(default: false)
Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", _make_path("_cat", "indices", index), params=params, headers=headers
@@ -241,15 +241,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
from warnings import warn
@@ -280,15 +280,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/cluster_manager", params=params, headers=headers
@@ -312,27 +312,27 @@ class CatClient(NamespacedClient):
Returns basic statistics about performance of cluster nodes.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg full_id: Return the full node ID instead of the shortened
version. (default: false)
version. Default is false.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local (Deprecated: This parameter does not cause this API
to act locally): Return local information, do not retrieve the state
from cluster-manager node. (default: false)
to act locally.): Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/nodes", params=params, headers=headers
@@ -349,20 +349,20 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list or wildcard expression of index
names to limit the returned information.
:arg active_only: If `true`, the response only includes ongoing
shard recoveries. (default: false)
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
shard recoveries. Default is false.
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg detailed: If `true`, the response includes detailed
information about shard recoveries. (default: false)
information about shard recoveries. Default is false.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", _make_path("_cat", "recovery", index), params=params, headers=headers
@@ -387,24 +387,24 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list of indices to limit the
returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", _make_path("_cat", "shards", index), params=params, headers=headers
@@ -427,20 +427,20 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list of indices to limit the
returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", _make_path("_cat", "segments", index), params=params, headers=headers
@@ -467,17 +467,17 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/pending_tasks", params=params, headers=headers
@@ -507,16 +507,16 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg size: The multiplier in which to display values.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET",
@@ -534,15 +534,15 @@ class CatClient(NamespacedClient):
:arg fields: Comma-separated list of fields to return in the
output.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET",
@@ -571,15 +571,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/plugins", params=params, headers=headers
@@ -605,15 +605,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/nodeattrs", params=params, headers=headers
@@ -639,15 +639,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/repositories", params=params, headers=headers
@@ -675,17 +675,18 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg ignore_unavailable: Whether specified concrete indices
should be ignored when unavailable (missing or closed). (default: false)
should be ignored when unavailable (missing or closed). Default is
false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET",
@@ -714,12 +715,12 @@ class CatClient(NamespacedClient):
:arg actions: Comma-separated list of actions that should be
returned. Leave empty to return all.
:arg detailed: Return detailed task information. (default:
false)
:arg detailed: Return detailed task information. Default is
false.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
@@ -728,9 +729,9 @@ class CatClient(NamespacedClient):
(node_id:task_number). Set to -1 to return all.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_cat/tasks", params=params, headers=headers
@@ -757,15 +758,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET", _make_path("_cat", "templates", name), params=params, headers=headers
@@ -787,7 +788,6 @@ class CatClient(NamespacedClient):
List segments for one or several PITs.
:arg body:
"""
return await self.transport.perform_request(
"GET", "/_cat/pit_segments", params=params, headers=headers, body=body
@@ -815,23 +815,23 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list or wildcard expression of index
names to limit the returned information.
:arg active_only: If `true`, the response only includes ongoing
segment replication events. (default: false)
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
segment replication events. Default is false.
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg completed_only: If `true`, the response only includes
latest completed segment replication events. (default: false)
latest completed segment replication events. Default is false.
:arg detailed: If `true`, the response includes detailed
information about segment replications. (default: false)
information about segment replications. Default is false.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg shards: Comma-separated list of shards to display.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return await self.transport.perform_request(
"GET",
opensearchpy/_async/client/cluster.py
+52 -50
View File
@@ -65,22 +65,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg level: Specify the level of detail for returned
information. Valid choices: cluster, indices, shards,
awareness_attributes
information. Valid choices are cluster, indices, shards,
awareness_attributes.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
:arg wait_for_active_shards: Wait until the specified number of
shards is active.
:arg wait_for_events: Wait until all currently queued events
with the given priority are processed. Valid choices: immediate,
urgent, high, normal, low, languid
with the given priority are processed. Valid choices are immediate,
urgent, high, normal, low, languid.
:arg wait_for_no_initializing_shards: Whether to wait until
there are no initializing shards in the cluster.
:arg wait_for_no_relocating_shards: Whether to wait until there
@@ -88,7 +88,7 @@ class ClusterClient(NamespacedClient):
:arg wait_for_nodes: Wait until the specified number of nodes is
available.
:arg wait_for_status: Wait until cluster is in a specific state.
Valid choices: green, yellow, red
Valid choices are green, yellow, red.
"""
return await self.transport.perform_request(
"GET",
@@ -107,10 +107,10 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return await self.transport.perform_request(
"GET", "/_cluster/pending_tasks", params=params, headers=headers
@@ -133,8 +133,8 @@ class ClusterClient(NamespacedClient):
:arg metric: Limit the information returned to the specified
metrics. Valid choices: _all, blocks, metadata, nodes, routing_table,
routing_nodes, master_node, cluster_manager_node, version
metrics. Valid choices are _all, blocks, metadata, nodes, routing_table,
routing_nodes, master_node, cluster_manager_node, version.
:arg index: Comma-separated list of indices; use `_all` or empty
string to perform the operation on all indices.
:arg allow_no_indices: Whether to ignore if a wildcard indices
@@ -143,17 +143,17 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
:arg flat_settings: Return settings in flat format. (default:
false)
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg flat_settings: Return settings in flat format. Default is
false.
:arg ignore_unavailable: Whether specified concrete indices
should be ignored when unavailable (missing or closed).
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg wait_for_metadata_version: Wait for the metadata version to
be equal or greater than the specified metadata version.
:arg wait_for_timeout: The maximum time to wait for
@@ -179,8 +179,8 @@ class ClusterClient(NamespacedClient):
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
nodes.
:arg flat_settings: Return settings in flat format. (default:
false)
:arg flat_settings: Return settings in flat format. Default is
false.
:arg timeout: Operation timeout.
"""
return await self.transport.perform_request(
@@ -215,8 +215,8 @@ class ClusterClient(NamespacedClient):
:arg explain: Return an explanation of why the commands can or
cannot be executed.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg metric: Limit the information returned to the specified
metrics. Defaults to all but metadata.
:arg retry_failed: Retries allocation of shards that are blocked
@@ -241,13 +241,13 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg flat_settings: Return settings in flat format. (default:
false)
:arg flat_settings: Return settings in flat format. Default is
false.
:arg include_defaults: Whether to return all default clusters
setting. (default: false)
setting. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
return await self.transport.perform_request(
@@ -266,11 +266,11 @@ class ClusterClient(NamespacedClient):
or `persistent` (survives cluster restart).
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg flat_settings: Return settings in flat format. (default:
false)
:arg flat_settings: Return settings in flat format. Default is
false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if body in SKIP_IN_PATH:
@@ -299,9 +299,9 @@ class ClusterClient(NamespacedClient):
:arg body: The index, shard, and primary flag to explain. Empty
means 'explain the first unassigned shard'
:arg include_disk_info: Return information about disk usage and
shard sizes. (default: false)
shard sizes. Default is false.
:arg include_yes_decisions: Return 'YES' decisions in
explanation. (default: false)
explanation. Default is false.
"""
return await self.transport.perform_request(
"POST",
@@ -321,8 +321,8 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if name in SKIP_IN_PATH:
@@ -345,10 +345,10 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return await self.transport.perform_request(
"GET",
@@ -368,10 +368,10 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg create: Whether the index template should only be added if
new or can also replace an existing one. (default: false)
new or can also replace an existing one. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
for param in (name, body):
@@ -386,18 +386,20 @@ class ClusterClient(NamespacedClient):
body=body,
)
@query_params("local", "master_timeout")
@query_params("cluster_manager_timeout", "local", "master_timeout")
async def exists_component_template(self, name, params=None, headers=None):
"""
Returns information about whether a particular component template exist.
:arg name: The name of the template.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'name'.")
@@ -417,7 +419,7 @@ class ClusterClient(NamespacedClient):
:arg wait_for_removal: Specifies whether to wait for all
excluded nodes to be removed from the cluster before clearing the voting
configuration exclusions list. (default: True)
configuration exclusions list. Default is True.
"""
return await self.transport.perform_request(
"DELETE",
opensearchpy/_async/client/cluster.pyi
+1
View File
@@ -300,6 +300,7 @@ class ClusterClient(NamespacedClient):
self,
name: Any,
*,
cluster_manager_timeout: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
opensearchpy/_async/client/dangling_indices.py
+4 -4
View File
@@ -53,8 +53,8 @@ class DanglingIndicesClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if index_uuid in SKIP_IN_PATH:
@@ -81,8 +81,8 @@ class DanglingIndicesClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if index_uuid in SKIP_IN_PATH:
opensearchpy/_async/client/indices.py
+487 -626
View File
File diff suppressed because it is too large Load Diff
opensearchpy/_async/client/indices.pyi
+37 -195
View File
@@ -24,6 +24,15 @@
# specific language governing permissions and limitations
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from typing import Any, Collection, MutableMapping, Optional, Tuple, Union
from .utils import NamespacedClient
@@ -94,8 +103,8 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -117,8 +126,8 @@ class IndicesClient(NamespacedClient):
target: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -139,13 +148,13 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
include_defaults: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -164,10 +173,10 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -188,10 +197,10 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -212,10 +221,10 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -259,10 +268,10 @@ class IndicesClient(NamespacedClient):
body: Any,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
write_index_only: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -283,11 +292,11 @@ class IndicesClient(NamespacedClient):
*,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -330,8 +339,8 @@ class IndicesClient(NamespacedClient):
name: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -394,8 +403,8 @@ class IndicesClient(NamespacedClient):
self,
*,
body: Any,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -415,8 +424,8 @@ class IndicesClient(NamespacedClient):
index: Any,
name: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -436,9 +445,9 @@ class IndicesClient(NamespacedClient):
name: Any,
*,
body: Any,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
order: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -457,10 +466,10 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -478,10 +487,10 @@ class IndicesClient(NamespacedClient):
self,
*,
name: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -499,8 +508,8 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -521,13 +530,13 @@ class IndicesClient(NamespacedClient):
index: Optional[Any] = ...,
name: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
include_defaults: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -547,11 +556,11 @@ class IndicesClient(NamespacedClient):
body: Any,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
preserve_existing: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -581,7 +590,6 @@ class IndicesClient(NamespacedClient):
include_segment_file_sizes: Optional[Any] = ...,
include_unloaded_segments: Optional[Any] = ...,
level: Optional[Any] = ...,
types: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -731,26 +739,6 @@ class IndicesClient(NamespacedClient):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def flush_synced(
self,
*,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def shard_stores(
self,
*,
@@ -801,9 +789,9 @@ class IndicesClient(NamespacedClient):
target: Any,
*,
body: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
copy_settings: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -825,9 +813,9 @@ class IndicesClient(NamespacedClient):
target: Any,
*,
body: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
copy_settings: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -849,9 +837,9 @@ class IndicesClient(NamespacedClient):
*,
body: Optional[Any] = ...,
new_index: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
dry_run: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -867,78 +855,11 @@ class IndicesClient(NamespacedClient):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def freeze(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def unfreeze(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def reload_search_analyzers(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def create_data_stream(
self,
name: Any,
*,
body: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -956,7 +877,6 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
expand_wildcards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -974,8 +894,8 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -994,10 +914,10 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1015,10 +935,10 @@ class IndicesClient(NamespacedClient):
self,
*,
name: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1038,9 +958,9 @@ class IndicesClient(NamespacedClient):
*,
body: Any,
cause: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1060,9 +980,9 @@ class IndicesClient(NamespacedClient):
*,
body: Optional[Any] = ...,
cause: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1080,7 +1000,6 @@ class IndicesClient(NamespacedClient):
self,
*,
name: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1100,9 +1019,9 @@ class IndicesClient(NamespacedClient):
body: Optional[Any] = ...,
name: Optional[Any] = ...,
cause: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1140,10 +1059,10 @@ class IndicesClient(NamespacedClient):
block: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -1175,80 +1094,3 @@ class IndicesClient(NamespacedClient):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def promote_data_stream(
self,
name: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def migrate_to_data_stream(
self,
name: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def disk_usage(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flush: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
run_expensive_tasks: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def field_usage_stats(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
fields: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
opensearchpy/_async/client/ingest.py
+7 -7
View File
@@ -50,8 +50,8 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return await self.transport.perform_request(
"GET", _make_path("_ingest", "pipeline", id), params=params, headers=headers
@@ -68,8 +68,8 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
for param in (id, body):
@@ -94,8 +94,8 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if id in SKIP_IN_PATH:
@@ -117,7 +117,7 @@ class IngestClient(NamespacedClient):
:arg body: The simulate definition
:arg id: Pipeline ID.
:arg verbose: Verbose mode. Display data output for each
processor in executed pipeline.
processor in executed pipeline. Default is false.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
opensearchpy/_async/client/nodes.py
+17 -17
View File
@@ -73,10 +73,10 @@ class NodesClient(NamespacedClient):
node you're connecting to, leave empty to get information from all
nodes.
:arg metric: Comma-separated list of metrics you wish returned.
Leave empty to return all. Valid choices: settings, os, process, jvm,
thread_pool, transport, http, plugins, ingest
:arg flat_settings: Return settings in flat format. (default:
false)
Leave empty to return all. Valid choices are settings, os, process, jvm,
thread_pool, transport, http, plugins, ingest.
:arg flat_settings: Return settings in flat format. Default is
false.
:arg timeout: Operation timeout.
"""
return await self.transport.perform_request(
@@ -105,13 +105,13 @@ class NodesClient(NamespacedClient):
node you're connecting to, leave empty to get information from all
nodes.
:arg metric: Limit the information returned to the specified
metrics. Valid choices: _all, breaker, fs, http, indices, jvm, os,
process, thread_pool, transport, discovery, indexing_pressure
metrics. Valid choices are _all, breaker, fs, http, indices, jvm, os,
process, thread_pool, transport, discovery, indexing_pressure.
:arg index_metric: Limit the information returned for `indices`
metric to the specific index metrics. Isn't used if `indices` (or `all`)
metric isn't specified. Valid choices: _all, store, indexing, get,
metric isn't specified. Valid choices are _all, store, indexing, get,
search, merge, flush, refresh, query_cache, fielddata, docs, warmer,
completion, segments, translog, suggest, request_cache, recovery
completion, segments, translog, suggest, request_cache, recovery.
:arg completion_fields: Comma-separated list of fields for
`fielddata` and `suggest` index metric (supports wildcards).
:arg fielddata_fields: Comma-separated list of fields for
@@ -122,9 +122,9 @@ class NodesClient(NamespacedClient):
index metric.
:arg include_segment_file_sizes: Whether to report the
aggregated disk usage of each one of the Lucene index files (only
applies if segment stats are requested). (default: false)
applies if segment stats are requested). Default is false.
:arg level: Return indices stats aggregated at index, node or
shard level. Valid choices: indices, node, shards
shard level. Valid choices are indices, node, shards.
:arg timeout: Operation timeout.
:arg types: Comma-separated list of document types for the
`indexing` index metric.
@@ -148,16 +148,16 @@ class NodesClient(NamespacedClient):
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
nodes.
:arg doc_type: The type to sample. Valid choices: cpu, wait,
block
:arg doc_type: The type to sample. Valid choices are cpu, wait,
block.
:arg ignore_idle_threads: Don't show threads that are in known-
idle places, such as waiting on a socket select or pulling from an empty
task queue. (default: True)
task queue. Default is True.
:arg interval: The interval for the second sampling of threads.
:arg snapshots: Number of samples of thread stacktrace.
(default: 10)
:arg snapshots: Number of samples of thread stacktrace. Default
is 10.
:arg threads: Specify the number of threads to provide
information for. (default: 3)
information for. Default is 3.
:arg timeout: Operation timeout.
"""
# type is a reserved word so it cannot be used, use doc_type instead
@@ -182,7 +182,7 @@ class NodesClient(NamespacedClient):
node you're connecting to, leave empty to get information from all
nodes.
:arg metric: Limit the information returned to the specified
metrics. Valid choices: _all, rest_actions
metrics. Valid choices are _all, rest_actions.
:arg timeout: Operation timeout.
"""
return await self.transport.perform_request(
opensearchpy/_async/client/security.py
+156 -63
View File
@@ -7,6 +7,17 @@
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
@@ -17,25 +28,25 @@ class SecurityClient(NamespacedClient):
async def get_account_details(self, params=None, headers=None):
"""
Returns account details for the current user.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "account"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/account", params=params, headers=headers
)
@query_params()
async def change_password(self, body, params=None, headers=None):
"""
Changes the password for the current user.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PUT",
_make_path("_plugins", "_security", "api", "account"),
"/_plugins/_security/api/account",
params=params,
headers=headers,
body=body,
@@ -45,10 +56,13 @@ class SecurityClient(NamespacedClient):
async def get_action_group(self, action_group, params=None, headers=None):
"""
Retrieves one action group.
:arg action_group: Action group to retrieve.
"""
if action_group in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'action-group'."
"Empty value passed for a required argument 'action_group'."
)
return await self.transport.perform_request(
@@ -62,10 +76,11 @@ class SecurityClient(NamespacedClient):
async def get_action_groups(self, params=None, headers=None):
"""
Retrieves all action groups.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "actiongroups"),
"/_plugins/_security/api/actiongroups/",
params=params,
headers=headers,
)
@@ -73,11 +88,14 @@ class SecurityClient(NamespacedClient):
@query_params()
async def delete_action_group(self, action_group, params=None, headers=None):
"""
Deletes the specified action group.
Delete a specified action group.
:arg action_group: Action group to delete.
"""
if action_group in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'action-group'."
"Empty value passed for a required argument 'action_group'."
)
return await self.transport.perform_request(
@@ -91,6 +109,10 @@ class SecurityClient(NamespacedClient):
async def create_action_group(self, action_group, body, params=None, headers=None):
"""
Creates or replaces the specified action group.
:arg action_group: The name of the action group to create or
replace
"""
for param in (action_group, body):
if param in SKIP_IN_PATH:
@@ -108,6 +130,8 @@ class SecurityClient(NamespacedClient):
async def patch_action_group(self, action_group, body, params=None, headers=None):
"""
Updates individual attributes of an action group.
"""
for param in (action_group, body):
if param in SKIP_IN_PATH:
@@ -125,13 +149,15 @@ class SecurityClient(NamespacedClient):
async def patch_action_groups(self, body, params=None, headers=None):
"""
Creates, updates, or deletes multiple action groups in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "actiongroups"),
"/_plugins/_security/api/actiongroups",
params=params,
headers=headers,
body=body,
@@ -140,7 +166,9 @@ class SecurityClient(NamespacedClient):
@query_params()
async def get_user(self, username, params=None, headers=None):
"""
Retrieves one user.
Retrieve one internal user.
"""
if username in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'username'.")
@@ -155,11 +183,12 @@ class SecurityClient(NamespacedClient):
@query_params()
async def get_users(self, params=None, headers=None):
"""
Retrieves all users.
Retrieve all internal users.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "internalusers"),
"/_plugins/_security/api/internalusers",
params=params,
headers=headers,
)
@@ -167,7 +196,9 @@ class SecurityClient(NamespacedClient):
@query_params()
async def delete_user(self, username, params=None, headers=None):
"""
Deletes the specified user.
Delete the specified user.
"""
if username in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'username'.")
@@ -183,6 +214,8 @@ class SecurityClient(NamespacedClient):
async def create_user(self, username, body, params=None, headers=None):
"""
Creates or replaces the specified user.
"""
for param in (username, body):
if param in SKIP_IN_PATH:
@@ -200,6 +233,8 @@ class SecurityClient(NamespacedClient):
async def patch_user(self, username, body, params=None, headers=None):
"""
Updates individual attributes of an internal user.
"""
for param in (username, body):
if param in SKIP_IN_PATH:
@@ -217,13 +252,15 @@ class SecurityClient(NamespacedClient):
async def patch_users(self, body, params=None, headers=None):
"""
Creates, updates, or deletes multiple internal users in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "internalusers"),
"/_plugins/_security/api/internalusers",
params=params,
headers=headers,
body=body,
@@ -233,6 +270,8 @@ class SecurityClient(NamespacedClient):
async def get_role(self, role, params=None, headers=None):
"""
Retrieves one role.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -248,18 +287,18 @@ class SecurityClient(NamespacedClient):
async def get_roles(self, params=None, headers=None):
"""
Retrieves all roles.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "roles"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/roles/", params=params, headers=headers
)
@query_params()
async def delete_role(self, role, params=None, headers=None):
"""
Deletes the specified role.
Delete the specified role.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -275,6 +314,8 @@ class SecurityClient(NamespacedClient):
async def create_role(self, role, body, params=None, headers=None):
"""
Creates or replaces the specified role.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -292,6 +333,8 @@ class SecurityClient(NamespacedClient):
async def patch_role(self, role, body, params=None, headers=None):
"""
Updates individual attributes of a role.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -309,13 +352,15 @@ class SecurityClient(NamespacedClient):
async def patch_roles(self, body, params=None, headers=None):
"""
Creates, updates, or deletes multiple roles in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "roles"),
"/_plugins/_security/api/roles",
params=params,
headers=headers,
body=body,
@@ -325,6 +370,8 @@ class SecurityClient(NamespacedClient):
async def get_role_mapping(self, role, params=None, headers=None):
"""
Retrieves one role mapping.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -340,10 +387,11 @@ class SecurityClient(NamespacedClient):
async def get_role_mappings(self, params=None, headers=None):
"""
Retrieves all role mappings.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "rolesmapping"),
"/_plugins/_security/api/rolesmapping",
params=params,
headers=headers,
)
@@ -352,6 +400,8 @@ class SecurityClient(NamespacedClient):
async def delete_role_mapping(self, role, params=None, headers=None):
"""
Deletes the specified role mapping.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -367,6 +417,8 @@ class SecurityClient(NamespacedClient):
async def create_role_mapping(self, role, body, params=None, headers=None):
"""
Creates or replaces the specified role mapping.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -384,6 +436,8 @@ class SecurityClient(NamespacedClient):
async def patch_role_mapping(self, role, body, params=None, headers=None):
"""
Updates individual attributes of a role mapping.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -401,13 +455,15 @@ class SecurityClient(NamespacedClient):
async def patch_role_mappings(self, body, params=None, headers=None):
"""
Creates or updates multiple role mappings in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "rolesmapping"),
"/_plugins/_security/api/rolesmapping",
params=params,
headers=headers,
body=body,
@@ -417,6 +473,8 @@ class SecurityClient(NamespacedClient):
async def get_tenant(self, tenant, params=None, headers=None):
"""
Retrieves one tenant.
"""
if tenant in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'tenant'.")
@@ -432,18 +490,18 @@ class SecurityClient(NamespacedClient):
async def get_tenants(self, params=None, headers=None):
"""
Retrieves all tenants.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "tenants"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/tenants/", params=params, headers=headers
)
@query_params()
async def delete_tenant(self, tenant, params=None, headers=None):
"""
Deletes the specified tenant.
Delete the specified tenant.
"""
if tenant in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'tenant'.")
@@ -459,6 +517,8 @@ class SecurityClient(NamespacedClient):
async def create_tenant(self, tenant, body, params=None, headers=None):
"""
Creates or replaces the specified tenant.
"""
for param in (tenant, body):
if param in SKIP_IN_PATH:
@@ -476,6 +536,8 @@ class SecurityClient(NamespacedClient):
async def patch_tenant(self, tenant, body, params=None, headers=None):
"""
Add, delete, or modify a single tenant.
"""
for param in (tenant, body):
if param in SKIP_IN_PATH:
@@ -493,13 +555,15 @@ class SecurityClient(NamespacedClient):
async def patch_tenants(self, body, params=None, headers=None):
"""
Add, delete, or modify multiple tenants in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "tenants"),
"/_plugins/_security/api/tenants/",
params=params,
headers=headers,
body=body,
@@ -508,11 +572,12 @@ class SecurityClient(NamespacedClient):
@query_params()
async def get_configuration(self, params=None, headers=None):
"""
Retrieves the current Security plugin configuration in JSON format.
Returns the current Security plugin configuration in JSON format.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "securityconfig"),
"/_plugins/_security/api/securityconfig",
params=params,
headers=headers,
)
@@ -520,14 +585,16 @@ class SecurityClient(NamespacedClient):
@query_params()
async def update_configuration(self, body, params=None, headers=None):
"""
Retrieves the current Security plugin configuration in JSON format.
Adds or updates the existing configuration using the REST API.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PUT",
_make_path("_plugins", "_security", "api", "securityconfig", "config"),
"/_plugins/_security/api/securityconfig/config",
params=params,
headers=headers,
body=body,
@@ -536,14 +603,16 @@ class SecurityClient(NamespacedClient):
@query_params()
async def patch_configuration(self, body, params=None, headers=None):
"""
Updates the existing configuration using the REST API.
A PATCH call is used to update the existing configuration using the REST API.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "securityconfig"),
"/_plugins/_security/api/securityconfig",
params=params,
headers=headers,
body=body,
@@ -555,6 +624,8 @@ class SecurityClient(NamespacedClient):
):
"""
Retrieves all distinguished names in the allow list.
"""
return await self.transport.perform_request(
"GET",
@@ -565,14 +636,18 @@ class SecurityClient(NamespacedClient):
@query_params()
async def update_distinguished_names(
self, cluster_name, body, params=None, headers=None
self, cluster_name, body=None, params=None, headers=None
):
"""
Adds or updates the specified distinguished names in the cluster's or node's allow list.
Adds or updates the specified distinguished names in the cluster’s or node’s
allow list.
"""
for param in (cluster_name, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
if cluster_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'cluster_name'."
)
return await self.transport.perform_request(
"PUT",
@@ -585,11 +660,14 @@ class SecurityClient(NamespacedClient):
@query_params()
async def delete_distinguished_names(self, cluster_name, params=None, headers=None):
"""
Deletes all distinguished names in the specified cluster's or node's allow list.
Deletes all distinguished names in the specified cluster’s or node’s allow
list.
"""
if cluster_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'cluster-name'."
"Empty value passed for a required argument 'cluster_name'."
)
return await self.transport.perform_request(
@@ -602,25 +680,22 @@ class SecurityClient(NamespacedClient):
@query_params()
async def get_certificates(self, params=None, headers=None):
"""
Retrieves the cluster's security certificates.
Retrieves the cluster’s security certificates.
"""
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "ssl", "certs"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/ssl/certs", params=params, headers=headers
)
@query_params()
async def reload_transport_certificates(self, params=None, headers=None):
"""
Reloads SSL certificates that are about to expire without restarting the OpenSearch node.
Reload transport layer communication certificates.
"""
return await self.transport.perform_request(
"PUT",
_make_path(
"_opendistro", "_security", "api", "ssl", "transport", "reloadcerts"
),
"/_plugins/_security/api/ssl/transport/reloadcerts",
params=params,
headers=headers,
)
@@ -628,11 +703,12 @@ class SecurityClient(NamespacedClient):
@query_params()
async def reload_http_certificates(self, params=None, headers=None):
"""
Reloads SSL certificates that are about to expire without restarting the OpenSearch node.
Reload HTTP layer communication certificates.
"""
return await self.transport.perform_request(
"PUT",
_make_path("_opendistro", "_security", "api", "ssl", "http", "reloadcerts"),
"/_plugins/_security/api/ssl/http/reloadcerts",
params=params,
headers=headers,
)
@@ -641,12 +717,10 @@ class SecurityClient(NamespacedClient):
async def flush_cache(self, params=None, headers=None):
"""
Flushes the Security plugin user, authentication, and authorization cache.
"""
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_security", "api", "cache"),
params=params,
headers=headers,
"DELETE", "/_plugins/_security/api/cache", params=params, headers=headers
)
@query_params()
@@ -662,13 +736,11 @@ class SecurityClient(NamespacedClient):
@query_params()
async def get_audit_configuration(self, params=None, headers=None):
"""
A GET call retrieves the audit configuration.
Retrieves the audit configuration.
"""
return await self.transport.perform_request(
"GET",
_make_path("_opendistro", "_security", "api", "audit"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/audit", params=params, headers=headers
)
@query_params()
@@ -676,6 +748,7 @@ class SecurityClient(NamespacedClient):
"""
Updates the audit configuration.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
@@ -692,13 +765,33 @@ class SecurityClient(NamespacedClient):
async def patch_audit_configuration(self, body, params=None, headers=None):
"""
A PATCH call is used to update specified fields in the audit configuration.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
_make_path("_opendistro", "_security", "api", "audit"),
"/_plugins/_security/api/audit",
params=params,
headers=headers,
body=body,
)
@query_params()
async def patch_distinguished_names(self, body, params=None, headers=None):
"""
Bulk update of distinguished names.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PATCH",
"/_plugins/_security/api/nodesdn",
params=params,
headers=headers,
body=body,
opensearchpy/_async/client/security.pyi
+650 -63
View File
@@ -6,191 +6,734 @@
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from typing import Any, Collection, MutableMapping, Optional, Tuple, Union
from .utils import NamespacedClient as NamespacedClient
from .utils import NamespacedClient
class SecurityClient(NamespacedClient):
async def get_account_details(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def change_password(
self,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_action_group(
self,
action_group: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_action_groups(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def delete_action_group(
self,
action_group: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def create_action_group(
self,
action_group: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_action_group(
self,
action_group: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_action_groups(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_user(
self,
username: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_users(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def delete_user(
self,
username: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def create_user(
self,
username: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_user(
self,
username: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_users(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_roles(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def delete_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def create_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_roles(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_role_mappings(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def delete_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def create_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_role_mappings(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_tenant(
self,
tenant: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_tenants(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def delete_tenant(
self,
tenant: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def create_tenant(
self,
tenant: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_tenant(
self,
tenant: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_tenants(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_configuration(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def update_configuration(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_configuration(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_distinguished_names(
self,
cluster_name: Union[Any, None] = ...,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
cluster_name: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def update_distinguished_names(
self,
cluster_name: Any,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
body: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def delete_distinguished_names(
self,
cluster_name: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_certificates(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def reload_transport_certificates(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def reload_http_certificates(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def flush_cache(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def health(
self,
@@ -209,7 +752,20 @@ class SecurityClient(NamespacedClient):
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def get_audit_configuration(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def update_audit_configuration(
self,
@@ -229,5 +785,36 @@ class SecurityClient(NamespacedClient):
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_audit_configuration(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def patch_distinguished_names(
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
opensearchpy/_async/client/snapshot.py
+104 -145
View File
@@ -25,25 +25,36 @@
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class SnapshotClient(NamespacedClient):
@query_params("master_timeout", "cluster_manager_timeout", "wait_for_completion")
@query_params("cluster_manager_timeout", "master_timeout", "wait_for_completion")
async def create(self, repository, snapshot, body=None, params=None, headers=None):
"""
Creates a snapshot in a repository.
:arg repository: A repository name
:arg snapshot: A snapshot name
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg body: The snapshot definition
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning
operation has completed before returning. Default is false.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -57,18 +68,19 @@ class SnapshotClient(NamespacedClient):
body=body,
)
@query_params("master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "master_timeout")
async def delete(self, repository, snapshot, params=None, headers=None):
"""
Deletes a snapshot.
:arg repository: A repository name
:arg snapshot: A snapshot name
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -82,33 +94,25 @@ class SnapshotClient(NamespacedClient):
)
@query_params(
"ignore_unavailable",
"include_repository",
"index_details",
"master_timeout",
"cluster_manager_timeout",
"verbose",
"cluster_manager_timeout", "ignore_unavailable", "master_timeout", "verbose"
)
async def get(self, repository, snapshot, params=None, headers=None):
"""
Returns information about a snapshot.
:arg repository: A repository name
:arg snapshot: A comma-separated list of snapshot names
:arg repository: Repository name.
:arg snapshot: Comma-separated list of snapshot names.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg ignore_unavailable: Whether to ignore unavailable
snapshots, defaults to false which means a SnapshotMissingException is
thrown
:arg include_repository: Whether to include the repository name
in the snapshot info. Defaults to true.
:arg index_details: Whether to include details of each index in
the snapshot, if those details are available. Defaults to false.
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
thrown. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg verbose: Whether to show verbose snapshot info or only show
the basic info found in the repository index blob
the basic info found in the repository index blob.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -121,7 +125,7 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout")
@query_params("cluster_manager_timeout", "master_timeout", "timeout")
async def delete_repository(self, repository, params=None, headers=None):
"""
Deletes a repository.
@@ -129,11 +133,12 @@ class SnapshotClient(NamespacedClient):
:arg repository: Name of the snapshot repository to unregister.
Wildcard (`*`) patterns are supported.
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
@@ -145,38 +150,40 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("local", "master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "local", "master_timeout")
async def get_repository(self, repository=None, params=None, headers=None):
"""
Returns information about a repository.
:arg repository: A comma-separated list of repository names
:arg repository: Comma-separated list of repository names.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster_manager node (default: false)
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return await self.transport.perform_request(
"GET", _make_path("_snapshot", repository), params=params, headers=headers
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout", "verify")
@query_params("cluster_manager_timeout", "master_timeout", "timeout", "verify")
async def create_repository(self, repository, body, params=None, headers=None):
"""
Creates a repository.
:arg repository: A repository name
:arg repository: Repository name.
:arg body: The repository definition
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg verify: Whether to verify the repository after creation
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
:arg verify: Whether to verify the repository after creation.
"""
for param in (repository, body):
if param in SKIP_IN_PATH:
@@ -190,21 +197,22 @@ class SnapshotClient(NamespacedClient):
body=body,
)
@query_params("master_timeout", "cluster_manager_timeout", "wait_for_completion")
@query_params("cluster_manager_timeout", "master_timeout", "wait_for_completion")
async def restore(self, repository, snapshot, body=None, params=None, headers=None):
"""
Restores a snapshot.
:arg repository: A repository name
:arg snapshot: A snapshot name
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg body: Details of what to restore
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning
operation has completed before returning. Default is false.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -218,21 +226,22 @@ class SnapshotClient(NamespacedClient):
body=body,
)
@query_params("ignore_unavailable", "master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "ignore_unavailable", "master_timeout")
async def status(self, repository=None, snapshot=None, params=None, headers=None):
"""
Returns information about the status of a snapshot.
:arg repository: A repository name
:arg snapshot: A comma-separated list of snapshot names
:arg repository: Repository name.
:arg snapshot: Comma-separated list of snapshot names.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg ignore_unavailable: Whether to ignore unavailable
snapshots, defaults to false which means a SnapshotMissingException is
thrown
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
thrown. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return await self.transport.perform_request(
"GET",
@@ -241,18 +250,19 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout")
@query_params("cluster_manager_timeout", "master_timeout", "timeout")
async def verify_repository(self, repository, params=None, headers=None):
"""
Verifies a repository.
:arg repository: A repository name
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg repository: Repository name.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
@@ -264,18 +274,19 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout")
@query_params("cluster_manager_timeout", "master_timeout", "timeout")
async def cleanup_repository(self, repository, params=None, headers=None):
"""
Removes stale data from repository.
:arg repository: A repository name
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg repository: Repository name.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
@@ -287,7 +298,7 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "master_timeout")
async def clone(
self, repository, snapshot, target_snapshot, body, params=None, headers=None
):
@@ -295,14 +306,15 @@ class SnapshotClient(NamespacedClient):
Clones indices from one snapshot into another snapshot in the same repository.
:arg repository: A repository name
:arg snapshot: The name of the snapshot to clone from
:arg target_snapshot: The name of the cloned snapshot to create
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg target_snapshot: The name of the cloned snapshot to create.
:arg body: The snapshot clone definition
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
for param in (repository, snapshot, target_snapshot, body):
if param in SKIP_IN_PATH:
@@ -315,56 +327,3 @@ class SnapshotClient(NamespacedClient):
headers=headers,
body=body,
)
@query_params(
"blob_count",
"concurrency",
"detailed",
"early_read_node_count",
"max_blob_size",
"max_total_data_size",
"rare_action_probability",
"rarely_abort_writes",
"read_node_count",
"seed",
"timeout",
)
async def repository_analyze(self, repository, params=None, headers=None):
"""
Analyzes a repository for correctness and performance
:arg repository: A repository name
:arg blob_count: Number of blobs to create during the test.
Defaults to 100.
:arg concurrency: Number of operations to run concurrently
during the test. Defaults to 10.
:arg detailed: Whether to return detailed results or a summary.
Defaults to 'false' so that only the summary is returned.
:arg early_read_node_count: Number of nodes on which to perform
an early read on a blob, i.e. before writing has completed. Early reads
are rare actions so the 'rare_action_probability' parameter is also
relevant. Defaults to 2.
:arg max_blob_size: Maximum size of a blob to create during the
test, e.g '1gb' or '100mb'. Defaults to '10mb'.
:arg max_total_data_size: Maximum total size of all blobs to
create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'.
:arg rare_action_probability: Probability of taking a rare
action such as an early read or an overwrite. Defaults to 0.02.
:arg rarely_abort_writes: Whether to rarely abort writes before
they complete. Defaults to 'true'.
:arg read_node_count: Number of nodes on which to read a blob
after writing. Defaults to 10.
:arg seed: Seed for the random number generator used to create
the test workload. Defaults to a random value.
:arg timeout: Explicit operation timeout. Defaults to '30s'.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
return await self.transport.perform_request(
"POST",
_make_path("_snapshot", repository, "_analyze"),
params=params,
headers=headers,
)
opensearchpy/_async/client/snapshot.pyi
+21 -42
View File
@@ -24,6 +24,15 @@
# specific language governing permissions and limitations
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from typing import Any, Collection, MutableMapping, Optional, Tuple, Union
from .utils import NamespacedClient
@@ -35,8 +44,8 @@ class SnapshotClient(NamespacedClient):
snapshot: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
wait_for_completion: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -56,8 +65,8 @@ class SnapshotClient(NamespacedClient):
repository: Any,
snapshot: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -76,11 +85,9 @@ class SnapshotClient(NamespacedClient):
repository: Any,
snapshot: Any,
*,
ignore_unavailable: Optional[Any] = ...,
include_repository: Optional[Any] = ...,
index_details: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
verbose: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -99,8 +106,8 @@ class SnapshotClient(NamespacedClient):
self,
repository: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -119,9 +126,9 @@ class SnapshotClient(NamespacedClient):
self,
*,
repository: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -140,8 +147,8 @@ class SnapshotClient(NamespacedClient):
repository: Any,
*,
body: Any,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
verify: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -163,8 +170,8 @@ class SnapshotClient(NamespacedClient):
snapshot: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
wait_for_completion: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -184,9 +191,9 @@ class SnapshotClient(NamespacedClient):
*,
repository: Optional[Any] = ...,
snapshot: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -204,8 +211,8 @@ class SnapshotClient(NamespacedClient):
self,
repository: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -224,8 +231,8 @@ class SnapshotClient(NamespacedClient):
self,
repository: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -247,36 +254,8 @@ class SnapshotClient(NamespacedClient):
target_snapshot: Any,
*,
body: Any,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
async def repository_analyze(
self,
repository: Any,
*,
blob_count: Optional[Any] = ...,
concurrency: Optional[Any] = ...,
detailed: Optional[Any] = ...,
early_read_node_count: Optional[Any] = ...,
max_blob_size: Optional[Any] = ...,
max_total_data_size: Optional[Any] = ...,
rare_action_probability: Optional[Any] = ...,
rarely_abort_writes: Optional[Any] = ...,
read_node_count: Optional[Any] = ...,
seed: Optional[Any] = ...,
timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
opensearchpy/_async/client/tasks.py
+6 -5
View File
@@ -57,9 +57,10 @@ class TasksClient(NamespacedClient):
:arg actions: Comma-separated list of actions that should be
returned. Leave empty to return all.
:arg detailed: Return detailed task information.
:arg detailed: Return detailed task information. Default is
false.
:arg group_by: Group tasks by nodes or parent/child
relationships. Valid choices: nodes, parents, none
relationships. Valid choices are nodes, parents, none.
:arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
@@ -68,7 +69,7 @@ class TasksClient(NamespacedClient):
(node_id:task_number). Set to -1 to return all.
:arg timeout: Operation timeout.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning.
operation has completed before returning. Default is false.
"""
return await self.transport.perform_request(
"GET", "/_tasks", params=params, headers=headers
@@ -91,7 +92,7 @@ class TasksClient(NamespacedClient):
:arg parent_task_id: Cancel tasks with specified parent task id
(node_id:task_number). Set to -1 to cancel all.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning.
operation has completed before returning. Default is false.
"""
return await self.transport.perform_request(
"POST",
@@ -110,7 +111,7 @@ class TasksClient(NamespacedClient):
(node_id:task_number).
:arg timeout: Operation timeout.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning.
operation has completed before returning. Default is false.
"""
if task_id in SKIP_IN_PATH:
warnings.warn(
opensearchpy/client/__init__.py
+522 -567
View File
File diff suppressed because it is too large Load Diff
opensearchpy/client/__init__.pyi
+16 -24
View File
@@ -25,6 +25,15 @@
# specific language governing permissions and limitations
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from __future__ import unicode_literals
import logging
@@ -59,7 +68,10 @@ class OpenSearch(object):
snapshot: SnapshotClient
tasks: TasksClient
def __init__(
self, hosts: Any = ..., transport_class: Type[Transport] = ..., **kwargs: Any
self,
hosts: Any = ...,
transport_class: Type[Transport] = ...,
**kwargs: Any,
) -> None: ...
def __repr__(self) -> str: ...
def __enter__(self) -> "OpenSearch": ...
@@ -330,8 +342,8 @@ class OpenSearch(object):
self,
id: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -487,8 +499,8 @@ class OpenSearch(object):
self,
id: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -639,8 +651,8 @@ class OpenSearch(object):
*,
body: Any,
context: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -799,7 +811,6 @@ class OpenSearch(object):
ignore_unavailable: Optional[Any] = ...,
lenient: Optional[Any] = ...,
max_concurrent_shard_requests: Optional[Any] = ...,
min_compatible_shard_node: Optional[Any] = ...,
pre_filter_shard_size: Optional[Any] = ...,
preference: Optional[Any] = ...,
q: Optional[Any] = ...,
@@ -988,7 +999,6 @@ class OpenSearch(object):
terminate_after: Optional[Any] = ...,
timeout: Optional[Any] = ...,
version: Optional[Any] = ...,
version_type: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
wait_for_completion: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -1125,21 +1135,3 @@ class OpenSearch(object):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def terms_enum(
self,
index: Any,
*,
body: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
opensearchpy/client/_patch.pyi
+1
View File
@@ -6,6 +6,7 @@
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
from typing import Any, Collection, MutableMapping, Optional, Tuple, Type, Union
def list_all_point_in_time(
opensearchpy/client/cat.py
+138 -138
View File
@@ -48,17 +48,17 @@ class CatClient(NamespacedClient):
:arg name: Comma-separated list of alias names.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_cat", "aliases", name), params=params, headers=headers
@@ -83,22 +83,22 @@ class CatClient(NamespacedClient):
:arg node_id: Comma-separated list of node IDs or names to limit
the returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET",
@@ -119,10 +119,10 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_cat", "count", index), params=params, headers=headers
@@ -137,13 +137,13 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg ts: Set to false to disable timestamping. (default: True)
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg ts: Set to false to disable timestamping. Default is True.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/health", params=params, headers=headers
@@ -155,7 +155,7 @@ class CatClient(NamespacedClient):
Returns help for the Cat APIs.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
"""
@@ -187,35 +187,35 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list of indices to limit the
returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg health: Health status ('green', 'yellow', or 'red') to
filter only indices matching the specified health status. Valid
choices: green, yellow, red
:arg help: Return help information. (default: false)
filter only indices matching the specified health status. Valid choices
are green, yellow, red.
:arg help: Return help information. Default is false.
:arg include_unloaded_segments: If set to true segment stats
will include stats for segments that are not currently loaded into
memory. (default: false)
memory. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg pri: Set to true to return stats only for primary shards.
(default: false)
Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_cat", "indices", index), params=params, headers=headers
@@ -241,15 +241,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
from warnings import warn
@@ -280,15 +280,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/cluster_manager", params=params, headers=headers
@@ -312,27 +312,27 @@ class CatClient(NamespacedClient):
Returns basic statistics about performance of cluster nodes.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg full_id: Return the full node ID instead of the shortened
version. (default: false)
version. Default is false.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local (Deprecated: This parameter does not cause this API
to act locally): Return local information, do not retrieve the state
from cluster-manager node. (default: false)
to act locally.): Return local information, do not retrieve the state
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/nodes", params=params, headers=headers
@@ -349,20 +349,20 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list or wildcard expression of index
names to limit the returned information.
:arg active_only: If `true`, the response only includes ongoing
shard recoveries. (default: false)
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
shard recoveries. Default is false.
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg detailed: If `true`, the response includes detailed
information about shard recoveries. (default: false)
information about shard recoveries. Default is false.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_cat", "recovery", index), params=params, headers=headers
@@ -387,24 +387,24 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list of indices to limit the
returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_cat", "shards", index), params=params, headers=headers
@@ -427,20 +427,20 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list of indices to limit the
returned information.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_cat", "segments", index), params=params, headers=headers
@@ -467,17 +467,17 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/pending_tasks", params=params, headers=headers
@@ -507,16 +507,16 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg size: The multiplier in which to display values.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET",
@@ -534,15 +534,15 @@ class CatClient(NamespacedClient):
:arg fields: Comma-separated list of fields to return in the
output.
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET",
@@ -571,15 +571,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/plugins", params=params, headers=headers
@@ -605,15 +605,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/nodeattrs", params=params, headers=headers
@@ -639,15 +639,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/repositories", params=params, headers=headers
@@ -675,17 +675,18 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg ignore_unavailable: Whether specified concrete indices
should be ignored when unavailable (missing or closed). (default: false)
should be ignored when unavailable (missing or closed). Default is
false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET",
@@ -714,12 +715,12 @@ class CatClient(NamespacedClient):
:arg actions: Comma-separated list of actions that should be
returned. Leave empty to return all.
:arg detailed: Return detailed task information. (default:
false)
:arg detailed: Return detailed task information. Default is
false.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
@@ -728,9 +729,9 @@ class CatClient(NamespacedClient):
(node_id:task_number). Set to -1 to return all.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", "/_cat/tasks", params=params, headers=headers
@@ -757,15 +758,15 @@ class CatClient(NamespacedClient):
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg v: Verbose mode. Display column headers. (default: false)
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET", _make_path("_cat", "templates", name), params=params, headers=headers
@@ -787,7 +788,6 @@ class CatClient(NamespacedClient):
List segments for one or several PITs.
:arg body:
"""
return self.transport.perform_request(
"GET", "/_cat/pit_segments", params=params, headers=headers, body=body
@@ -815,23 +815,23 @@ class CatClient(NamespacedClient):
:arg index: Comma-separated list or wildcard expression of index
names to limit the returned information.
:arg active_only: If `true`, the response only includes ongoing
segment replication events. (default: false)
:arg bytes: The unit in which to display byte values. Valid
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
segment replication events. Default is false.
:arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb.
:arg completed_only: If `true`, the response only includes
latest completed segment replication events. (default: false)
latest completed segment replication events. Default is false.
:arg detailed: If `true`, the response includes detailed
information about segment replications. (default: false)
information about segment replications. Default is false.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg h: Comma-separated list of column names to display.
:arg help: Return help information. (default: false)
:arg help: Return help information. Default is false.
:arg s: Comma-separated list of column names or column aliases
to sort by.
:arg shards: Comma-separated list of shards to display.
:arg time: The unit in which to display time values. Valid
choices: d, h, m, s, ms, micros, nanos
:arg v: Verbose mode. Display column headers. (default: false)
:arg time: The unit in which to display time values. Valid
choices are d, h, m, s, ms, micros, nanos.
:arg v: Verbose mode. Display column headers. Default is false.
"""
return self.transport.perform_request(
"GET",
opensearchpy/client/cluster.py
+52 -50
View File
@@ -65,22 +65,22 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg level: Specify the level of detail for returned
information. Valid choices: cluster, indices, shards,
awareness_attributes
information. Valid choices are cluster, indices, shards,
awareness_attributes.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
:arg wait_for_active_shards: Wait until the specified number of
shards is active.
:arg wait_for_events: Wait until all currently queued events
with the given priority are processed. Valid choices: immediate,
urgent, high, normal, low, languid
with the given priority are processed. Valid choices are immediate,
urgent, high, normal, low, languid.
:arg wait_for_no_initializing_shards: Whether to wait until
there are no initializing shards in the cluster.
:arg wait_for_no_relocating_shards: Whether to wait until there
@@ -88,7 +88,7 @@ class ClusterClient(NamespacedClient):
:arg wait_for_nodes: Wait until the specified number of nodes is
available.
:arg wait_for_status: Wait until cluster is in a specific state.
Valid choices: green, yellow, red
Valid choices are green, yellow, red.
"""
return self.transport.perform_request(
"GET",
@@ -107,10 +107,10 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return self.transport.perform_request(
"GET", "/_cluster/pending_tasks", params=params, headers=headers
@@ -133,8 +133,8 @@ class ClusterClient(NamespacedClient):
:arg metric: Limit the information returned to the specified
metrics. Valid choices: _all, blocks, metadata, nodes, routing_table,
routing_nodes, master_node, cluster_manager_node, version
metrics. Valid choices are _all, blocks, metadata, nodes, routing_table,
routing_nodes, master_node, cluster_manager_node, version.
:arg index: Comma-separated list of indices; use `_all` or empty
string to perform the operation on all indices.
:arg allow_no_indices: Whether to ignore if a wildcard indices
@@ -143,17 +143,17 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices: all,
open, closed, hidden, none
:arg flat_settings: Return settings in flat format. (default:
false)
concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none.
:arg flat_settings: Return settings in flat format. Default is
false.
:arg ignore_unavailable: Whether specified concrete indices
should be ignored when unavailable (missing or closed).
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg wait_for_metadata_version: Wait for the metadata version to
be equal or greater than the specified metadata version.
:arg wait_for_timeout: The maximum time to wait for
@@ -179,8 +179,8 @@ class ClusterClient(NamespacedClient):
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
nodes.
:arg flat_settings: Return settings in flat format. (default:
false)
:arg flat_settings: Return settings in flat format. Default is
false.
:arg timeout: Operation timeout.
"""
return self.transport.perform_request(
@@ -215,8 +215,8 @@ class ClusterClient(NamespacedClient):
:arg explain: Return an explanation of why the commands can or
cannot be executed.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg metric: Limit the information returned to the specified
metrics. Defaults to all but metadata.
:arg retry_failed: Retries allocation of shards that are blocked
@@ -241,13 +241,13 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg flat_settings: Return settings in flat format. (default:
false)
:arg flat_settings: Return settings in flat format. Default is
false.
:arg include_defaults: Whether to return all default clusters
setting. (default: false)
setting. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
return self.transport.perform_request(
@@ -266,11 +266,11 @@ class ClusterClient(NamespacedClient):
or `persistent` (survives cluster restart).
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg flat_settings: Return settings in flat format. (default:
false)
:arg flat_settings: Return settings in flat format. Default is
false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if body in SKIP_IN_PATH:
@@ -299,9 +299,9 @@ class ClusterClient(NamespacedClient):
:arg body: The index, shard, and primary flag to explain. Empty
means 'explain the first unassigned shard'
:arg include_disk_info: Return information about disk usage and
shard sizes. (default: false)
shard sizes. Default is false.
:arg include_yes_decisions: Return 'YES' decisions in
explanation. (default: false)
explanation. Default is false.
"""
return self.transport.perform_request(
"POST",
@@ -321,8 +321,8 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if name in SKIP_IN_PATH:
@@ -345,10 +345,10 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return self.transport.perform_request(
"GET",
@@ -368,10 +368,10 @@ class ClusterClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg create: Whether the index template should only be added if
new or can also replace an existing one. (default: false)
new or can also replace an existing one. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
for param in (name, body):
@@ -386,18 +386,20 @@ class ClusterClient(NamespacedClient):
body=body,
)
@query_params("local", "master_timeout")
@query_params("cluster_manager_timeout", "local", "master_timeout")
def exists_component_template(self, name, params=None, headers=None):
"""
Returns information about whether a particular component template exist.
:arg name: The name of the template.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster-manager node. (default: false)
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'name'.")
@@ -417,7 +419,7 @@ class ClusterClient(NamespacedClient):
:arg wait_for_removal: Specifies whether to wait for all
excluded nodes to be removed from the cluster before clearing the voting
configuration exclusions list. (default: True)
configuration exclusions list. Default is True.
"""
return self.transport.perform_request(
"DELETE",
opensearchpy/client/cluster.pyi
+1
View File
@@ -300,6 +300,7 @@ class ClusterClient(NamespacedClient):
self,
name: Any,
*,
cluster_manager_timeout: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
opensearchpy/client/dangling_indices.py
+4 -4
View File
@@ -53,8 +53,8 @@ class DanglingIndicesClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if index_uuid in SKIP_IN_PATH:
@@ -81,8 +81,8 @@ class DanglingIndicesClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if index_uuid in SKIP_IN_PATH:
opensearchpy/client/indices.py
+484 -653
View File
File diff suppressed because it is too large Load Diff
opensearchpy/client/indices.pyi
+37 -195
View File
@@ -24,6 +24,15 @@
# specific language governing permissions and limitations
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from typing import Any, Collection, MutableMapping, Optional, Tuple, Union
from .utils import NamespacedClient
@@ -94,8 +103,8 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -117,8 +126,8 @@ class IndicesClient(NamespacedClient):
target: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -139,13 +148,13 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
include_defaults: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -164,10 +173,10 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -188,10 +197,10 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -212,10 +221,10 @@ class IndicesClient(NamespacedClient):
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -259,10 +268,10 @@ class IndicesClient(NamespacedClient):
body: Any,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
write_index_only: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -283,11 +292,11 @@ class IndicesClient(NamespacedClient):
*,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -330,8 +339,8 @@ class IndicesClient(NamespacedClient):
name: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -394,8 +403,8 @@ class IndicesClient(NamespacedClient):
self,
*,
body: Any,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -415,8 +424,8 @@ class IndicesClient(NamespacedClient):
index: Any,
name: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -436,9 +445,9 @@ class IndicesClient(NamespacedClient):
name: Any,
*,
body: Any,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
order: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -457,10 +466,10 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -478,10 +487,10 @@ class IndicesClient(NamespacedClient):
self,
*,
name: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -499,8 +508,8 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -521,13 +530,13 @@ class IndicesClient(NamespacedClient):
index: Optional[Any] = ...,
name: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
include_defaults: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -547,11 +556,11 @@ class IndicesClient(NamespacedClient):
body: Any,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
preserve_existing: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -581,7 +590,6 @@ class IndicesClient(NamespacedClient):
include_segment_file_sizes: Optional[Any] = ...,
include_unloaded_segments: Optional[Any] = ...,
level: Optional[Any] = ...,
types: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -731,26 +739,6 @@ class IndicesClient(NamespacedClient):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def flush_synced(
self,
*,
index: Optional[Any] = ...,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def shard_stores(
self,
*,
@@ -801,9 +789,9 @@ class IndicesClient(NamespacedClient):
target: Any,
*,
body: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
copy_settings: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -825,9 +813,9 @@ class IndicesClient(NamespacedClient):
target: Any,
*,
body: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
copy_settings: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -849,9 +837,9 @@ class IndicesClient(NamespacedClient):
*,
body: Optional[Any] = ...,
new_index: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
dry_run: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -867,78 +855,11 @@ class IndicesClient(NamespacedClient):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def freeze(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def unfreeze(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
wait_for_active_shards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def reload_search_analyzers(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def create_data_stream(
self,
name: Any,
*,
body: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -956,7 +877,6 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
expand_wildcards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -974,8 +894,8 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -994,10 +914,10 @@ class IndicesClient(NamespacedClient):
self,
name: Any,
*,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1015,10 +935,10 @@ class IndicesClient(NamespacedClient):
self,
*,
name: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
flat_settings: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1038,9 +958,9 @@ class IndicesClient(NamespacedClient):
*,
body: Any,
cause: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1060,9 +980,9 @@ class IndicesClient(NamespacedClient):
*,
body: Optional[Any] = ...,
cause: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1080,7 +1000,6 @@ class IndicesClient(NamespacedClient):
self,
*,
name: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1100,9 +1019,9 @@ class IndicesClient(NamespacedClient):
body: Optional[Any] = ...,
name: Optional[Any] = ...,
cause: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
create: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -1140,10 +1059,10 @@ class IndicesClient(NamespacedClient):
block: Any,
*,
allow_no_indices: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -1175,80 +1094,3 @@ class IndicesClient(NamespacedClient):
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def promote_data_stream(
self,
name: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def migrate_to_data_stream(
self,
name: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def disk_usage(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
flush: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
run_expensive_tasks: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def field_usage_stats(
self,
index: Any,
*,
allow_no_indices: Optional[Any] = ...,
expand_wildcards: Optional[Any] = ...,
fields: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
opensearchpy/client/ingest.py
+7 -7
View File
@@ -50,8 +50,8 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return self.transport.perform_request(
"GET", _make_path("_ingest", "pipeline", id), params=params, headers=headers
@@ -68,8 +68,8 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
for param in (id, body):
@@ -94,8 +94,8 @@ class IngestClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead): Operation timeout for connection
to master node.
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if id in SKIP_IN_PATH:
@@ -117,7 +117,7 @@ class IngestClient(NamespacedClient):
:arg body: The simulate definition
:arg id: Pipeline ID.
:arg verbose: Verbose mode. Display data output for each
processor in executed pipeline.
processor in executed pipeline. Default is false.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
opensearchpy/client/nodes.py
+17 -17
View File
@@ -73,10 +73,10 @@ class NodesClient(NamespacedClient):
node you're connecting to, leave empty to get information from all
nodes.
:arg metric: Comma-separated list of metrics you wish returned.
Leave empty to return all. Valid choices: settings, os, process, jvm,
thread_pool, transport, http, plugins, ingest
:arg flat_settings: Return settings in flat format. (default:
false)
Leave empty to return all. Valid choices are settings, os, process, jvm,
thread_pool, transport, http, plugins, ingest.
:arg flat_settings: Return settings in flat format. Default is
false.
:arg timeout: Operation timeout.
"""
return self.transport.perform_request(
@@ -105,13 +105,13 @@ class NodesClient(NamespacedClient):
node you're connecting to, leave empty to get information from all
nodes.
:arg metric: Limit the information returned to the specified
metrics. Valid choices: _all, breaker, fs, http, indices, jvm, os,
process, thread_pool, transport, discovery, indexing_pressure
metrics. Valid choices are _all, breaker, fs, http, indices, jvm, os,
process, thread_pool, transport, discovery, indexing_pressure.
:arg index_metric: Limit the information returned for `indices`
metric to the specific index metrics. Isn't used if `indices` (or `all`)
metric isn't specified. Valid choices: _all, store, indexing, get,
metric isn't specified. Valid choices are _all, store, indexing, get,
search, merge, flush, refresh, query_cache, fielddata, docs, warmer,
completion, segments, translog, suggest, request_cache, recovery
completion, segments, translog, suggest, request_cache, recovery.
:arg completion_fields: Comma-separated list of fields for
`fielddata` and `suggest` index metric (supports wildcards).
:arg fielddata_fields: Comma-separated list of fields for
@@ -122,9 +122,9 @@ class NodesClient(NamespacedClient):
index metric.
:arg include_segment_file_sizes: Whether to report the
aggregated disk usage of each one of the Lucene index files (only
applies if segment stats are requested). (default: false)
applies if segment stats are requested). Default is false.
:arg level: Return indices stats aggregated at index, node or
shard level. Valid choices: indices, node, shards
shard level. Valid choices are indices, node, shards.
:arg timeout: Operation timeout.
:arg types: Comma-separated list of document types for the
`indexing` index metric.
@@ -148,16 +148,16 @@ class NodesClient(NamespacedClient):
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
nodes.
:arg doc_type: The type to sample. Valid choices: cpu, wait,
block
:arg doc_type: The type to sample. Valid choices are cpu, wait,
block.
:arg ignore_idle_threads: Don't show threads that are in known-
idle places, such as waiting on a socket select or pulling from an empty
task queue. (default: True)
task queue. Default is True.
:arg interval: The interval for the second sampling of threads.
:arg snapshots: Number of samples of thread stacktrace.
(default: 10)
:arg snapshots: Number of samples of thread stacktrace. Default
is 10.
:arg threads: Specify the number of threads to provide
information for. (default: 3)
information for. Default is 3.
:arg timeout: Operation timeout.
"""
# type is a reserved word so it cannot be used, use doc_type instead
@@ -182,7 +182,7 @@ class NodesClient(NamespacedClient):
node you're connecting to, leave empty to get information from all
nodes.
:arg metric: Limit the information returned to the specified
metrics. Valid choices: _all, rest_actions
metrics. Valid choices are _all, rest_actions.
:arg timeout: Operation timeout.
"""
return self.transport.perform_request(
opensearchpy/client/security.py
+158 -63
View File
@@ -7,6 +7,17 @@
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
@@ -17,25 +28,25 @@ class SecurityClient(NamespacedClient):
def get_account_details(self, params=None, headers=None):
"""
Returns account details for the current user.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "account"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/account", params=params, headers=headers
)
@query_params()
def change_password(self, body, params=None, headers=None):
"""
Changes the password for the current user.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PUT",
_make_path("_plugins", "_security", "api", "account"),
"/_plugins/_security/api/account",
params=params,
headers=headers,
body=body,
@@ -45,10 +56,13 @@ class SecurityClient(NamespacedClient):
def get_action_group(self, action_group, params=None, headers=None):
"""
Retrieves one action group.
:arg action_group: Action group to retrieve.
"""
if action_group in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'action-group'."
"Empty value passed for a required argument 'action_group'."
)
return self.transport.perform_request(
@@ -62,10 +76,11 @@ class SecurityClient(NamespacedClient):
def get_action_groups(self, params=None, headers=None):
"""
Retrieves all action groups.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "actiongroups"),
"/_plugins/_security/api/actiongroups/",
params=params,
headers=headers,
)
@@ -73,11 +88,14 @@ class SecurityClient(NamespacedClient):
@query_params()
def delete_action_group(self, action_group, params=None, headers=None):
"""
Deletes the specified action group.
Delete a specified action group.
:arg action_group: Action group to delete.
"""
if action_group in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'action-group'."
"Empty value passed for a required argument 'action_group'."
)
return self.transport.perform_request(
@@ -91,6 +109,10 @@ class SecurityClient(NamespacedClient):
def create_action_group(self, action_group, body, params=None, headers=None):
"""
Creates or replaces the specified action group.
:arg action_group: The name of the action group to create or
replace
"""
for param in (action_group, body):
if param in SKIP_IN_PATH:
@@ -108,6 +130,8 @@ class SecurityClient(NamespacedClient):
def patch_action_group(self, action_group, body, params=None, headers=None):
"""
Updates individual attributes of an action group.
"""
for param in (action_group, body):
if param in SKIP_IN_PATH:
@@ -125,13 +149,15 @@ class SecurityClient(NamespacedClient):
def patch_action_groups(self, body, params=None, headers=None):
"""
Creates, updates, or deletes multiple action groups in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "actiongroups"),
"/_plugins/_security/api/actiongroups",
params=params,
headers=headers,
body=body,
@@ -140,7 +166,9 @@ class SecurityClient(NamespacedClient):
@query_params()
def get_user(self, username, params=None, headers=None):
"""
Retrieves one user.
Retrieve one internal user.
"""
if username in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'username'.")
@@ -155,11 +183,12 @@ class SecurityClient(NamespacedClient):
@query_params()
def get_users(self, params=None, headers=None):
"""
Retrieves all users.
Retrieve all internal users.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "internalusers"),
"/_plugins/_security/api/internalusers",
params=params,
headers=headers,
)
@@ -167,7 +196,9 @@ class SecurityClient(NamespacedClient):
@query_params()
def delete_user(self, username, params=None, headers=None):
"""
Deletes the specified user.
Delete the specified user.
"""
if username in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'username'.")
@@ -183,6 +214,8 @@ class SecurityClient(NamespacedClient):
def create_user(self, username, body, params=None, headers=None):
"""
Creates or replaces the specified user.
"""
for param in (username, body):
if param in SKIP_IN_PATH:
@@ -200,6 +233,8 @@ class SecurityClient(NamespacedClient):
def patch_user(self, username, body, params=None, headers=None):
"""
Updates individual attributes of an internal user.
"""
for param in (username, body):
if param in SKIP_IN_PATH:
@@ -217,13 +252,15 @@ class SecurityClient(NamespacedClient):
def patch_users(self, body, params=None, headers=None):
"""
Creates, updates, or deletes multiple internal users in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "internalusers"),
"/_plugins/_security/api/internalusers",
params=params,
headers=headers,
body=body,
@@ -233,6 +270,8 @@ class SecurityClient(NamespacedClient):
def get_role(self, role, params=None, headers=None):
"""
Retrieves one role.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -248,18 +287,18 @@ class SecurityClient(NamespacedClient):
def get_roles(self, params=None, headers=None):
"""
Retrieves all roles.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "roles"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/roles/", params=params, headers=headers
)
@query_params()
def delete_role(self, role, params=None, headers=None):
"""
Deletes the specified role.
Delete the specified role.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -275,6 +314,8 @@ class SecurityClient(NamespacedClient):
def create_role(self, role, body, params=None, headers=None):
"""
Creates or replaces the specified role.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -292,6 +333,8 @@ class SecurityClient(NamespacedClient):
def patch_role(self, role, body, params=None, headers=None):
"""
Updates individual attributes of a role.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -309,13 +352,15 @@ class SecurityClient(NamespacedClient):
def patch_roles(self, body, params=None, headers=None):
"""
Creates, updates, or deletes multiple roles in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "roles"),
"/_plugins/_security/api/roles",
params=params,
headers=headers,
body=body,
@@ -325,6 +370,8 @@ class SecurityClient(NamespacedClient):
def get_role_mapping(self, role, params=None, headers=None):
"""
Retrieves one role mapping.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -340,10 +387,11 @@ class SecurityClient(NamespacedClient):
def get_role_mappings(self, params=None, headers=None):
"""
Retrieves all role mappings.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "rolesmapping"),
"/_plugins/_security/api/rolesmapping",
params=params,
headers=headers,
)
@@ -352,6 +400,8 @@ class SecurityClient(NamespacedClient):
def delete_role_mapping(self, role, params=None, headers=None):
"""
Deletes the specified role mapping.
"""
if role in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'role'.")
@@ -367,6 +417,8 @@ class SecurityClient(NamespacedClient):
def create_role_mapping(self, role, body, params=None, headers=None):
"""
Creates or replaces the specified role mapping.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -384,6 +436,8 @@ class SecurityClient(NamespacedClient):
def patch_role_mapping(self, role, body, params=None, headers=None):
"""
Updates individual attributes of a role mapping.
"""
for param in (role, body):
if param in SKIP_IN_PATH:
@@ -401,13 +455,15 @@ class SecurityClient(NamespacedClient):
def patch_role_mappings(self, body, params=None, headers=None):
"""
Creates or updates multiple role mappings in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "rolesmapping"),
"/_plugins/_security/api/rolesmapping",
params=params,
headers=headers,
body=body,
@@ -417,6 +473,8 @@ class SecurityClient(NamespacedClient):
def get_tenant(self, tenant, params=None, headers=None):
"""
Retrieves one tenant.
"""
if tenant in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'tenant'.")
@@ -432,18 +490,18 @@ class SecurityClient(NamespacedClient):
def get_tenants(self, params=None, headers=None):
"""
Retrieves all tenants.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "tenants"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/tenants/", params=params, headers=headers
)
@query_params()
def delete_tenant(self, tenant, params=None, headers=None):
"""
Deletes the specified tenant.
Delete the specified tenant.
"""
if tenant in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'tenant'.")
@@ -459,6 +517,8 @@ class SecurityClient(NamespacedClient):
def create_tenant(self, tenant, body, params=None, headers=None):
"""
Creates or replaces the specified tenant.
"""
for param in (tenant, body):
if param in SKIP_IN_PATH:
@@ -476,6 +536,8 @@ class SecurityClient(NamespacedClient):
def patch_tenant(self, tenant, body, params=None, headers=None):
"""
Add, delete, or modify a single tenant.
"""
for param in (tenant, body):
if param in SKIP_IN_PATH:
@@ -493,13 +555,15 @@ class SecurityClient(NamespacedClient):
def patch_tenants(self, body, params=None, headers=None):
"""
Add, delete, or modify multiple tenants in a single call.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "tenants"),
"/_plugins/_security/api/tenants/",
params=params,
headers=headers,
body=body,
@@ -508,11 +572,12 @@ class SecurityClient(NamespacedClient):
@query_params()
def get_configuration(self, params=None, headers=None):
"""
Retrieves the current Security plugin configuration in JSON format.
Returns the current Security plugin configuration in JSON format.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "securityconfig"),
"/_plugins/_security/api/securityconfig",
params=params,
headers=headers,
)
@@ -520,14 +585,16 @@ class SecurityClient(NamespacedClient):
@query_params()
def update_configuration(self, body, params=None, headers=None):
"""
Retrieves the current Security plugin configuration in JSON format.
Adds or updates the existing configuration using the REST API.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PUT",
_make_path("_plugins", "_security", "api", "securityconfig", "config"),
"/_plugins/_security/api/securityconfig/config",
params=params,
headers=headers,
body=body,
@@ -536,14 +603,16 @@ class SecurityClient(NamespacedClient):
@query_params()
def patch_configuration(self, body, params=None, headers=None):
"""
Updates the existing configuration using the REST API.
A PATCH call is used to update the existing configuration using the REST API.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
_make_path("_plugins", "_security", "api", "securityconfig"),
"/_plugins/_security/api/securityconfig",
params=params,
headers=headers,
body=body,
@@ -553,6 +622,8 @@ class SecurityClient(NamespacedClient):
def get_distinguished_names(self, cluster_name=None, params=None, headers=None):
"""
Retrieves all distinguished names in the allow list.
"""
return self.transport.perform_request(
"GET",
@@ -562,13 +633,19 @@ class SecurityClient(NamespacedClient):
)
@query_params()
def update_distinguished_names(self, cluster_name, body, params=None, headers=None):
def update_distinguished_names(
self, cluster_name, body=None, params=None, headers=None
):
"""
Adds or updates the specified distinguished names in the cluster's or node's allow list.
Adds or updates the specified distinguished names in the cluster’s or node’s
allow list.
"""
for param in (cluster_name, body):
if param in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument.")
if cluster_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'cluster_name'."
)
return self.transport.perform_request(
"PUT",
@@ -581,11 +658,14 @@ class SecurityClient(NamespacedClient):
@query_params()
def delete_distinguished_names(self, cluster_name, params=None, headers=None):
"""
Deletes all distinguished names in the specified cluster's or node's allow list.
Deletes all distinguished names in the specified cluster’s or node’s allow
list.
"""
if cluster_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'cluster-name'."
"Empty value passed for a required argument 'cluster_name'."
)
return self.transport.perform_request(
@@ -598,25 +678,22 @@ class SecurityClient(NamespacedClient):
@query_params()
def get_certificates(self, params=None, headers=None):
"""
Retrieves the cluster's security certificates.
Retrieves the cluster’s security certificates.
"""
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "ssl", "certs"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/ssl/certs", params=params, headers=headers
)
@query_params()
def reload_transport_certificates(self, params=None, headers=None):
"""
Reloads SSL certificates that are about to expire without restarting the OpenSearch node.
Reload transport layer communication certificates.
"""
return self.transport.perform_request(
"PUT",
_make_path(
"_opendistro", "_security", "api", "ssl", "transport", "reloadcerts"
),
"/_plugins/_security/api/ssl/transport/reloadcerts",
params=params,
headers=headers,
)
@@ -624,11 +701,12 @@ class SecurityClient(NamespacedClient):
@query_params()
def reload_http_certificates(self, params=None, headers=None):
"""
Reloads SSL certificates that are about to expire without restarting the OpenSearch node.
Reload HTTP layer communication certificates.
"""
return self.transport.perform_request(
"PUT",
_make_path("_opendistro", "_security", "api", "ssl", "http", "reloadcerts"),
"/_plugins/_security/api/ssl/http/reloadcerts",
params=params,
headers=headers,
)
@@ -637,12 +715,10 @@ class SecurityClient(NamespacedClient):
def flush_cache(self, params=None, headers=None):
"""
Flushes the Security plugin user, authentication, and authorization cache.
"""
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_security", "api", "cache"),
params=params,
headers=headers,
"DELETE", "/_plugins/_security/api/cache", params=params, headers=headers
)
@query_params()
@@ -658,13 +734,11 @@ class SecurityClient(NamespacedClient):
@query_params()
def get_audit_configuration(self, params=None, headers=None):
"""
A GET call retrieves the audit configuration.
Retrieves the audit configuration.
"""
return self.transport.perform_request(
"GET",
_make_path("_opendistro", "_security", "api", "audit"),
params=params,
headers=headers,
"GET", "/_plugins/_security/api/audit", params=params, headers=headers
)
@query_params()
@@ -672,6 +746,7 @@ class SecurityClient(NamespacedClient):
"""
Updates the audit configuration.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
@@ -688,13 +763,33 @@ class SecurityClient(NamespacedClient):
def patch_audit_configuration(self, body, params=None, headers=None):
"""
A PATCH call is used to update specified fields in the audit configuration.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
_make_path("_opendistro", "_security", "api", "audit"),
"/_plugins/_security/api/audit",
params=params,
headers=headers,
body=body,
)
@query_params()
def patch_distinguished_names(self, body, params=None, headers=None):
"""
Bulk update of distinguished names.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PATCH",
"/_plugins/_security/api/nodesdn",
params=params,
headers=headers,
body=body,
opensearchpy/client/security.pyi
+694 -107
View File
@@ -6,192 +6,735 @@
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from typing import Any, Collection, MutableMapping, Optional, Tuple, Union
from .utils import NamespacedClient as NamespacedClient
from .utils import NamespacedClient
class SecurityClient(NamespacedClient):
def get_account_details(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def change_password(
self,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_action_group(
self,
action_group: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_action_groups(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def delete_action_group(
self,
action_group: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def create_action_group(
self,
action_group: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_action_group(
self,
action_group: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_action_groups(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_user(
self,
username: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_users(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def delete_user(
self,
username: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def create_user(
self,
username: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_user(
self,
username: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_users(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_roles(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def delete_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def create_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_role(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_roles(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_role_mappings(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def delete_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def create_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_role_mapping(
self, role: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
role: Any,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_role_mappings(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_tenant(
self,
tenant: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_tenants(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def delete_tenant(
self,
tenant: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def create_tenant(
self,
tenant: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_tenant(
self,
tenant: Any,
*,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_tenants(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_configuration(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def update_configuration(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_configuration(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_distinguished_names(
self,
cluster_name: Union[Any, None] = ...,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
cluster_name: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def update_distinguished_names(
self,
cluster_name: Any,
body: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
body: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def delete_distinguished_names(
self,
cluster_name: Any,
params: Union[Any, None] = ...,
headers: Union[Any, None] = ...,
) -> Union[bool, Any]: ...
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_certificates(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def reload_transport_certificates(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def reload_http_certificates(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def flush_cache(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def health(
self,
*,
@@ -209,8 +752,21 @@ class SecurityClient(NamespacedClient):
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def get_audit_configuration(
self, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def update_audit_configuration(
self,
*,
@@ -229,5 +785,36 @@ class SecurityClient(NamespacedClient):
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_audit_configuration(
self, body: Any, params: Union[Any, None] = ..., headers: Union[Any, None] = ...
) -> Union[bool, Any]: ...
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def patch_distinguished_names(
self,
*,
body: Any,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
opensearchpy/client/snapshot.py
+104 -145
View File
@@ -25,25 +25,36 @@
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
class SnapshotClient(NamespacedClient):
@query_params("master_timeout", "cluster_manager_timeout", "wait_for_completion")
@query_params("cluster_manager_timeout", "master_timeout", "wait_for_completion")
def create(self, repository, snapshot, body=None, params=None, headers=None):
"""
Creates a snapshot in a repository.
:arg repository: A repository name
:arg snapshot: A snapshot name
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg body: The snapshot definition
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning
operation has completed before returning. Default is false.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -57,18 +68,19 @@ class SnapshotClient(NamespacedClient):
body=body,
)
@query_params("master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "master_timeout")
def delete(self, repository, snapshot, params=None, headers=None):
"""
Deletes a snapshot.
:arg repository: A repository name
:arg snapshot: A snapshot name
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -82,33 +94,25 @@ class SnapshotClient(NamespacedClient):
)
@query_params(
"ignore_unavailable",
"include_repository",
"index_details",
"master_timeout",
"cluster_manager_timeout",
"verbose",
"cluster_manager_timeout", "ignore_unavailable", "master_timeout", "verbose"
)
def get(self, repository, snapshot, params=None, headers=None):
"""
Returns information about a snapshot.
:arg repository: A repository name
:arg snapshot: A comma-separated list of snapshot names
:arg repository: Repository name.
:arg snapshot: Comma-separated list of snapshot names.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg ignore_unavailable: Whether to ignore unavailable
snapshots, defaults to false which means a SnapshotMissingException is
thrown
:arg include_repository: Whether to include the repository name
in the snapshot info. Defaults to true.
:arg index_details: Whether to include details of each index in
the snapshot, if those details are available. Defaults to false.
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
thrown. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg verbose: Whether to show verbose snapshot info or only show
the basic info found in the repository index blob
the basic info found in the repository index blob.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -121,7 +125,7 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout")
@query_params("cluster_manager_timeout", "master_timeout", "timeout")
def delete_repository(self, repository, params=None, headers=None):
"""
Deletes a repository.
@@ -129,11 +133,12 @@ class SnapshotClient(NamespacedClient):
:arg repository: Name of the snapshot repository to unregister.
Wildcard (`*`) patterns are supported.
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
@@ -145,38 +150,40 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("local", "master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "local", "master_timeout")
def get_repository(self, repository=None, params=None, headers=None):
"""
Returns information about a repository.
:arg repository: A comma-separated list of repository names
:arg repository: Comma-separated list of repository names.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg local: Return local information, do not retrieve the state
from cluster_manager node (default: false)
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
from cluster-manager node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return self.transport.perform_request(
"GET", _make_path("_snapshot", repository), params=params, headers=headers
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout", "verify")
@query_params("cluster_manager_timeout", "master_timeout", "timeout", "verify")
def create_repository(self, repository, body, params=None, headers=None):
"""
Creates a repository.
:arg repository: A repository name
:arg repository: Repository name.
:arg body: The repository definition
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg verify: Whether to verify the repository after creation
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
:arg verify: Whether to verify the repository after creation.
"""
for param in (repository, body):
if param in SKIP_IN_PATH:
@@ -190,21 +197,22 @@ class SnapshotClient(NamespacedClient):
body=body,
)
@query_params("master_timeout", "cluster_manager_timeout", "wait_for_completion")
@query_params("cluster_manager_timeout", "master_timeout", "wait_for_completion")
def restore(self, repository, snapshot, body=None, params=None, headers=None):
"""
Restores a snapshot.
:arg repository: A repository name
:arg snapshot: A snapshot name
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg body: Details of what to restore
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning
operation has completed before returning. Default is false.
"""
for param in (repository, snapshot):
if param in SKIP_IN_PATH:
@@ -218,21 +226,22 @@ class SnapshotClient(NamespacedClient):
body=body,
)
@query_params("ignore_unavailable", "master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "ignore_unavailable", "master_timeout")
def status(self, repository=None, snapshot=None, params=None, headers=None):
"""
Returns information about the status of a snapshot.
:arg repository: A repository name
:arg snapshot: A comma-separated list of snapshot names
:arg repository: Repository name.
:arg snapshot: Comma-separated list of snapshot names.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg ignore_unavailable: Whether to ignore unavailable
snapshots, defaults to false which means a SnapshotMissingException is
thrown
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
thrown. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
return self.transport.perform_request(
"GET",
@@ -241,18 +250,19 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout")
@query_params("cluster_manager_timeout", "master_timeout", "timeout")
def verify_repository(self, repository, params=None, headers=None):
"""
Verifies a repository.
:arg repository: A repository name
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg repository: Repository name.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
@@ -264,18 +274,19 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout", "timeout")
@query_params("cluster_manager_timeout", "master_timeout", "timeout")
def cleanup_repository(self, repository, params=None, headers=None):
"""
Removes stale data from repository.
:arg repository: A repository name
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg timeout: Explicit operation timeout
:arg repository: Repository name.
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
:arg timeout: Operation timeout.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
@@ -287,7 +298,7 @@ class SnapshotClient(NamespacedClient):
headers=headers,
)
@query_params("master_timeout", "cluster_manager_timeout")
@query_params("cluster_manager_timeout", "master_timeout")
def clone(
self, repository, snapshot, target_snapshot, body, params=None, headers=None
):
@@ -295,14 +306,15 @@ class SnapshotClient(NamespacedClient):
Clones indices from one snapshot into another snapshot in the same repository.
:arg repository: A repository name
:arg snapshot: The name of the snapshot to clone from
:arg target_snapshot: The name of the cloned snapshot to create
:arg repository: Repository name.
:arg snapshot: Snapshot name.
:arg target_snapshot: The name of the cloned snapshot to create.
:arg body: The snapshot clone definition
:arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
to master node
:arg cluster_manager_timeout: Explicit operation timeout for connection
to cluster_manager node
:arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node.
:arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Operation timeout for
connection to master node.
"""
for param in (repository, snapshot, target_snapshot, body):
if param in SKIP_IN_PATH:
@@ -315,56 +327,3 @@ class SnapshotClient(NamespacedClient):
headers=headers,
body=body,
)
@query_params(
"blob_count",
"concurrency",
"detailed",
"early_read_node_count",
"max_blob_size",
"max_total_data_size",
"rare_action_probability",
"rarely_abort_writes",
"read_node_count",
"seed",
"timeout",
)
def repository_analyze(self, repository, params=None, headers=None):
"""
Analyzes a repository for correctness and performance
:arg repository: A repository name
:arg blob_count: Number of blobs to create during the test.
Defaults to 100.
:arg concurrency: Number of operations to run concurrently
during the test. Defaults to 10.
:arg detailed: Whether to return detailed results or a summary.
Defaults to 'false' so that only the summary is returned.
:arg early_read_node_count: Number of nodes on which to perform
an early read on a blob, i.e. before writing has completed. Early reads
are rare actions so the 'rare_action_probability' parameter is also
relevant. Defaults to 2.
:arg max_blob_size: Maximum size of a blob to create during the
test, e.g '1gb' or '100mb'. Defaults to '10mb'.
:arg max_total_data_size: Maximum total size of all blobs to
create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'.
:arg rare_action_probability: Probability of taking a rare
action such as an early read or an overwrite. Defaults to 0.02.
:arg rarely_abort_writes: Whether to rarely abort writes before
they complete. Defaults to 'true'.
:arg read_node_count: Number of nodes on which to read a blob
after writing. Defaults to 10.
:arg seed: Seed for the random number generator used to create
the test workload. Defaults to a random value.
:arg timeout: Explicit operation timeout. Defaults to '30s'.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'repository'.")
return self.transport.perform_request(
"POST",
_make_path("_snapshot", repository, "_analyze"),
params=params,
headers=headers,
)
opensearchpy/client/snapshot.pyi
+21 -42
View File
@@ -24,6 +24,15 @@
# specific language governing permissions and limitations
# under the License.
# ----------------------------------------------------
# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
#
# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
# or the "OpenSearch API specification" available at:
# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
# -----------------------------------------------------
from typing import Any, Collection, MutableMapping, Optional, Tuple, Union
from .utils import NamespacedClient
@@ -35,8 +44,8 @@ class SnapshotClient(NamespacedClient):
snapshot: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
wait_for_completion: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -56,8 +65,8 @@ class SnapshotClient(NamespacedClient):
repository: Any,
snapshot: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -76,11 +85,9 @@ class SnapshotClient(NamespacedClient):
repository: Any,
snapshot: Any,
*,
ignore_unavailable: Optional[Any] = ...,
include_repository: Optional[Any] = ...,
index_details: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
verbose: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -99,8 +106,8 @@ class SnapshotClient(NamespacedClient):
self,
repository: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -119,9 +126,9 @@ class SnapshotClient(NamespacedClient):
self,
*,
repository: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
local: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -140,8 +147,8 @@ class SnapshotClient(NamespacedClient):
repository: Any,
*,
body: Any,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
verify: Optional[Any] = ...,
pretty: Optional[bool] = ...,
@@ -163,8 +170,8 @@ class SnapshotClient(NamespacedClient):
snapshot: Any,
*,
body: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
wait_for_completion: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -184,9 +191,9 @@ class SnapshotClient(NamespacedClient):
*,
repository: Optional[Any] = ...,
snapshot: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
ignore_unavailable: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
@@ -204,8 +211,8 @@ class SnapshotClient(NamespacedClient):
self,
repository: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -224,8 +231,8 @@ class SnapshotClient(NamespacedClient):
self,
repository: Any,
*,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
@@ -247,36 +254,8 @@ class SnapshotClient(NamespacedClient):
target_snapshot: Any,
*,
body: Any,
master_timeout: Optional[Any] = ...,
cluster_manager_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
format: Optional[str] = ...,
filter_path: Optional[Union[str, Collection[str]]] = ...,
request_timeout: Optional[Union[int, float]] = ...,
ignore: Optional[Union[int, Collection[int]]] = ...,
opaque_id: Optional[str] = ...,
http_auth: Optional[Union[str, Tuple[str, str]]] = ...,
api_key: Optional[Union[str, Tuple[str, str]]] = ...,
params: Optional[MutableMapping[str, Any]] = ...,
headers: Optional[MutableMapping[str, str]] = ...,
) -> Any: ...
def repository_analyze(
self,
repository: Any,
*,
blob_count: Optional[Any] = ...,
concurrency: Optional[Any] = ...,
detailed: Optional[Any] = ...,
early_read_node_count: Optional[Any] = ...,
max_blob_size: Optional[Any] = ...,
max_total_data_size: Optional[Any] = ...,
rare_action_probability: Optional[Any] = ...,
rarely_abort_writes: Optional[Any] = ...,
read_node_count: Optional[Any] = ...,
seed: Optional[Any] = ...,
timeout: Optional[Any] = ...,
master_timeout: Optional[Any] = ...,
pretty: Optional[bool] = ...,
human: Optional[bool] = ...,
error_trace: Optional[bool] = ...,
opensearchpy/client/tasks.py
+6 -5
View File
@@ -57,9 +57,10 @@ class TasksClient(NamespacedClient):
:arg actions: Comma-separated list of actions that should be
returned. Leave empty to return all.
:arg detailed: Return detailed task information.
:arg detailed: Return detailed task information. Default is
false.
:arg group_by: Group tasks by nodes or parent/child
relationships. Valid choices: nodes, parents, none
relationships. Valid choices are nodes, parents, none.
:arg nodes: Comma-separated list of node IDs or names to limit
the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
@@ -68,7 +69,7 @@ class TasksClient(NamespacedClient):
(node_id:task_number). Set to -1 to return all.
:arg timeout: Operation timeout.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning.
operation has completed before returning. Default is false.
"""
return self.transport.perform_request(
"GET", "/_tasks", params=params, headers=headers
@@ -91,7 +92,7 @@ class TasksClient(NamespacedClient):
:arg parent_task_id: Cancel tasks with specified parent task id
(node_id:task_number). Set to -1 to cancel all.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning.
operation has completed before returning. Default is false.
"""
return self.transport.perform_request(
"POST",
@@ -110,7 +111,7 @@ class TasksClient(NamespacedClient):
(node_id:task_number).
:arg timeout: Operation timeout.
:arg wait_for_completion: Should this request wait until the
operation has completed before returning.
operation has completed before returning. Default is false.
"""
if task_id in SKIP_IN_PATH:
warnings.warn(
utils/generate-api.py
+15 -5
View File
@@ -301,9 +301,10 @@ class API:
parts.update(url.get("parts", {}))
for p in parts:
parts[p]["required"] = all(
p in url.get("parts", {}) for url in self._def["url"]["paths"]
)
if "required" not in parts[p]:
parts[p]["required"] = all(
p in url.get("parts", {}) for url in self._def["url"]["paths"]
)
parts[p]["type"] = "Any"
# This piece of logic corresponds to calling
@@ -555,6 +556,8 @@ def read_modules():
# Group the data in the current group by the "path" key
paths = []
all_paths_have_deprecation = True
for key2, value2 in groupby(value, key=itemgetter("path")):
# Extract the HTTP methods from the data in the current subgroup
methods = []
@@ -567,8 +570,10 @@ def read_modules():
documentation = {"description": z["description"]}
api.update({"documentation": documentation})
if "deprecation_message" not in api and "x-deprecation-message" in z:
api.update({"deprecation_message": z["x-deprecation-message"]})
if "x-deprecation-message" in z:
x_deprecation_message = z["x-deprecation-message"]
else:
all_paths_have_deprecation = False
if "params" not in api and "params" in z:
api.update({"params": z["params"]})
@@ -637,6 +642,11 @@ def read_modules():
paths.append({"path": key2, "methods": methods})
api.update({"url": {"paths": paths}})
if all_paths_have_deprecation and x_deprecation_message is not None:
api.update({"deprecation_message": x_deprecation_message})
if namespace == "indices" and name == "put_mapping":
api["url"]["paths"][0]["parts"]["index"].update({"required": False})
if namespace not in modules:
modules[namespace] = Module(namespace)
utils/templates/base
+4 -2
View File
@@ -20,11 +20,13 @@
{% if api.params|list|length %}
{% for p, info in api.params %}
{% if info.description %}
{% filter wordwrap(72, wrapstring="\n ") %}
:arg {{ p }}{% if info.deprecated %} (Deprecated: {{ info['deprecation_message'][:-1] }}){% endif %}: {{ info.description }}{% if info.options %} Valid choices: {{ info.options|join(", ") }}{% endif %}
{% if info.default is defined %}{% if info.default is not none %}{% if info.default is sameas(false) %} (default: false){% else %} (default: {{ info.default }}){% endif %}{% endif %}{% endif %}
:arg {{ p }}{% if info.deprecated %} (Deprecated: {{ info['deprecation_message'][:-1] }}.){% endif %}: {{ info.description }} {% if info.options %}Valid choices are {{ info.options|join(", ") }}.{% endif %}
{% if info.default is defined %}{% if info.default is not none %}{% if info.default is sameas(false) %}Default is false.{% else %}Default is {{ info.default }}.{% endif %}{% endif %}{% endif %}
{% endfilter %}
{% endif %}
{% endfor %}
{% endif %}
"""