Source code for opensearchpy.client.dangling_indices
# 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 AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST## To contribute, kindly make modifications in the opensearch-py client generator# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md# and https://github.com/opensearch-project/opensearch-api-specification for details.# -----------------------------------------------------------------------------------------+fromtypingimportAnyfrom.utilsimportSKIP_IN_PATH,NamespacedClient,_make_path,query_params
[docs]@query_params("accept_data_loss","cluster_manager_timeout","error_trace","filter_path","human","master_timeout","pretty","source","timeout",)defdelete_dangling_index(self,index_uuid:Any,params:Any=None,headers:Any=None,)->Any:""" Deletes the specified dangling index. :arg index_uuid: The UUID of the dangling index. :arg accept_data_loss: Must be set to true in order to delete the dangling index. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use `cluster_manager_timeout` instead.): Specify timeout for connection to cluster manager. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout. """ifindex_uuidinSKIP_IN_PATH:raiseValueError("Empty value passed for a required argument 'index_uuid'.")returnself.transport.perform_request("DELETE",_make_path("_dangling",index_uuid),params=params,headers=headers,)
[docs]@query_params("accept_data_loss","cluster_manager_timeout","error_trace","filter_path","human","master_timeout","pretty","source","timeout",)defimport_dangling_index(self,index_uuid:Any,params:Any=None,headers:Any=None,)->Any:""" Imports the specified dangling index. :arg index_uuid: The UUID of the dangling index. :arg accept_data_loss: Must be set to true in order to import the dangling index. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use `cluster_manager_timeout` instead.): Specify timeout for connection to cluster manager. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout. """ifindex_uuidinSKIP_IN_PATH:raiseValueError("Empty value passed for a required argument 'index_uuid'.")returnself.transport.perform_request("POST",_make_path("_dangling",index_uuid),params=params,headers=headers)
[docs]@query_params("error_trace","filter_path","human","pretty","source")deflist_dangling_indices(self,params:Any=None,headers:Any=None,)->Any:""" Returns all dangling indexes. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """returnself.transport.perform_request("GET","/_dangling",params=params,headers=headers)