NAME

OpenSearch::Client::Core::3_0::Direct::Indices

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Index APIs

The index API operations let you interact with indexes in your cluster. Using these operations, you can create, delete, close, and complete other index-related operations.

See OpenSearch documentation for indices.

METHODS

add_block

Adds a block to an index.

Paths served by this method:

PUT /{index}/_block/{block}

Method added in OpenSearch version 1.0

$resp = $client->indices->add_block(
    
     # path parameters
    
    'block'                    =>  $block,     # required
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'ignore_unavailable'       =>  $qval4,     # boolean
    'master_timeout'           =>  $qval5,     # string
    'timeout'                  =>  $qval6,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval7,     # boolean
    'filter_path'              =>  $qval8,     # list
    'human'                    =>  $qval9,     # boolean
    'pretty'                   =>  $qval10,    # boolean
    'source'                   =>  $qval11,    # string
);

OpenSearch documentation for indices->add_block

analyze

Performs the analysis process on a text and return the tokens breakdown of the text.

Paths served by this method:

GET /_analyze
GET /{index}/_analyze
POST /_analyze
POST /{index}/_analyze

Method added in OpenSearch version 1.0

$resp = $client->indices->analyze(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'index'        =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'index'        =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for indices->analyze

clear_cache

Clears all or specific caches for one or more indexes.

Paths served by this method:

POST /_cache/clear
POST /{index}/_cache/clear

Method added in OpenSearch version 1.0

$resp = $client->indices->clear_cache(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'fielddata'           =>  $qval3,     # boolean
    'fields'              =>  $qval4,     # list
    'file'                =>  $qval5,     # boolean
    'ignore_unavailable'  =>  $qval6,     # boolean
    'index'               =>  $qval7,     # list
    'query'               =>  $qval8,     # boolean
    'request'             =>  $qval9,     # boolean
    
     # Common API query string parameters
    
    'error_trace'         =>  $qval10,    # boolean
    'filter_path'         =>  $qval11,    # list
    'human'               =>  $qval12,    # boolean
    'pretty'              =>  $qval13,    # boolean
    'source'              =>  $qval14,    # string
);

OpenSearch documentation for indices->clear_cache

clone

Clones an index.

Paths served by this method:

POST /{index}/_clone/{target}
PUT /{index}/_clone/{target}

Method added in OpenSearch version 1.0

$resp = $client->indices->clone(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'index'                    =>  $index,     # required
    'target'                   =>  $target,    # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    'task_execution_timeout'   =>  $qval3,     # string
    'timeout'                  =>  $qval4,     # string
    'wait_for_active_shards'   =>  $qval5,     # string
    'wait_for_completion'      =>  $qval6,     # boolean
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval7,     # boolean
    'filter_path'              =>  $qval8,     # list
    'human'                    =>  $qval9,     # boolean
    'pretty'                   =>  $qval10,    # boolean
    'source'                   =>  $qval11,    # string
);

OpenSearch documentation for indices->clone

close

Closes an index.

Paths served by this method:

POST /{index}/_close

Method added in OpenSearch version 1.0

$resp = $client->indices->close(
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'ignore_unavailable'       =>  $qval4,     # boolean
    'master_timeout'           =>  $qval5,     # string
    'timeout'                  =>  $qval6,     # string
    'wait_for_active_shards'   =>  $qval7,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval8,     # boolean
    'filter_path'              =>  $qval9,     # list
    'human'                    =>  $qval10,    # boolean
    'pretty'                   =>  $qval11,    # boolean
    'source'                   =>  $qval12,    # string
);

OpenSearch documentation for indices->close

create

Creates an index with optional settings and mappings.

Paths served by this method:

PUT /{index}

Method added in OpenSearch version 1.0

$resp = $client->indices->create(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    'timeout'                  =>  $qval3,     # string
    'wait_for_active_shards'   =>  $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 indices->create

create_data_stream

Creates or updates a data stream.

Paths served by this method:

PUT /_data_stream/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->create_data_stream(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'name'         =>  $name,      # required
    
     # 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 indices->create_data_stream

data_streams_stats

Provides statistics on operations happening in a data stream.

Paths served by this method:

GET /_data_stream/_stats
GET /_data_stream/{name}/_stats

Method added in OpenSearch version 1.0

$resp = $client->indices->data_streams_stats(
    
     # path parameters
    
    'name'         =>  $name,      # optional
    
     # 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 indices->data_streams_stats

delete

Deletes an index.

Paths served by this method:

DELETE /{index}

Method added in OpenSearch version 1.0

$resp = $client->indices->delete(
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'ignore_unavailable'       =>  $qval4,     # boolean
    'master_timeout'           =>  $qval5,     # string
    'timeout'                  =>  $qval6,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval7,     # boolean
    'filter_path'              =>  $qval8,     # list
    'human'                    =>  $qval9,     # boolean
    'pretty'                   =>  $qval10,    # boolean
    'source'                   =>  $qval11,    # string
);

OpenSearch documentation for indices->delete

delete_alias

Deletes an alias.

Paths served by this method:

DELETE /{index}/_alias/{name}
DELETE /{index}/_aliases/{name}

Method added in OpenSearch version 1.0

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

OpenSearch documentation for indices->delete_alias

delete_data_stream

Deletes a data stream.

Paths served by this method:

DELETE /_data_stream/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->delete_data_stream(
    
     # path parameters
    
    'name'         =>  $name,      # required
    
     # 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 indices->delete_data_stream

delete_index_template

Deletes an index template.

Paths served by this method:

DELETE /_index_template/{name}

Method added in OpenSearch version 1.0

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

OpenSearch documentation for indices->delete_index_template

delete_template

Deletes an index template.

Paths served by this method:

DELETE /_template/{name}

Method added in OpenSearch version 1.0

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

OpenSearch documentation for indices->delete_template

exists

Returns information about whether a particular index exists.

Paths served by this method:

HEAD /{index}

Method added in OpenSearch version 1.0

$resp = $client->indices->exists(
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'flat_settings'            =>  $qval4,     # boolean
    'ignore_unavailable'       =>  $qval5,     # boolean
    'include_defaults'         =>  $qval6,     # boolean
    'local'                    =>  $qval7,     # boolean
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval8,     # boolean
    'filter_path'              =>  $qval9,     # list
    'human'                    =>  $qval10,    # boolean
    'pretty'                   =>  $qval11,    # boolean
    'source'                   =>  $qval12,    # string
);

OpenSearch documentation for indices->exists

exists_alias

Returns information about whether a particular alias exists.

Paths served by this method:

HEAD /_alias/{name}
HEAD /{index}/_alias/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->exists_alias(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    'name'                =>  $name,      # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'ignore_unavailable'  =>  $qval3,     # boolean
    'local'               =>  $qval4,     # boolean
    
     # 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 indices->exists_alias

exists_index_template

Returns information about whether a particular index template exists.

Paths served by this method:

HEAD /_index_template/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->exists_index_template(
    
     # path parameters
    
    'name'                     =>  $name,      # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'flat_settings'            =>  $qval2,     # boolean
    'local'                    =>  $qval3,     # boolean
    'master_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 indices->exists_index_template

exists_template

Returns information about whether a particular index template exists.

Paths served by this method:

HEAD /_template/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->exists_template(
    
     # path parameters
    
    'name'                     =>  $name,      # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'flat_settings'            =>  $qval2,     # boolean
    'local'                    =>  $qval3,     # boolean
    'master_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 indices->exists_template

flush

Performs the flush operation on one or more indexes.

Paths served by this method:

GET /_flush
GET /{index}/_flush
POST /_flush
POST /{index}/_flush

Method added in OpenSearch version 1.0

$resp = $client->indices->flush(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'force'               =>  $qval3,     # boolean
    'ignore_unavailable'  =>  $qval4,     # boolean
    'wait_if_ongoing'     =>  $qval5,     # boolean
    
     # Common API query string parameters
    
    'error_trace'         =>  $qval6,     # boolean
    'filter_path'         =>  $qval7,     # list
    'human'               =>  $qval8,     # boolean
    'pretty'              =>  $qval9,     # boolean
    'source'              =>  $qval10,    # string
);

OpenSearch documentation for indices->flush

forcemerge

Performs the force merge operation on one or more indexes.

Paths served by this method:

POST /_forcemerge
POST /{index}/_forcemerge

Method added in OpenSearch version 1.0

$resp = $client->indices->forcemerge(
    
     # path parameters
    
    'index'                 =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'      =>  $qval1,     # boolean
    'expand_wildcards'      =>  $qval2,     # list
    'flush'                 =>  $qval3,     # boolean
    'ignore_unavailable'    =>  $qval4,     # boolean
    'max_num_segments'      =>  $qval5,     # number
    'only_expunge_deletes'  =>  $qval6,     # boolean
    'primary_only'          =>  $qval7,     # boolean
    'wait_for_completion'   =>  $qval8,     # boolean
    
     # Common API query string parameters
    
    'error_trace'           =>  $qval9,     # boolean
    'filter_path'           =>  $qval10,    # list
    'human'                 =>  $qval11,    # boolean
    'pretty'                =>  $qval12,    # boolean
    'source'                =>  $qval13,    # string
);

OpenSearch documentation for indices->forcemerge

get

Returns information about one or more indexes.

Paths served by this method:

GET /{index}

Method added in OpenSearch version 1.0

$resp = $client->indices->get(
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'flat_settings'            =>  $qval4,     # boolean
    'ignore_unavailable'       =>  $qval5,     # boolean
    'include_defaults'         =>  $qval6,     # boolean
    'local'                    =>  $qval7,     # boolean
    'master_timeout'           =>  $qval8,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval9,     # boolean
    'filter_path'              =>  $qval10,    # list
    'human'                    =>  $qval11,    # boolean
    'pretty'                   =>  $qval12,    # boolean
    'source'                   =>  $qval13,    # string
);

OpenSearch documentation for indices->get

get_alias

Returns an alias.

Paths served by this method:

GET /_alias
GET /_alias/{name}
GET /{index}/_alias
GET /{index}/_alias/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->get_alias(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    'name'                =>  $name,      # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'ignore_unavailable'  =>  $qval3,     # boolean
    'local'               =>  $qval4,     # boolean
    
     # 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 indices->get_alias

get_data_stream

Returns data streams.

Paths served by this method:

GET /_data_stream
GET /_data_stream/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->get_data_stream(
    
     # path parameters
    
    'name'         =>  $name,      # optional
    
     # 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 indices->get_data_stream

get_field_mapping

Returns mapping for one or more fields.

Paths served by this method:

GET /_mapping/field/{fields}
GET /{index}/_mapping/field/{fields}

Method added in OpenSearch version 1.0

$resp = $client->indices->get_field_mapping(
    
     # path parameters
    
    'fields'              =>  $fields,    # required
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'ignore_unavailable'  =>  $qval3,     # boolean
    'include_defaults'    =>  $qval4,     # boolean
    'local'               =>  $qval5,     # boolean
    
     # Common API query string parameters
    
    'error_trace'         =>  $qval6,     # boolean
    'filter_path'         =>  $qval7,     # list
    'human'               =>  $qval8,     # boolean
    'pretty'              =>  $qval9,     # boolean
    'source'              =>  $qval10,    # string
);

OpenSearch documentation for indices->get_field_mapping

get_index_template

Returns an index template.

Paths served by this method:

GET /_index_template
GET /_index_template/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->get_index_template(
    
     # path parameters
    
    'name'                     =>  $name,      # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'flat_settings'            =>  $qval2,     # boolean
    'local'                    =>  $qval3,     # boolean
    'master_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 indices->get_index_template

get_mapping

Returns mappings for one or more indexes.

Paths served by this method:

GET /_mapping
GET /{index}/_mapping

Method added in OpenSearch version 1.0

$resp = $client->indices->get_mapping(
    
     # path parameters
    
    'index'                    =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'ignore_unavailable'       =>  $qval4,     # boolean
    'index'                    =>  $qval5,     # list
    'local'                    =>  $qval6,     # boolean
    'master_timeout'           =>  $qval7,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval8,     # boolean
    'filter_path'              =>  $qval9,     # list
    'human'                    =>  $qval10,    # boolean
    'pretty'                   =>  $qval11,    # boolean
    'source'                   =>  $qval12,    # string
);

OpenSearch documentation for indices->get_mapping

get_settings

Returns settings for one or more indexes.

Paths served by this method:

GET /_settings
GET /_settings/{name}
GET /{index}/_settings
GET /{index}/_settings/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->get_settings(
    
     # path parameters
    
    'index'                    =>  $index,     # optional
    'name'                     =>  $name,      # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'flat_settings'            =>  $qval4,     # boolean
    'ignore_unavailable'       =>  $qval5,     # boolean
    'include_defaults'         =>  $qval6,     # boolean
    'local'                    =>  $qval7,     # boolean
    'master_timeout'           =>  $qval8,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval9,     # boolean
    'filter_path'              =>  $qval10,    # list
    'human'                    =>  $qval11,    # boolean
    'pretty'                   =>  $qval12,    # boolean
    'source'                   =>  $qval13,    # string
);

OpenSearch documentation for indices->get_settings

get_template

Returns an index template.

Paths served by this method:

GET /_template
GET /_template/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->get_template(
    
     # path parameters
    
    'name'                     =>  $name,      # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'flat_settings'            =>  $qval2,     # boolean
    'local'                    =>  $qval3,     # boolean
    'master_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 indices->get_template

get_upgrade

The `_upgrade` API is no longer useful and will be removed.

Paths served by this method:

GET /_upgrade
GET /{index}/_upgrade

Method added in OpenSearch version 1.0

$resp = $client->indices->get_upgrade(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'ignore_unavailable'  =>  $qval3,     # boolean
    
     # Common API query string parameters
    
    'error_trace'         =>  $qval4,     # boolean
    'filter_path'         =>  $qval5,     # list
    'human'               =>  $qval6,     # boolean
    'pretty'              =>  $qval7,     # boolean
    'source'              =>  $qval8,     # string
);

OpenSearch documentation for indices->get_upgrade

open

Opens an index.

Paths served by this method:

POST /{index}/_open

Method added in OpenSearch version 1.0

$resp = $client->indices->open(
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'ignore_unavailable'       =>  $qval4,     # boolean
    'master_timeout'           =>  $qval5,     # string
    'task_execution_timeout'   =>  $qval6,     # string
    'timeout'                  =>  $qval7,     # string
    'wait_for_active_shards'   =>  $qval8,     # string
    'wait_for_completion'      =>  $qval9,     # boolean
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval10,    # boolean
    'filter_path'              =>  $qval11,    # list
    'human'                    =>  $qval12,    # boolean
    'pretty'                   =>  $qval13,    # boolean
    'source'                   =>  $qval14,    # string
);

OpenSearch documentation for indices->open

put_alias

Creates or updates an alias.

Paths served by this method:

POST /_alias/{name}
POST /_aliases/{name}
POST /{index}/_alias/{name}
POST /{index}/_aliases/{name}
PUT /_alias
PUT /_alias/{name}
PUT /_aliases/{name}
PUT /{index}/_alias
PUT /{index}/_alias/{name}
PUT /{index}/_aliases
PUT /{index}/_aliases/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->put_alias(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'index'                    =>  $index,     # optional
    'name'                     =>  $name,      # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    'timeout'                  =>  $qval3,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval4,     # boolean
    'filter_path'              =>  $qval5,     # list
    'human'                    =>  $qval6,     # boolean
    'pretty'                   =>  $qval7,     # boolean
    'source'                   =>  $qval8,     # string
);

OpenSearch documentation for indices->put_alias

put_index_template

Creates or updates an index template.

Paths served by this method:

POST /_index_template/{name}
PUT /_index_template/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->put_index_template(
    
    'body'                     =>  $body,      # required
    
     # path parameters
    
    'name'                     =>  $name,      # required
    
     # Endpoint specific query string parameters
    
    'cause'                    =>  $qval1,     # string
    'cluster_manager_timeout'  =>  $qval2,     # string
    'create'                   =>  $qval3,     # boolean
    'master_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 indices->put_index_template

put_mapping

Updates the index mappings.

Paths served by this method:

POST /{index}/_mapping
PUT /{index}/_mapping

Method added in OpenSearch version 1.0

$resp = $client->indices->put_mapping(
    
    'body'                     =>  $body,      # required
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'ignore_unavailable'       =>  $qval4,     # boolean
    'master_timeout'           =>  $qval5,     # string
    'timeout'                  =>  $qval6,     # string
    'write_index_only'         =>  $qval7,     # boolean
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval8,     # boolean
    'filter_path'              =>  $qval9,     # list
    'human'                    =>  $qval10,    # boolean
    'pretty'                   =>  $qval11,    # boolean
    'source'                   =>  $qval12,    # string
);

OpenSearch documentation for indices->put_mapping

put_settings

Updates the index settings.

Paths served by this method:

PUT /_settings
PUT /{index}/_settings

Method added in OpenSearch version 1.0

$resp = $client->indices->put_settings(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'index'                    =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'         =>  $qval1,     # boolean
    'cluster_manager_timeout'  =>  $qval2,     # string
    'expand_wildcards'         =>  $qval3,     # list
    'flat_settings'            =>  $qval4,     # boolean
    'ignore_unavailable'       =>  $qval5,     # boolean
    'master_timeout'           =>  $qval6,     # string
    'preserve_existing'        =>  $qval7,     # boolean
    'timeout'                  =>  $qval8,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval9,     # boolean
    'filter_path'              =>  $qval10,    # list
    'human'                    =>  $qval11,    # boolean
    'pretty'                   =>  $qval12,    # boolean
    'source'                   =>  $qval13,    # string
);

OpenSearch documentation for indices->put_settings

put_template

Creates or updates an index template.

Paths served by this method:

POST /_template/{name}
PUT /_template/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->put_template(
    
    'body'                     =>  $body,      # required
    
     # path parameters
    
    'name'                     =>  $name,      # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'create'                   =>  $qval2,     # boolean
    'master_timeout'           =>  $qval3,     # string
    'order'                    =>  $qval4,     # number
    
     # 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 indices->put_template

recovery

Returns information about ongoing index shard recoveries.

Paths served by this method:

GET /_recovery
GET /{index}/_recovery

Method added in OpenSearch version 1.0

$resp = $client->indices->recovery(
    
     # path parameters
    
    'index'        =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'active_only'  =>  $qval1,     # boolean
    'detailed'     =>  $qval2,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval3,     # boolean
    'filter_path'  =>  $qval4,     # list
    'human'        =>  $qval5,     # boolean
    'pretty'       =>  $qval6,     # boolean
    'source'       =>  $qval7,     # string
);

OpenSearch documentation for indices->recovery

refresh

Performs the refresh operation in one or more indexes.

Paths served by this method:

GET /_refresh
GET /{index}/_refresh
POST /_refresh
POST /{index}/_refresh

Method added in OpenSearch version 1.0

$resp = $client->indices->refresh(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'ignore_unavailable'  =>  $qval3,     # boolean
    
     # Common API query string parameters
    
    'error_trace'         =>  $qval4,     # boolean
    'filter_path'         =>  $qval5,     # list
    'human'               =>  $qval6,     # boolean
    'pretty'              =>  $qval7,     # boolean
    'source'              =>  $qval8,     # string
);

OpenSearch documentation for indices->refresh

resolve_index

Returns information about any matching indexes, aliases, and data streams.

Paths served by this method:

GET /_resolve/index/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->resolve_index(
    
     # path parameters
    
    'name'              =>  $name,      # required
    
     # Endpoint specific query string parameters
    
    'expand_wildcards'  =>  $qval1,     # list
    
     # Common API query string parameters
    
    'error_trace'       =>  $qval2,     # boolean
    'filter_path'       =>  $qval3,     # list
    'human'             =>  $qval4,     # boolean
    'pretty'            =>  $qval5,     # boolean
    'source'            =>  $qval6,     # string
);

OpenSearch documentation for indices->resolve_index

rollover

Updates an alias to point to a new index when the existing index is considered to be too large or too old.

Paths served by this method:

POST /{alias}/_rollover
POST /{alias}/_rollover/{new_index}

Method added in OpenSearch version 1.0

$resp = $client->indices->rollover(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'alias'                    =>  $alias,     # required
    'new_index'                =>  $new_index,  # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'dry_run'                  =>  $qval2,     # boolean
    'master_timeout'           =>  $qval3,     # string
    'timeout'                  =>  $qval4,     # string
    'wait_for_active_shards'   =>  $qval5,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval6,     # boolean
    'filter_path'              =>  $qval7,     # list
    'human'                    =>  $qval8,     # boolean
    'pretty'                   =>  $qval9,     # boolean
    'source'                   =>  $qval10,    # string
);

OpenSearch documentation for indices->rollover

segments

Provides low-level information about segments in a Lucene index.

Paths served by this method:

GET /_segments
GET /{index}/_segments

Method added in OpenSearch version 1.0

$resp = $client->indices->segments(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'ignore_unavailable'  =>  $qval3,     # boolean
    'verbose'             =>  $qval4,     # boolean
    
     # 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 indices->segments

shard_stores

Provides store information for shard copies of indexes.

Paths served by this method:

GET /_shard_stores
GET /{index}/_shard_stores

Method added in OpenSearch version 1.0

$resp = $client->indices->shard_stores(
    
     # path parameters
    
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'    =>  $qval1,     # boolean
    'expand_wildcards'    =>  $qval2,     # list
    'ignore_unavailable'  =>  $qval3,     # boolean
    'status'              =>  $qval4,     # list
    
     # 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 indices->shard_stores

shrink

Allow to shrink an existing index into a new index with fewer primary shards.

Paths served by this method:

POST /{index}/_shrink/{target}
PUT /{index}/_shrink/{target}

Method added in OpenSearch version 1.0

$resp = $client->indices->shrink(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'index'                    =>  $index,     # required
    'target'                   =>  $target,    # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'copy_settings'            =>  $qval2,     # boolean
    'master_timeout'           =>  $qval3,     # string
    'task_execution_timeout'   =>  $qval4,     # string
    'timeout'                  =>  $qval5,     # string
    'wait_for_active_shards'   =>  $qval6,     # string
    'wait_for_completion'      =>  $qval7,     # boolean
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval8,     # boolean
    'filter_path'              =>  $qval9,     # list
    'human'                    =>  $qval10,    # boolean
    'pretty'                   =>  $qval11,    # boolean
    'source'                   =>  $qval12,    # string
);

OpenSearch documentation for indices->shrink

simulate_index_template

Simulate matching the given index name against the index templates in the system.

Paths served by this method:

POST /_index_template/_simulate_index/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->simulate_index_template(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'name'                     =>  $name,      # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval3,     # boolean
    'filter_path'              =>  $qval4,     # list
    'human'                    =>  $qval5,     # boolean
    'pretty'                   =>  $qval6,     # boolean
    'source'                   =>  $qval7,     # string
);

OpenSearch documentation for indices->simulate_index_template

simulate_template

Simulate resolving the given template name or body.

Paths served by this method:

POST /_index_template/_simulate
POST /_index_template/_simulate/{name}

Method added in OpenSearch version 1.0

$resp = $client->indices->simulate_template(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'name'                     =>  $name,      # optional
    
     # Endpoint specific query string parameters
    
    'cause'                    =>  $qval1,     # string
    'cluster_manager_timeout'  =>  $qval2,     # string
    'create'                   =>  $qval3,     # boolean
    'master_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 indices->simulate_template

split

Allows you to split an existing index into a new index with more primary shards.

Paths served by this method:

POST /{index}/_split/{target}
PUT /{index}/_split/{target}

Method added in OpenSearch version 1.0

$resp = $client->indices->split(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'index'                    =>  $index,     # required
    'target'                   =>  $target,    # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'copy_settings'            =>  $qval2,     # boolean
    'master_timeout'           =>  $qval3,     # string
    'task_execution_timeout'   =>  $qval4,     # string
    'timeout'                  =>  $qval5,     # string
    'wait_for_active_shards'   =>  $qval6,     # string
    'wait_for_completion'      =>  $qval7,     # boolean
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval8,     # boolean
    'filter_path'              =>  $qval9,     # list
    'human'                    =>  $qval10,    # boolean
    'pretty'                   =>  $qval11,    # boolean
    'source'                   =>  $qval12,    # string
);

OpenSearch documentation for indices->split

stats

Provides statistics on operations happening in an index.

Paths served by this method:

GET /_stats
GET /_stats/{metric}
GET /{index}/_stats
GET /{index}/_stats/{metric}

Method added in OpenSearch version 1.0

$resp = $client->indices->stats(
    
     # path parameters
    
    'index'                       =>  $index,     # optional
    'metric'                      =>  $metric,    # optional
    
     # Endpoint specific query string parameters
    
    'completion_fields'           =>  $qval1,     # list
    'expand_wildcards'            =>  $qval2,     # list
    'fielddata_fields'            =>  $qval3,     # list
    'fields'                      =>  $qval4,     # list
    'forbid_closed_indices'       =>  $qval5,     # boolean
    'groups'                      =>  $qval6,     # list
    'include_segment_file_sizes'  =>  $qval7,     # boolean
    'include_unloaded_segments'   =>  $qval8,     # boolean
    'level'                       =>  $qval9,     # string
    
     # Common API query string parameters
    
    'error_trace'                 =>  $qval10,    # boolean
    'filter_path'                 =>  $qval11,    # list
    'human'                       =>  $qval12,    # boolean
    'pretty'                      =>  $qval13,    # boolean
    'source'                      =>  $qval14,    # string
);

OpenSearch documentation for indices->stats

update_aliases

Updates index aliases.

Paths served by this method:

POST /_aliases

Method added in OpenSearch version 1.0

$resp = $client->indices->update_aliases(
    
    'body'                     =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    'timeout'                  =>  $qval3,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval4,     # boolean
    'filter_path'              =>  $qval5,     # list
    'human'                    =>  $qval6,     # boolean
    'pretty'                   =>  $qval7,     # boolean
    'source'                   =>  $qval8,     # string
);

OpenSearch documentation for indices->update_aliases

upgrade

The `_upgrade` API is no longer useful and will be removed.

Paths served by this method:

POST /_upgrade
POST /{index}/_upgrade

Method added in OpenSearch version 1.0

$resp = $client->indices->upgrade(
    
     # path parameters
    
    'index'                  =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'allow_no_indices'       =>  $qval1,     # boolean
    'expand_wildcards'       =>  $qval2,     # list
    'ignore_unavailable'     =>  $qval3,     # boolean
    'only_ancient_segments'  =>  $qval4,     # boolean
    'wait_for_completion'    =>  $qval5,     # boolean
    
     # Common API query string parameters
    
    'error_trace'            =>  $qval6,     # boolean
    'filter_path'            =>  $qval7,     # list
    'human'                  =>  $qval8,     # boolean
    'pretty'                 =>  $qval9,     # boolean
    'source'                 =>  $qval10,    # string
);

OpenSearch documentation for indices->upgrade

validate_query

Allows a user to validate a potentially expensive query without executing it.

Paths served by this method:

GET /_validate/query
GET /{index}/_validate/query
POST /_validate/query
POST /{index}/_validate/query

Method added in OpenSearch version 1.0

$resp = $client->indices->validate_query(
    
    'body'                =>  $body,      # optional
    
     # path parameters
    
    'index'               =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'all_shards'          =>  $qval1,     # boolean
    'allow_no_indices'    =>  $qval2,     # boolean
    'analyze_wildcard'    =>  $qval3,     # boolean
    'analyzer'            =>  $qval4,     # string
    'default_operator'    =>  $qval5,     # string
    'df'                  =>  $qval6,     # string
    'expand_wildcards'    =>  $qval7,     # list
    'explain'             =>  $qval8,     # boolean
    'ignore_unavailable'  =>  $qval9,     # boolean
    'lenient'             =>  $qval10,    # boolean
    'q'                   =>  $qval11,    # string
    'rewrite'             =>  $qval12,    # boolean
    
     # Common API query string parameters
    
    'error_trace'         =>  $qval13,    # boolean
    'filter_path'         =>  $qval14,    # list
    'human'               =>  $qval15,    # boolean
    'pretty'              =>  $qval16,    # boolean
    'source'              =>  $qval17,    # string
);

OpenSearch documentation for indices->validate_query

method_supported_in_version

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

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

Both method and version are required.

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

To install OpenSearch::Client, copy and paste the appropriate command in to your terminal.

cpanm

cpanm OpenSearch::Client

CPAN shell

perl -MCPAN -e shell
install OpenSearch::Client

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

METHODS

add_block

analyze

clear_cache

clone

close

create

create_data_stream

data_streams_stats

delete

delete_alias

delete_data_stream

delete_index_template

delete_template

exists

exists_alias

exists_index_template

exists_template

flush

forcemerge

get

get_alias

get_data_stream

get_field_mapping

get_index_template

get_mapping

get_settings

get_template

get_upgrade

open

put_alias

put_index_template

put_mapping

put_settings

put_template

recovery

refresh

resolve_index

rollover

segments

shard_stores

shrink

simulate_index_template

simulate_template

split

stats

update_aliases

upgrade

validate_query

method_supported_in_version

MANUAL

HISTORY

AUTHOR

CREDITS

COPYRIGHT AND LICENSE

Module Install Instructions

Keyboard Shortcuts