0da60b2623
Signed-off-by: dblock <dblock@amazon.com>
457 lines
19 KiB
Python
457 lines
19 KiB
Python
# -*- coding: utf-8 -*-
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# The OpenSearch Contributors require contributions made to
|
|
# this file be licensed under the Apache-2.0 license or a
|
|
# compatible open source license.
|
|
#
|
|
# Modifications Copyright OpenSearch Contributors. See
|
|
# GitHub history for details.
|
|
#
|
|
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
# license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright
|
|
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
# the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# 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
|
|
|
|
class ClusterClient(NamespacedClient):
|
|
def health(
|
|
self,
|
|
*,
|
|
index: Optional[Any] = ...,
|
|
awareness_attribute: Optional[Any] = ...,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
expand_wildcards: Optional[Any] = ...,
|
|
level: Optional[Any] = ...,
|
|
local: Optional[Any] = ...,
|
|
master_timeout: Optional[Any] = ...,
|
|
timeout: Optional[Any] = ...,
|
|
wait_for_active_shards: Optional[Any] = ...,
|
|
wait_for_events: Optional[Any] = ...,
|
|
wait_for_no_initializing_shards: Optional[Any] = ...,
|
|
wait_for_no_relocating_shards: Optional[Any] = ...,
|
|
wait_for_nodes: Optional[Any] = ...,
|
|
wait_for_status: 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 pending_tasks(
|
|
self,
|
|
*,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
local: Optional[Any] = ...,
|
|
master_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 state(
|
|
self,
|
|
*,
|
|
metric: Optional[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] = ...,
|
|
local: Optional[Any] = ...,
|
|
master_timeout: Optional[Any] = ...,
|
|
wait_for_metadata_version: Optional[Any] = ...,
|
|
wait_for_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 stats(
|
|
self,
|
|
*,
|
|
node_id: Optional[Any] = ...,
|
|
flat_settings: Optional[Any] = ...,
|
|
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 reroute(
|
|
self,
|
|
*,
|
|
body: Optional[Any] = ...,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
dry_run: Optional[Any] = ...,
|
|
explain: Optional[Any] = ...,
|
|
master_timeout: Optional[Any] = ...,
|
|
metric: Optional[Any] = ...,
|
|
retry_failed: Optional[Any] = ...,
|
|
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 get_settings(
|
|
self,
|
|
*,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
flat_settings: Optional[Any] = ...,
|
|
include_defaults: Optional[Any] = ...,
|
|
master_timeout: Optional[Any] = ...,
|
|
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 put_settings(
|
|
self,
|
|
*,
|
|
body: Any,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
flat_settings: Optional[Any] = ...,
|
|
master_timeout: Optional[Any] = ...,
|
|
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 remote_info(
|
|
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 allocation_explain(
|
|
self,
|
|
*,
|
|
body: Optional[Any] = ...,
|
|
include_disk_info: Optional[Any] = ...,
|
|
include_yes_decisions: 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_component_template(
|
|
self,
|
|
name: Any,
|
|
*,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
master_timeout: Optional[Any] = ...,
|
|
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 get_component_template(
|
|
self,
|
|
*,
|
|
name: Optional[Any] = ...,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
local: Optional[Any] = ...,
|
|
master_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 put_component_template(
|
|
self,
|
|
name: Any,
|
|
*,
|
|
body: Any,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
create: Optional[Any] = ...,
|
|
master_timeout: Optional[Any] = ...,
|
|
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 exists_component_template(
|
|
self,
|
|
name: Any,
|
|
*,
|
|
cluster_manager_timeout: Optional[Any] = ...,
|
|
local: Optional[Any] = ...,
|
|
master_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]] = ...,
|
|
) -> bool: ...
|
|
def delete_voting_config_exclusions(
|
|
self,
|
|
*,
|
|
wait_for_removal: 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 post_voting_config_exclusions(
|
|
self,
|
|
*,
|
|
node_ids: Optional[Any] = ...,
|
|
node_names: Optional[Any] = ...,
|
|
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 delete_decommission_awareness(
|
|
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_weighted_routing(
|
|
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 get_decommission_awareness(
|
|
self,
|
|
awareness_attribute_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 get_weighted_routing(
|
|
self,
|
|
attribute: 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 put_decommission_awareness(
|
|
self,
|
|
awareness_attribute_name: Any,
|
|
awareness_attribute_value: 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 put_weighted_routing(
|
|
self,
|
|
attribute: 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: ...
|