Dangling Indices Client

class opensearchpy.client.dangling_indices.DanglingIndicesClient(client)[source]

Bases: NamespacedClient

Parameters:

client (Any) –

delete_dangling_index(index_uuid, params=None, headers=None)[source]

Deletes the specified dangling index.

Parameters:

  • index_uuid (Any) – The UUID of the dangling index.

  • accept_data_loss – Must be set to true in order to delete the dangling index.

  • cluster_manager_timeout – Operation timeout for connection to cluster-manager node.

  • error_trace – Whether to include the stack trace of returned errors. Default is false.

  • 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 “-“.

  • human – Whether to return human readable values for statistics. Default is True.

  • (Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Specify timeout for connection to cluster manager.

  • pretty – Whether to pretty format the returned JSON response. Default is false.

  • source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

  • timeout – Explicit operation timeout.

  • index_uuid –

  • params (Any) –

  • headers (Any) –

Return type:

Any

import_dangling_index(index_uuid, params=None, headers=None)[source]

Imports the specified dangling index.

Parameters:

  • index_uuid (Any) – The UUID of the dangling index.

  • accept_data_loss – Must be set to true in order to import the dangling index.

  • cluster_manager_timeout – Operation timeout for connection to cluster-manager node.

  • error_trace – Whether to include the stack trace of returned errors. Default is false.

  • 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 “-“.

  • human – Whether to return human readable values for statistics. Default is True.

  • (Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Specify timeout for connection to cluster manager.

  • pretty – Whether to pretty format the returned JSON response. Default is false.

  • source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

  • timeout – Explicit operation timeout.

  • index_uuid –

  • params (Any) –

  • headers (Any) –

Return type:

Any

list_dangling_indices(params=None, headers=None)[source]

Returns all dangling indexes.

Parameters:

  • error_trace – Whether to include the stack trace of returned errors. Default is false.

  • 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 “-“.

  • human – Whether to return human readable values for statistics. Default is True.

  • pretty – Whether to pretty format the returned JSON response. Default is false.

  • source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

  • params (Any) –

  • headers (Any) –

Return type:

Any