Namespace: API-Index

API-Index

Source:

Methods

(static) IndicesApi#addBlock(params, options, callback) → {Object|Promise.<never>|*}

Adds a block to an index.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string A comma separated list of indices to add a block to
block string The block to add (one of read, write, read_only or metadata)
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#analyze(params, options, callback) → {Object|Promise.<never>|*}

Performs the analysis process on a text and return the tokens breakdown of the text.
See Also: OpenSearch - Perform text analysis
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string <optional>
 The name of the index to scope the operation
body Object <optional>
 Define analyzer/tokenizer parameters and the text on which the analysis should be performed
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#clearCache(params, options, callback) → {Object|Promise.<never>|*}

Clears all or specific caches for one or more indices.
See Also: OpenSearch - Clear index or data stream cache
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string <optional>
 A comma-separated list of index name to limit the operation
fielddata boolean <optional>
 Clear field data
fields string <optional>
 A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
query boolean <optional>
 Clear query caches
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
request boolean <optional>
 Clear request cache
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#clone(params, options, callback) → {Object|Promise.<never>|*}

Clones an index
See Also: OpenSearch - Clone Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string The name of the source index to clone
target string The name of the target index to clone into
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
wait_for_active_shards string <optional>
 Set the number of active shards to wait for on the cloned index before the operation returns.
body Object <optional>
 The configuration for the target index (`settings` and `aliases`)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#close(params, options, callback) → {Object|Promise.<never>|*}

Closes an index.
See Also: OpenSearch - Close Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string A comma separated list of indices to close
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
wait_for_active_shards string <optional>
 Sets the number of active shards to wait for before the operation returns. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`.
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#create(params, options, callback) → {Object|Promise.<never>|*}

Creates an index
See Also: OpenSearch - Create Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string Name of the index.
body Object <optional>
 The configuration for the index (`settings` and `mappings`)
wait_for_active_shards string <optional>
 Set the number of active shards to wait for before the operation returns.
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#delete(params, options, callback) → {Object|Promise.<never>|*}

Deletes an index.
See Also: OpenSearch - Delete Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
ignore_unavailable boolean <optional>
 false Ignore unavailable indexes
allow_no_indices boolean <optional>
 false Ignore if a wildcard expression resolves to no concrete indices
expand_wildcards string <optional>
 open Whether wildcard expressions should get expanded to open or closed indices (options: open, closed, hidden, none, all)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#deleteAlias(params, options, callback) → {Object|Promise.<never>|*}

Deletes an alias.
See Also: OpenSearch - Index Aliases
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string A comma-separated list of index names (supports wildcards); use `_all` for all indices
name string A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
timeout string <optional>
 Explicit timestamp for the document
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#deleteIndexTemplate(params, options, callback) → {Object|Promise.<never>|*}

Deletes an index template.
See Also: OpenSearch - Index Templates
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
name string The name of the template
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#deleteTemplate(params, options, callback) → {Object|Promise.<never>|*}

Deletes an index template (Deprecated. Use IndicesApi#deleteIndexTemplate instead)
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
name string The name of the template
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#exists(params, options, callback) → {Object|Promise.<never>|*}

Returns information about whether a particular index exists.
See Also: OpenSearch - Index Exists
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string A comma-separated list of index names
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
ignore_unavailable boolean <optional>
 false Ignore unavailable indexes
allow_no_indices boolean <optional>
 false Ignore if a wildcard expression resolves to no concrete indices
expand_wildcards string <optional>
 open Whether wildcard expressions should get expanded to open or closed indices (options: open, closed, hidden, none, all)
flat_settings boolean <optional>
 false Return settings in flat format
include_defaults boolean <optional>
 Whether to return all default setting for each of the indices.
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#existsAlias(params, options, callback) → {Object|Promise.<never>|*}

Returns information about whether a particular alias exists.
See Also: OpenSearch - Index Aliases
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
name string A comma-separated list of alias names to return
index string <optional>
 A comma-separated list of index names to filter aliases
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#existsIndexTemplate(params, options, callback) → {Object|Promise.<never>|*}

Returns information about whether a particular index template exists.
See Also: OpenSearch - Index Templates
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
name string The name of the template
flat_settings boolean <optional>
 false Return settings in flat format
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#existsTemplate(params, options, callback) → {Object|Promise.<never>|*}

Returns information about whether a particular index template exists. (Deprecated. Use IndicesApi#existsIndexTemplate instead)
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
name string The comma separated names of the index templates
flat_settings boolean <optional>
 false Return settings in flat format
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#flush(params, options, callback) → {Object|Promise.<never>|*}

Performs the flush operation on one or more indices.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string for all indices
force boolean <optional>
 Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
wait_if_ongoing boolean <optional>
 true If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#forcemerge(params, options, callback) → {Object|Promise.<never>|*}

Performs the force merge operation on one or more indices.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
flush boolean <optional>
 true Specify whether the index should be flushed after performing the operation
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
max_num_segments number <optional>
 The number of segments the index should be merged into (default: dynamic)
only_expunge_deletes boolean <optional>
 Specify whether the operation should only expunge deleted documents
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#get(params, options, callback) → {Object|Promise.<never>|*}

Returns information about one or more indices.
See Also: OpenSearch - Get Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string A comma-separated list of index names
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
ignore_unavailable boolean <optional>
 false Ignore unavailable indexes
allow_no_indices boolean <optional>
 false Ignore if a wildcard expression resolves to no concrete indices
expand_wildcards string <optional>
 open Whether wildcard expressions should get expanded to open or closed indices (options: open, closed, hidden, none, all)
flat_settings boolean <optional>
 false Return settings in flat format
include_defaults boolean <optional>
 Whether to return all default setting for each of the indices.
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#getAlias(params, options, callback) → {Object|Promise.<never>|*}

Returns an alias.
See Also: OpenSearch - Index Aliases
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
name string <optional>
 A comma-separated list of alias names to return
index string <optional>
 A comma-separated list of index names to filter aliases
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#getFieldMapping(params, options, callback) → {Object|Promise.<never>|*}

Returns mapping for one or more fields.
See Also: OpenSearch - Mapping
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
fields string A comma-separated list of fields
index string <optional>
 A comma-separated list of index names
include_defaults boolean <optional>
 Whether the default mapping values should be returned as well
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#getIndexTemplate(params, options, callback) → {Object|Promise.<never>|*}

Returns an index template.
See Also: OpenSearch - Index Templates
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
name string <optional>
 The comma separated names of the index templates
flat_setting boolean <optional>
 false Return settings in flat format
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#getMapping(params, options, callback) → {Object|Promise.<never>|*}

Returns mappings for one or more indices.
See Also: OpenSearch - Mapping
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string <optional>
 A comma-separated list of index names
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node (Deprecated)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#getSettings(params, options, callback) → {Object|Promise.<never>|*}

Returns settings for one or more indices.
See Also: OpenSearch - Get Settings
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
name string <optional>
 The name of the settings that should be included
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
flat_settings boolean <optional>
 false Return settings in flat format
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
include_defaults boolean <optional>
 Whether to return all default setting for each of the indices.
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#getTemplate(params, options, callback) → {Object|Promise.<never>|*}

Returns an index template. (Deprecated. Use IndicesApi#getIndexTemplate instead)
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
name string <optional>
 The comma separated names of the index templates
flat_settings boolean <optional>
 false Return settings in flat format
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
local boolean <optional>
 false Return local information, do not retrieve the state from cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#getUpgrade(params, options, callback) → {Object|Promise.<never>|*}

Returns a progress status of current upgrade. (Deprecated. Use API-Document#reindex instead)
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#open(params, options, callback) → {Object|Promise.<never>|*}

ROpens an index.
See Also: OpenSearch - Open Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string A comma separated list of indices to open
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
wait_for_active_shards string <optional>
 Sets the number of active shards to wait for before the operation returns.
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#putAlias(params, options, callback) → {Object|Promise.<never>|*}

Creates or updates an alias.
See Also: OpenSearch - Index Aliases
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
name string The name of the alias to be created or updated
timeout string <optional>
 Explicit timestamp for the document
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
body Object <optional>
 The settings for the alias, such as `routing` or `filter`
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#putIndexTemplate(params, options, callback) → {Object|Promise.<never>|*}

Creates or updates an index template.
See Also: OpenSearch - Index Templates
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
name string The name of the template
body Object The template definition
create boolean <optional>
 Whether the index template should only be added if new or can also replace an existing one
cause string <optional>
 User defined reason for creating/updating the index template
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#putMapping(params, options, callback) → {Object|Promise.<never>|*}

Updates index mappings.
See Also: OpenSearch - Create or Update Mapping
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
body Object The mapping definition
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
write_index_only boolean <optional>
 When true, applies mappings only to the write index of an alias or data stream
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#putSettings(params, options, callback) → {Object|Promise.<never>|*}

Updates the index settings.
See Also: OpenSearch - Update Settings
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
body Object The index settings to be updated
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
timeout string <optional>
 Explicit operation timeout
preserve_existing boolean <optional>
 false Whether to update existing settings. If set to `true` existing settings on an index remain unchanged
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
flat_settings boolean <optional>
 false Return settings in flat format
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#putTemplate(params, options, callback) → {Object|Promise.<never>|*}

Creates or updates an index template. (Deprecated. Use IndicesApi#putIndexTemplate instead)
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
name string The name of the template
body Object The template definition
order number <optional>
 The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
create boolean <optional>
 Whether the index template should only be added if new or can also replace an existing one
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#recovery(params, options, callback) → {Object|Promise.<never>|*}

Returns information about ongoing index shard recoveries.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
detailed boolean <optional>
 Whether to display detailed information about shard recovery
active_only boolean <optional>
 Display only those recoveries that are currently on-going
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#refresh(params, options, callback) → {Object|Promise.<never>|*}

Performs the refresh operation in one or more indices.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#resolveIndex(params, options, callback) → {Object|Promise.<never>|*}

Returns information about any matching indices, aliases, and data streams
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
name string <optional>
 A comma-separated list of names or wildcard expressions
expand_wildcards string <optional>
 open Whether wildcard expressions should get expanded to open or closed indices (options: open, closed, hidden, none, all)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#rollover(params, options, callback) → {Object|Promise.<never>|*}

Updates an alias to point to a new index when the existing index is considered to be too large or too old.
See Also: OpenSearch - Rollover a data stream
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
alias string The name of the alias to rollover
new_index string <optional>
 The name of the rollover index
timeout string <optional>
 Explicit operation timeout
dry_run boolean <optional>
 false If set to true the rollover action will only be validated but not actually performed even if a condition matches.
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
wait_for_active_shards string <optional>
 Set the number of active shards to wait for on the newly created rollover index before the operation returns.
body Object <optional>
 The conditions that needs to be met for executing rollover
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#segments(params, options, callback) → {Object|Promise.<never>|*}

Provides low-level information about segments in a Lucene index.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
verbose boolean <optional>
 Includes detailed memory usage by Lucene.
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#shardStores(params, options, callback) → {Object|Promise.<never>|*}

Provides store information for shard copies of indices.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
status string <optional>
 A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all)
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#shrink(params, options, callback) → {Object|Promise.<never>|*}

Allow to shrink an existing index into a new index with fewer primary shards.
See Also: OpenSearch - Shrink Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string The name of the source index to shrink
target string The name of the target index to shrink into
copy_settings boolean <optional>
 whether or not to copy settings from the source index (defaults to false)
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
wait_for_active_shards string <optional>
 Set the number of active shards to wait for on the shrunken index before the operation returns.
body Object <optional>
 The configuration for the target index (`settings` and `aliases`)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#simulateIndexTemplate(params, options, callback) → {Object|Promise.<never>|*}

Simulate matching the given index name against the index templates in the system
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
name string The name of the index (it must be a concrete index name)
body Object <optional>
 New index template definition, which will be included in the simulation, as if it already exists in the system
create boolean <optional>
 Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
cause string <optional>
 User defined reason for dry-run creating the new template for simulation purposes
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#simulateTemplate(params, options, callback) → {Object|Promise.<never>|*}

Simulate resolving the given template name or body (Deprecated. Use IndicesApi#simulateIndexTemplate instead)
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
name string <optional>
 The name of the index template
create boolean <optional>
 Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
cause string <optional>
 User defined reason for dry-run creating the new template for simulation purposes
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
body Object <optional>
 New index template definition to be simulated, if no index template name is specified
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#split(params, options, callback) → {Object|Promise.<never>|*}

Allows you to split an existing index into a new index with more primary shards.
See Also: OpenSearch - Split Index
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
index string The name of the source index to split
target string The name of the target index to split into
copy_settings boolean <optional>
 whether or not to copy settings from the source index (defaults to false)
timeout string <optional>
 Explicit operation timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
wait_for_active_shards string <optional>
 Set the number of active shards to wait for on the shrunken index before the operation returns.
body Object <optional>
 The configuration for the target index (`settings` and `aliases`)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#stats(params, options, callback) → {Object|Promise.<never>|*}

Provides statistics on operations happening in an index.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
metric string <optional>
 Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest)
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
completion_fields string <optional>
 A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
fielddata_fields string <optional>
 A comma-separated list of fields for `fielddata` index metric (supports wildcards)
fields string <optional>
 A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
groups string <optional>
 A comma-separated list of search groups for `search` index metric
level string <optional>
 Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards)
types string <optional>
 A comma-separated list of document types for the `indexing` index metric
include_segment_file_sizes boolean <optional>
 Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
include_unloaded_segments boolean <optional>
 If set to true segment stats will include stats for segments that are not currently loaded into memory
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
forbid_closed_indices boolean <optional>
 If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#updateAliases(params, options, callback) → {Object|Promise.<never>|*}

Update an alias.
See Also: OpenSearch - Index Aliases
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
body Object The definition of `actions` to perform
timeout string <optional>
 Request timeout
cluster_manager_timeout string <optional>
 Specify timeout for connection to cluster_manager
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#upgrade(params, options, callback) → {Object|Promise.<never>|*}

Upgrades to the current version of Lucene.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
wait_for_completion boolean <optional>
 false Specify whether the request should block until the all segments are upgraded
only_ancient_segments boolean <optional>
 If true, only ancient (an older Lucene major release) segments will be upgraded
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IndicesApi#validateQuery(params, options, callback) → {Object|Promise.<never>|*}

Allows a user to validate a potentially expensive query without executing it.
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
index string A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
explain boolean <optional>
 Return detailed information about the error
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
q string <optional>
 Query in the Lucene query string syntax
analyzer string <optional>
 The analyzer to use for the query string
analyze_wildcard boolean <optional>
 false Specify whether wildcard and prefix queries should be analyzed
default_operator string <optional>
 OR The default operator for query string query (options: AND, OR)
df string <optional>
 The field to use as default where no field prefix is given in the query string
lenient boolean <optional>
 Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
rewrite boolean <optional>
 Provide a more detailed explanation showing the actual Lucene query that will be executed.
all_shards boolean <optional>
 Execute validation on all shards instead of one random shard per index
body Object <optional>
 The query definition specified with the Query DSL
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) fieldCapsApi(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}

Returns the information about the capabilities of fields among multiple indices.
See also: OpenSearch - Alias
Parameters:
Name Type Attributes Description
params Object
Properties
Name Type Attributes Description
index string <optional>
 A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
fields string <optional>
 A comma-separated list of field names
ignore_unavailable boolean <optional>
 Whether specified concrete indices should be ignored when unavailable (missing or closed)
allow_no_indices boolean <optional>
 Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
expand_wildcards string <optional>
 Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
include_unmapped boolean <optional>
 Indicates whether unmapped fields should be included in the response.
body Object <optional>
 An index filter specified with the Query DSL
options Object <optional>
 Options for Transport#request
callback function <optional>
 Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *