NAME
OpenSearch::Client::Core::3_0::Direct::Indices
VERSION
version 3.007002
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
indices->add_block
Adds a block to an index.
Paths served by this method:
$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
indices->analyze
Performs the analysis process on a text and return the tokens breakdown of the text.
Paths served by this method:
$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
indices->clear_cache
Clears all or specific caches for one or more indexes.
Paths served by this method:
$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
indices->clone
Clones an index.
Paths served by this method:
$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
indices->close
Closes an index.
Paths served by this method:
$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
indices->create
Creates an index with optional settings and mappings.
Paths served by this method:
$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
indices->create_data_stream
Creates or updates a data stream.
Paths served by this method:
$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
indices->data_streams_stats
Provides statistics on operations happening in a data stream.
Paths served by this method:
$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
indices->delete
Deletes an index.
Paths served by this method:
$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
indices->delete_alias
Deletes an alias.
Paths served by this method:
$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
indices->delete_data_stream
Deletes a data stream.
Paths served by this method:
$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
indices->delete_index_template
Deletes an index template.
Paths served by this method:
$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
indices->delete_template
Deletes an index template.
Paths served by this method:
$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
indices->exists
Returns information about whether a particular index exists.
Paths served by this method:
$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
indices->exists_alias
Returns information about whether a particular alias exists.
Paths served by this method:
$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
indices->exists_index_template
Returns information about whether a particular index template exists.
Paths served by this method:
$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
indices->exists_template
Returns information about whether a particular index template exists.
Paths served by this method:
$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
indices->flush
Performs the flush operation on one or more indexes.
Paths served by this method:
$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
indices->forcemerge
Performs the force merge operation on one or more indexes.
Paths served by this method:
$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
indices->get
Returns information about one or more indexes.
Paths served by this method:
$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
indices->get_alias
Returns an alias.
Paths served by this method:
$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
indices->get_data_stream
Returns data streams.
Paths served by this method:
$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
indices->get_field_mapping
Returns mapping for one or more fields.
Paths served by this method:
$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
indices->get_index_template
Returns an index template.
Paths served by this method:
$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
indices->get_mapping
Returns mappings for one or more indexes.
Paths served by this method:
$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
indices->get_settings
Returns settings for one or more indexes.
Paths served by this method:
$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
indices->get_template
Returns an index template.
Paths served by this method:
$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
indices->get_upgrade
The `_upgrade` API is no longer useful and will be removed.
Paths served by this method:
$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
indices->open
Opens an index.
Paths served by this method:
$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
indices->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 /_aliasPUT /_alias/{name}PUT /_aliases/{name}PUT /{index}/_aliasPUT /{index}/_alias/{name}PUT /{index}/_aliasesPUT /{index}/_aliases/{name}
$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
indices->put_index_template
Creates or updates an index template.
Paths served by this method:
$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
indices->put_mapping
Updates the index mappings.
Paths served by this method:
$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
indices->put_settings
Updates the index settings.
Paths served by this method:
$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
indices->put_template
Creates or updates an index template.
Paths served by this method:
$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
indices->recovery
Returns information about ongoing index shard recoveries.
Paths served by this method:
$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
indices->refresh
Performs the refresh operation in one or more indexes.
Paths served by this method:
$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
indices->resolve_index
Returns information about any matching indexes, aliases, and data streams.
Paths served by this method:
$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
indices->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:
$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
indices->segments
Provides low-level information about segments in a Lucene index.
Paths served by this method:
$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
indices->shard_stores
Provides store information for shard copies of indexes.
Paths served by this method:
$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
indices->shrink
Allow to shrink an existing index into a new index with fewer primary shards.
Paths served by this method:
$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
indices->simulate_index_template
Simulate matching the given index name against the index templates in the system.
Paths served by this method:
$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
indices->simulate_template
Simulate resolving the given template name or body.
Paths served by this method:
$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
indices->split
Allows you to split an existing index into a new index with more primary shards.
Paths served by this method:
$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
indices->stats
Provides statistics on operations happening in an index.
Paths served by this method:
$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
indices->update_aliases
Updates index aliases.
Paths served by this method:
$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
indices->upgrade
The `_upgrade` API is no longer useful and will be removed.
Paths served by this method:
$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
indices->validate_query
Allows a user to validate a potentially expensive query without executing it.
Paths served by this method:
GET /_validate/queryGET /{index}/_validate/queryPOST /_validate/queryPOST /{index}/_validate/query
$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
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