/ 
OpenSearch-Client-3.007009
/ OpenSearch::Client::Core::3_0::Direct::DanglingIndices

NAME

OpenSearch::Client::Core::3_0::Direct::DanglingIndices

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->dangling_indices-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Dangling indexes

After a node joins a cluster, dangling indexes occur if any shards exist in the node's local directory that do not already exist in the cluster. Dangling indexes can be listed, deleted, or imported.

See OpenSearch documentation for dangling_indices.

METHODS

delete_dangling_index

Deletes the specified dangling index.

Paths served by this method:

DELETE /_dangling/{index_uuid}

Method added in OpenSearch version 1.0

$resp = $client->dangling_indices->delete_dangling_index(
    
     # path parameters
    
    'index_uuid'               =>  $index_uuid,  # required
    
     # Endpoint specific query string parameters
    
    'accept_data_loss'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'master_timeout'           =>  $qval3,     # string
    'timeout'                  =>  $qval4,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval5,     # boolean
    'filter_path'              =>  $qval6,     # list
    'human'                    =>  $qval7,     # boolean
    'pretty'                   =>  $qval8,     # boolean
    'source'                   =>  $qval9,     # string
);

OpenSearch documentation for dangling_indices->delete_dangling_index

import_dangling_index

Imports the specified dangling index.

Paths served by this method:

POST /_dangling/{index_uuid}

Method added in OpenSearch version 1.0

$resp = $client->dangling_indices->import_dangling_index(
    
     # path parameters
    
    'index_uuid'               =>  $index_uuid,  # required
    
     # Endpoint specific query string parameters
    
    'accept_data_loss'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'master_timeout'           =>  $qval3,     # string
    'timeout'                  =>  $qval4,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval5,     # boolean
    'filter_path'              =>  $qval6,     # list
    'human'                    =>  $qval7,     # boolean
    'pretty'                   =>  $qval8,     # boolean
    'source'                   =>  $qval9,     # string
);

OpenSearch documentation for dangling_indices->import_dangling_index

list_dangling_indices

Returns all dangling indexes.

Paths served by this method:

GET /_dangling

Method added in OpenSearch version 1.0

$resp = $client->dangling_indices->list_dangling_indices(
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for dangling_indices->list_dangling_indices

method_supported_in_version

Return whether a method in this module namespace is supported for an OpenSearch server version

my $boolean = $os->dangling_indices->method_supported_in_version(
    method  => 'delete_dangling_index',
    version => '2.4.0'
);

Both method and version are required.

See also global_method_supported_in_version

MANUAL

Documentation index OpenSearch::Client::Manual

HISTORY

This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.

AUTHOR

Mark Dootson <mdootson@cpan.org> ( current maintainer )

CREDITS

OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.

COPYRIGHT AND LICENSE

Copyright (C) 2026 by Mark Dootson ( this distribution )

Copyright (C) 2021 by Elasticsearch BV ( original distribution )

This is free software, licensed under:

The Apache License, Version 2.0, January 2004