RubyDoc.info: Module: Elasticsearch::API::Indices::Actions – Documentation for elasticsearch-api (9.1.2)

#add_block(arguments = {}) ⇒ `Object`

Add an index block. Add an index block to an index. Index blocks limit the operations allowed on an index by blocking specific operation types.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —

A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with ‘_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. (Required)
:block (String) —

The block type to add to the index. (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
:expand_wildcards (String, Array<String>) —

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:master_timeout (Time) —

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to ‘-1` to indicate that the request should never timeout. Server default: 30s.
:timeout (Time) —

The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to ‘-1` to indicate that the request should never timeout. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block

# File 'lib/elasticsearch/api/actions/indices/add_block.rb', line 62

def add_block(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.add_block' }

  defined_params = [:index, :block].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'block' missing" unless arguments[:block]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  _block = arguments.delete(:block)

  method = Elasticsearch::API::HTTP_PUT
  path   = "#{Utils.listify(_index)}/_block/#{Utils.listify(_block)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#analyze(arguments = {}) ⇒ `Object`

Get tokens from text analysis. The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The ‘index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The `_analyze` endpoint without a specified index will always use `10000` as its limit.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —

Index used to derive the analyzer. If specified, the ‘analyzer` or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze

# File 'lib/elasticsearch/api/actions/indices/analyze.rb', line 51

def analyze(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.analyze' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = if body
             Elasticsearch::API::HTTP_POST
           else
             Elasticsearch::API::HTTP_GET
           end

  path   = if _index
             "#{Utils.listify(_index)}/_analyze"
           else
             '_analyze'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#cancel_migrate_reindex(arguments = {}) ⇒ `Object`

Cancel a migration reindex operation. Cancel a migration reindex attempt for a data stream or index. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

The index or data stream name (Required)
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-cancel-migrate-reindex

# File 'lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb', line 48

def cancel_migrate_reindex(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.cancel_migrate_reindex' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "_migration/reindex/#{Utils.listify(_index)}/_cancel"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#clear_cache(arguments = {}) ⇒ `Object`

Clear the cache. Clear the cache of one or more indices. For data streams, the API clears the caches of the stream’s backing indices. By default, the clear cache API clears all caches. To clear only specific caches, use the ‘fielddata`, `query`, or `request` parameters. To clear the cache only of specific fields, use the `fields` parameter.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:fielddata (Boolean) —

If ‘true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only.
:fields (String, Array<String>) —

Comma-separated list of field names used to limit the ‘fielddata` parameter.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:query (Boolean) —

If ‘true`, clears the query cache.
:request (Boolean) —

If ‘true`, clears the request cache.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache

# File 'lib/elasticsearch/api/actions/indices/clear_cache.rb', line 61

def clear_cache(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.clear_cache' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = if _index
             "#{Utils.listify(_index)}/_cache/clear"
           else
             '_cache/clear'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#clone(arguments = {}) ⇒ `Object`

Clone an index. Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch does not apply index templates to the resulting index. The API also does not copy index metadata from the original index. Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. For example, if you clone a CCR follower index, the resulting clone will not be a follower index. The clone API copies most index settings from the source index to the resulting index, with the exception of ‘index.number_of_replicas` and `index.auto_expand_replicas`. To set the number of replicas in the resulting index, configure these settings in the clone request. Cloning works as follows:

First, it creates a new target index with the same definition as the source index.
Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.
Finally, it recovers the target index as though it were a closed index which had just been re-opened.

IMPORTANT: Indices can only be cloned if they meet the following requirements:

The index must be marked as read-only and have a cluster health status of green.
The target index must not exist.
The source index must have the same number of primary shards as the target index.
The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.

The current write index on a data stream cannot be cloned. In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned. NOTE: Mappings cannot be specified in the ‘_clone` request. The mappings of the source index will be used for the target index. **Monitor the cloning process** The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`. The `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated. At this point, all shards are in the state unassigned. If, for any reason, the target index can’t be allocated, its primary shard will remain unassigned until it can be allocated on that node. Once the primary shard is allocated, it moves to state initializing, and the clone process begins. When the clone operation completes, the shard will become active. At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node. **Wait for active shards** Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —

Name of the source index to clone. (Required)
:target (String) —

Name of the target index to create. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:wait_for_active_shards (Integer, String) —

The number of shard copies that must be active before proceeding with the operation. Set to ‘all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone

# File 'lib/elasticsearch/api/actions/indices/clone.rb', line 81

def clone(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.clone' }

  defined_params = [:index, :target].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  _target = arguments.delete(:target)

  method = Elasticsearch::API::HTTP_PUT
  path   = "#{Utils.listify(_index)}/_clone/#{Utils.listify(_target)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#close(arguments = {}) ⇒ `Object`

Close an index. A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behaviour can be turned off using the ‘ignore_unavailable=true` parameter. By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the`action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API. Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list or wildcard expression of index names used to limit the request. (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:wait_for_active_shards (Integer, String) —

The number of shard copies that must be active before proceeding with the operation. Set to ‘all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close

# File 'lib/elasticsearch/api/actions/indices/close.rb', line 68

def close(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.close' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.listify(_index)}/_close"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#create(arguments = {}) ⇒ `Object`

Create an index. You can use the create index API to add a new index to an Elasticsearch cluster. When creating an index, you can specify the following:

Settings for the index.
Mappings for fields in the index.
Index aliases

**Wait for active shards** By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out. The index creation response will indicate what happened. For example, ‘acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out. Note that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful. These values simply indicate whether the operation completed before the timeout. If `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon. If `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`). You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`. Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —
Name of the index you wish to create. Index names must meet the following criteria:
- Lowercase only
- Cannot include ‘`, `/`, `*`, `?`, `“`, `<`, `>`, `|`, ` `(space character),`,`, or`#`
- Indices prior to 7.0 could contain a colon (‘:`), but that has been deprecated and will not be supported in later versions
- Cannot start with ‘-`, `_`, or `+`
- Cannot be ‘.` or `..`
- Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)
- Names starting with ‘.` are deprecated, except for hidden indices and internal indices managed by plugins (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:wait_for_active_shards (Integer, String) —

The number of shard copies that must be active before proceeding with the operation. Set to ‘all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create

# File 'lib/elasticsearch/api/actions/indices/create.rb', line 73

def create(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.create' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_PUT
  path   = Utils.listify(_index).to_s
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#create_data_stream(arguments = {}) ⇒ `Object`

Create a data stream. You must have a matching index template with data stream enabled.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include ‘`, `/`, `*`, `?`, `“`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; Cannot start with `-`, `_`, `+`, or `.ds-`; Cannot be `.` or `..`; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream

# File 'lib/elasticsearch/api/actions/indices/create_data_stream.rb', line 51

def create_data_stream(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.create_data_stream' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_data_stream/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#create_from(arguments = {}) ⇒ `Object`

Create an index from a source index. Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:source (String) —

The source index or data stream name (Required)
:dest (String) —

The destination index or data stream name (Required)
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

create_from

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-from

# File 'lib/elasticsearch/api/actions/indices/create_from.rb', line 50

def create_from(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.create_from' }

  defined_params = [:source, :dest].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'source' missing" unless arguments[:source]
  raise ArgumentError, "Required argument 'dest' missing" unless arguments[:dest]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _source = arguments.delete(:source)

  _dest = arguments.delete(:dest)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_create_from/#{Utils.listify(_source)}/#{Utils.listify(_dest)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#data_streams_stats(arguments = {}) ⇒ `Object`

Get data stream stats. Get statistics for one or more data streams.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Comma-separated list of data streams used to limit the request. Wildcard expressions (‘*`) are supported. To target all data streams in a cluster, omit this parameter or use `*`.
:expand_wildcards (String, Array<String>) —

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1

# File 'lib/elasticsearch/api/actions/indices/data_streams_stats.rb', line 48

def data_streams_stats(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.data_streams_stats' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_data_stream/#{Utils.listify(_name)}/_stats"
           else
             '_data_stream/_stats'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#delete(arguments = {}) ⇒ `Object`

Delete indices. Deleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or dashboards. You cannot delete the current write index of a data stream. To delete the index, you must roll over the data stream so a new write index is created. You can then use the delete index API to delete the previous write index.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (‘*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete

# File 'lib/elasticsearch/api/actions/indices/delete.rb', line 61

def delete(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.delete' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_DELETE
  path   = Utils.listify(_index).to_s
  params = Utils.process_params(arguments)

  if Array(arguments[:ignore]).include?(404)
    Utils.rescue_from_not_found do
      Elasticsearch::API::Response.new(
        perform_request(method, path, params, body, headers, request_opts)
      )
    end
  else
    Elasticsearch::API::Response.new(
      perform_request(method, path, params, body, headers, request_opts)
    )
  end
end

#delete_alias(arguments = {}) ⇒ `Object`

Delete an alias. Removes a data stream or index from an alias.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams or indices used to limit the request. Supports wildcards (‘*`). (Required)
:name (String, Array<String>) —

Comma-separated list of aliases to remove. Supports wildcards (‘*`). To remove all aliases, use `*` or `_all`. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias

# File 'lib/elasticsearch/api/actions/indices/delete_alias.rb', line 51

def delete_alias(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_alias' }

  defined_params = [:index, :name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = ("#{Utils.listify(_index)}/_aliases/#{Utils.listify(_name)}" if _index && _name)
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#delete_data_lifecycle(arguments = {}) ⇒ `Object`

Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

A comma-separated list of data streams of which the data stream lifecycle will be deleted; use ‘*` to get all data streams (Required)
:expand_wildcards (String, Array<String>) —

Whether wildcard expressions should get expanded to open or closed indices (default: open)
:master_timeout (Time) —

Specify timeout for connection to master
:timeout (Time) —

Explicit timestamp for the document
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle

# File 'lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb', line 47

def delete_data_lifecycle(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_lifecycle' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_data_stream/#{Utils.listify(_name)}/_lifecycle"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#delete_data_stream(arguments = {}) ⇒ `Object`

Delete data streams. Deletes one or more data streams and their backing indices.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of data streams to delete. Wildcard (‘*`) expressions are supported. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:expand_wildcards (String, Array<String>) —

Type of data stream that wildcard patterns can match. Supports comma-separated values,such as ‘open,hidden`. Server default: open.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream

# File 'lib/elasticsearch/api/actions/indices/delete_data_stream.rb', line 46

def delete_data_stream(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_data_stream/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#delete_data_stream_options(arguments = {}) ⇒ `Object`

Delete data stream options. Removes the data stream options from a data stream.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

A comma-separated list of data streams of which the data stream options will be deleted; use ‘*` to get all data streams (Required)
:expand_wildcards (String, Array<String>) —

Whether wildcard expressions should get expanded to open or closed indices (default: open)
:master_timeout (Time) —

Specify timeout for connection to master
:timeout (Time) —

Explicit timestamp for the document
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options

# File 'lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb', line 47

def delete_data_stream_options(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream_options' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_data_stream/#{Utils.listify(_name)}/_options"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#delete_index_template(arguments = {}) ⇒ `Object`

Delete an index template. The provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template

# File 'lib/elasticsearch/api/actions/indices/delete_index_template.rb', line 48

def delete_index_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_index_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_index_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#delete_template(arguments = {}) ⇒ `Object`

Delete a legacy index template. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

The name of the legacy index template to delete. Wildcard (‘*`) expressions are supported. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template

# File 'lib/elasticsearch/api/actions/indices/delete_template.rb', line 49

def delete_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  if Array(arguments[:ignore]).include?(404)
    Utils.rescue_from_not_found do
      Elasticsearch::API::Response.new(
        perform_request(method, path, params, body, headers, request_opts)
      )
    end
  else
    Elasticsearch::API::Response.new(
      perform_request(method, path, params, body, headers, request_opts)
    )
  end
end

#disk_usage(arguments = {}) ⇒ `Object`

Analyze the index disk usage. Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index ‘store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. (Required)
:allow_no_indices (Boolean) —

If false, the request returns an error if any wildcard expression, index alias, or ‘_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:flush (Boolean) —

If ‘true`, the API performs a flush before analysis. If `false`, the response may not include uncommitted data. Server default: true.
:ignore_unavailable (Boolean) —

If ‘true`, missing or closed indices are not included in the response.
:run_expensive_tasks (Boolean) —

Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to ‘true`.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage

# File 'lib/elasticsearch/api/actions/indices/disk_usage.rb', line 65

def disk_usage(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.disk_usage' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.listify(_index)}/_disk_usage"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#downsample(arguments = {}) ⇒ `Object`

Downsample an index. Aggregate a time series (TSDS) index and store pre-computed statistical summaries (‘min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. All documents within an hour interval are summarized and stored as a single document in the downsample index. NOTE: Only indices in a time series data stream are supported. Neither field nor document level security can be defined on the source index. The source index must be read only (`index.blocks.write: true`). This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —

Name of the time series index to downsample. (Required)
:target_index (String) —

Name of the index to create. (Required)
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

config

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample

# File 'lib/elasticsearch/api/actions/indices/downsample.rb', line 55

def downsample(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.downsample' }

  defined_params = [:index, :target_index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'target_index' missing" unless arguments[:target_index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  _target_index = arguments.delete(:target_index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.listify(_index)}/_downsample/#{Utils.listify(_target_index)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#exists(arguments = {}) ⇒ `Object` Also known as: exists?

Check indices. Check if one or more indices, index aliases, or data streams exist.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases. Supports wildcards (‘*`). (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:flat_settings (Boolean) —

If ‘true`, returns settings in flat format.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:include_defaults (Boolean) —

If ‘true`, return all default settings in the response.
:local (Boolean) —

If ‘true`, the request retrieves information from the local node only.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists

# File 'lib/elasticsearch/api/actions/indices/exists.rb', line 53

def exists(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.exists' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_HEAD
  path   = Utils.listify(_index).to_s
  params = Utils.process_params(arguments)

  Utils.rescue_from_not_found do
    perform_request(method, path, params, body, headers, request_opts).status == 200
  end
end

#exists_alias(arguments = {}) ⇒ `Object` Also known as: exists_alias?

Check aliases. Check if one or more data stream or index aliases exist.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of aliases to check. Supports wildcards (‘*`). (Required)
:index (String, Array) —

Comma-separated list of data streams or indices used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, requests that include a missing data stream or index in the target indices or data streams return an error.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias

# File 'lib/elasticsearch/api/actions/indices/exists_alias.rb', line 54

def exists_alias(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_alias' }

  defined_params = [:name, :index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_HEAD
  path   = if _index && _name
             "#{Utils.listify(_index)}/_alias/#{Utils.listify(_name)}"
           else
             "_alias/#{Utils.listify(_name)}"
           end
  params = Utils.process_params(arguments)

  Utils.rescue_from_not_found do
    perform_request(method, path, params, body, headers, request_opts).status == 200
  end
end

#exists_index_template(arguments = {}) ⇒ `Object` Also known as: exists_index_template?

Check index templates. Check whether index templates exist.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. (Required)
:local (Boolean) —

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
:flat_settings (Boolean) —

If true, returns settings in flat format.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template

# File 'lib/elasticsearch/api/actions/indices/exists_index_template.rb', line 47

def exists_index_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_index_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_HEAD
  path   = "_index_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#exists_template(arguments = {}) ⇒ `Object` Also known as: exists_template?

Check existence of index templates. Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

A comma-separated list of index template names used to limit the request. Wildcard (‘*`) expressions are supported. (Required)
:flat_settings (Boolean) —

Indicates whether to use a flat format for the response.
:local (Boolean) —

Indicates whether to get information from the local node only.
:master_timeout (Time) —

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to ‘-1`. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template

# File 'lib/elasticsearch/api/actions/indices/exists_template.rb', line 52

def exists_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_HEAD
  path   = "_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Utils.rescue_from_not_found do
    perform_request(method, path, params, body, headers, request_opts).status == 200
  end
end

#explain_data_lifecycle(arguments = {}) ⇒ `Object`

Get the status for a data stream lifecycle. Get information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

The name of the index to explain (Required)
:include_defaults (Boolean) —

indicates if the API should return the default values the system uses for the index’s lifecycle
:master_timeout (Time) —

Specify timeout for connection to master
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle

# File 'lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb', line 46

def explain_data_lifecycle(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.explain_data_lifecycle' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "#{Utils.listify(_index)}/_lifecycle/explain"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#field_usage_stats(arguments = {}) ⇒ `Object`

Get field usage stats. Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list or wildcard expression of index names used to limit the request. (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`.
:ignore_unavailable (Boolean) —

If ‘true`, missing or closed indices are not included in the response.
:fields (String, Array<String>) —

Comma-separated list or wildcard expressions of fields to include in the statistics.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats

# File 'lib/elasticsearch/api/actions/indices/field_usage_stats.rb', line 60

def field_usage_stats(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.field_usage_stats' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "#{Utils.listify(_index)}/_field_usage_stats"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#flush(arguments = {}) ⇒ `Object`

Flush data streams or indices. Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (‘*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:force (Boolean) —

If ‘true`, the request forces a flush even if there are no changes to commit to the index. Server default: true.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:wait_if_ongoing (Boolean) —

If ‘true`, the flush operation blocks until execution when another flush operation is running. If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. Server default: true.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush

# File 'lib/elasticsearch/api/actions/indices/flush.rb', line 62

def flush(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.flush' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = if _index
             "#{Utils.listify(_index)}/_flush"
           else
             '_flush'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#forcemerge(arguments = {}) ⇒ `Object`

Force a merge. Perform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream’s backing indices. Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a “tombstone”. These soft-deleted documents are automatically cleaned up during regular segment merges. But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can’t be backed up incrementally. **Blocks during a force merge** Calls to this API block until the merge is complete (unless request contains ‘wait_for_completion=false`). If the client connection is lost before completion then the force merge process will continue in the background. Any new requests to force merge the same indices will also block until the ongoing force merge is complete. **Running force merge asynchronously** If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task. However, you can not cancel this task as the force merge task is not cancelable. Elasticsearch creates a record of this task as a document at `_tasks/<task_id>`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. **Force merging multiple indices** You can force merge multiple indices with a single request by targeting:

One or more data streams that contain multiple backing indices
Multiple indices
One or more aliases
All data streams and indices in a cluster

Each targeted shard is force-merged separately using the force_merge threadpool. By default each node only has a single ‘force_merge` thread which means that the shards on that node are force-merged one at a time. If you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel Force merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one. **Data streams and time-based indices** Force-merging is useful for managing a data stream’s older backing indices and other time-based indices, particularly after a rollover. In these cases, each index only receives indexing traffic for a certain period of time. Once an index receive no more writes, its shards can be force-merged to a single segment. This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches. For example:

“‘ POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1 “`

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

A comma-separated list of index names; use ‘_all` or empty string to perform the operation on all indices
:allow_no_indices (Boolean) —

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, Array<String>) —

Whether to expand wildcard expression to concrete indices that are open, closed or both.
:flush (Boolean) —

Specify whether the index should be flushed after performing the operation (default: true)
:ignore_unavailable (Boolean) —

Whether specified concrete indices should be ignored when unavailable (missing or closed)
:max_num_segments (Integer) —

The number of segments the index should be merged into (default: dynamic)
:only_expunge_deletes (Boolean) —

Specify whether the operation should only expunge deleted documents
:wait_for_completion (Boolean) —

Should the request wait until the force merge is completed.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge

# File 'lib/elasticsearch/api/actions/indices/forcemerge.rb', line 89

def forcemerge(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.forcemerge' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = if _index
             "#{Utils.listify(_index)}/_forcemerge"
           else
             '_forcemerge'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get(arguments = {}) ⇒ `Object`

Get index information. Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. (Required)
:allow_no_indices (Boolean) —

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Server default: open.
:flat_settings (Boolean) —

If true, returns settings in flat format.
:ignore_unavailable (Boolean) —

If false, requests that target a missing index return an error.
:include_defaults (Boolean) —

If true, return all default settings in the response.
:local (Boolean) —

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:features (String, Array<String>) —

Return only information on specified index features Server default: [‘aliases’, ‘mappings’, ‘settings’].
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get

# File 'lib/elasticsearch/api/actions/indices/get.rb', line 58

def get(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = Utils.listify(_index).to_s
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_alias(arguments = {}) ⇒ `Object`

Get aliases. Retrieves information for one or more data stream or index aliases.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of aliases to retrieve. Supports wildcards (‘*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
:index (String, Array) —

Comma-separated list of data streams or indices used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias

# File 'lib/elasticsearch/api/actions/indices/get_alias.rb', line 57

def get_alias(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_alias' }

  defined_params = [:name, :index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index && _name
             "#{Utils.listify(_index)}/_alias/#{Utils.listify(_name)}"
           elsif _index
             "#{Utils.listify(_index)}/_alias"
           elsif _name
             "_alias/#{Utils.listify(_name)}"
           else
             '_alias'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_data_lifecycle(arguments = {}) ⇒ `Object`

Get data stream lifecycles. Get the data stream lifecycle configuration of one or more data streams.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of data streams to limit the request. Supports wildcards (‘*`). To target all data streams, omit this parameter or use `*` or `_all`. (Required)
:expand_wildcards (String, Array<String>) —

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:include_defaults (Boolean) —

If ‘true`, return all default settings in the response.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle

# File 'lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb', line 50

def get_data_lifecycle(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_lifecycle' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = "_data_stream/#{Utils.listify(_name)}/_lifecycle"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_data_lifecycle_stats(arguments = {}) ⇒ `Object`

Get data stream lifecycle stats. Get statistics about the data streams that are managed by a data stream lifecycle.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats

# File 'lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb', line 43

def get_data_lifecycle_stats(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_lifecycle_stats' }

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_lifecycle/stats'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_data_stream(arguments = {}) ⇒ `Object`

Get data streams. Get information about one or more data streams.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of data stream names used to limit the request. Wildcard (‘*`) expressions are supported. If omitted, all data streams are returned.
:expand_wildcards (String, Array<String>) —

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:include_defaults (Boolean) —

If true, returns all relevant default configurations for the index template.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:verbose (Boolean) —

Whether the maximum timestamp for each data stream should be calculated and returned.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream

# File 'lib/elasticsearch/api/actions/indices/get_data_stream.rb', line 50

def get_data_stream(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_data_stream/#{Utils.listify(_name)}"
           else
             '_data_stream'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_data_stream_options(arguments = {}) ⇒ `Object`

Get data stream options. Get the data stream options configuration of one or more data streams.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of data streams to limit the request. Supports wildcards (‘*`). To target all data streams, omit this parameter or use `*` or `_all`. (Required)
:expand_wildcards (String, Array<String>) —

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-options

# File 'lib/elasticsearch/api/actions/indices/get_data_stream_options.rb', line 49

def get_data_stream_options(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_options' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = "_data_stream/#{Utils.listify(_name)}/_options"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_data_stream_settings(arguments = {}) ⇒ `Object`

Get data stream settings. Get setting information for one or more data streams.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array) —

A comma-separated list of data streams or data stream patterns. Supports wildcards (‘*`). (Required)
:master_timeout (Time) —

The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-settings

# File 'lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb', line 47

def get_data_stream_settings(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_settings' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = "_data_stream/#{Utils.listify(_name)}/_settings"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_field_mapping(arguments = {}) ⇒ `Object`

Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. This API is useful if you don’t need a complete mapping or if an index mapping contains a large number of fields.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:fields (String, Array<String>) —

Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (‘*`). (Required)
:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:include_defaults (Boolean) —

If ‘true`, return all default settings in the response.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping

# File 'lib/elasticsearch/api/actions/indices/get_field_mapping.rb', line 57

def get_field_mapping(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_field_mapping' }

  defined_params = [:fields, :index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'fields' missing" unless arguments[:fields]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _fields = arguments.delete(:fields)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index && _fields
             "#{Utils.listify(_index)}/_mapping/field/#{Utils.listify(_fields)}"
           else
             "_mapping/field/#{Utils.listify(_fields)}"
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_index_template(arguments = {}) ⇒ `Object`

Get index templates. Get information about one or more index templates.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.
:local (Boolean) —

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
:flat_settings (Boolean) —

If true, returns settings in flat format.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:include_defaults (Boolean) —

If true, returns all relevant default configurations for the index template.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template

# File 'lib/elasticsearch/api/actions/indices/get_index_template.rb', line 48

def get_index_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_index_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_index_template/#{Utils.listify(_name)}"
           else
             '_index_template'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_mapping(arguments = {}) ⇒ `Object`

Get mapping definitions. For data streams, the API retrieves mappings for the stream’s backing indices.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:local (Boolean) —

If ‘true`, the request retrieves information from the local node only.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping

# File 'lib/elasticsearch/api/actions/indices/get_mapping.rb', line 55

def get_mapping(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_mapping' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "#{Utils.listify(_index)}/_mapping"
           else
             '_mapping'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_migrate_reindex_status(arguments = {}) ⇒ `Object`

Get the migration reindexing status. Get the status of a migration reindex attempt for a data stream or index. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

The index or data stream name. (Required)
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration

# File 'lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb', line 48

def get_migrate_reindex_status(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_migrate_reindex_status' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "_migration/reindex/#{Utils.listify(_index)}/_status"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_settings(arguments = {}) ⇒ `Object`

Get index settings. Get setting information for one or more indices. For data streams, it returns setting information for the stream’s backing indices.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:name (String, Array<String>) —

Comma-separated list or wildcard expression of settings to retrieve.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:flat_settings (Boolean) —

If ‘true`, returns settings in flat format.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:include_defaults (Boolean) —

If ‘true`, return all default settings in the response.
:local (Boolean) —

If ‘true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings

# File 'lib/elasticsearch/api/actions/indices/get_settings.rb', line 64

def get_settings(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_settings' }

  defined_params = [:index, :name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index && _name
             "#{Utils.listify(_index)}/_settings/#{Utils.listify(_name)}"
           elsif _index
             "#{Utils.listify(_index)}/_settings"
           elsif _name
             "_settings/#{Utils.listify(_name)}"
           else
             '_settings'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#get_template(arguments = {}) ⇒ `Object`

Get legacy index templates. Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of index template names used to limit the request. Wildcard (‘*`) expressions are supported. To return all index templates, omit this parameter or use a value of `_all` or `*`.
:flat_settings (Boolean) —

If ‘true`, returns settings in flat format.
:local (Boolean) —

If ‘true`, the request retrieves information from the local node only.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template

# File 'lib/elasticsearch/api/actions/indices/get_template.rb', line 51

def get_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.get_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_template/#{Utils.listify(_name)}"
           else
             '_template'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#migrate_reindex(arguments = {}) ⇒ `Object`

Reindex legacy backing indices. Reindex all legacy backing indices for a data stream. This operation occurs in a persistent task. The persistent task ID is returned immediately and the reindexing work is completed in that task. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

reindex

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-reindex

# File 'lib/elasticsearch/api/actions/indices/migrate_reindex.rb', line 50

def migrate_reindex(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_reindex' }

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  method = Elasticsearch::API::HTTP_POST
  path   = '_migration/reindex'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#migrate_to_data_stream(arguments = {}) ⇒ `Object`

Convert an index alias to a data stream. Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a ‘@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Name of the index alias to convert to a data stream. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream

# File 'lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb', line 55

def migrate_to_data_stream(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_to_data_stream' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_POST
  path   = "_data_stream/_migrate/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#modify_data_stream(arguments = {}) ⇒ `Object`

Update data streams. Performs one or more data stream modification actions in a single atomic operation.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream

# File 'lib/elasticsearch/api/actions/indices/modify_data_stream.rb', line 44

def modify_data_stream(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.modify_data_stream' }

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  method = Elasticsearch::API::HTTP_POST
  path   = '_data_stream/_modify'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#open(arguments = {}) ⇒ `Object`

Open a closed index. For data streams, the API opens any closed backing indices. A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster. When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behavior can be turned off by using the ‘ignore_unavailable=true` parameter. By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API. Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. Because opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). By default, you must explicitly name the indices you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `elasticsearch.yml` file or using the cluster update settings API. (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:wait_for_active_shards (Integer, String) —

The number of shard copies that must be active before proceeding with the operation. Set to ‘all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open

# File 'lib/elasticsearch/api/actions/indices/open.rb', line 75

def open(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.open' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = "#{Utils.listify(_index)}/_open"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#promote_data_stream(arguments = {}) ⇒ `Object`

Promote a data stream. Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. These data streams can’t be rolled over in the local cluster. These replicated data streams roll over only if the upstream data stream rolls over. In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. If this is missing, the data stream will not be able to roll over until a matching index template is created. This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

The name of the data stream (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-promote-data-stream

# File 'lib/elasticsearch/api/actions/indices/promote_data_stream.rb', line 52

def promote_data_stream(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.promote_data_stream' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_POST
  path   = "_data_stream/_promote/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_alias(arguments = {}) ⇒ `Object`

Create or update an alias. Adds a data stream or index to an alias.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams or indices to add. Supports wildcards (‘*`). Wildcard patterns that match both data streams and indices return an error. (Required)
:name (String) —

Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias

# File 'lib/elasticsearch/api/actions/indices/put_alias.rb', line 54

def put_alias(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_alias' }

  defined_params = [:index, :name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = ("#{Utils.listify(_index)}/_aliases/#{Utils.listify(_name)}" if _index && _name)
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_data_lifecycle(arguments = {}) ⇒ `Object`

Update data stream lifecycles. Update the data stream lifecycle of the specified data streams.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of data streams used to limit the request. Supports wildcards (‘*`). To target all data streams use `*` or `_all`. (Required)
:expand_wildcards (String, Array<String>) —

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle

# File 'lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb', line 54

def put_data_lifecycle(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_lifecycle' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_data_stream/#{Utils.listify(_name)}/_lifecycle"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_data_stream_options(arguments = {}) ⇒ `Object`

Update data stream options. Update the data stream options of the specified data streams.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated list of data streams used to limit the request. Supports wildcards (‘*`). To target all data streams use `*` or `_all`. (Required)
:expand_wildcards (String, Array<String>) —

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options

# File 'lib/elasticsearch/api/actions/indices/put_data_stream_options.rb', line 54

def put_data_stream_options(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_options' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_data_stream/#{Utils.listify(_name)}/_options"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_data_stream_settings(arguments = {}) ⇒ `Object`

Update data stream settings. This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state, only certain settings are allowed. If possible, the setting change is applied to all backing indices. Otherwise, it will be applied when the data stream is next rolled over.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array) —

A comma-separated list of data streams or data stream patterns. (Required)
:dry_run (Boolean) —

If ‘true`, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.
:master_timeout (Time) —

The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

settings

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-settings

# File 'lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb', line 56

def put_data_stream_settings(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_settings' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_data_stream/#{Utils.listify(_name)}/_settings"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_index_template(arguments = {}) ⇒ `Object`

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation. For data streams, these settings and mappings are applied when the stream’s backing indices are created. Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. Changes to index templates do not affect existing indices, including the existing backing indices of a data stream. You can use C-style ‘/* */` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Multiple matching templates** If multiple index templates match the name of a new index or data stream, the template with the highest priority is used. Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities. **Composing aliases, mappings, and settings** When multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates. Any mappings, settings, or aliases from the parent index template are merged in next. Finally, any configuration on the index request itself is merged. Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. This recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`. If an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end. If an entry already exists with the same key, then it is overwritten by the new definition.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Index or template name (Required)
:create (Boolean) —

If ‘true`, this request cannot replace or update existing index templates.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:cause (String) —

User defined reason for creating/updating the index template
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template

# File 'lib/elasticsearch/api/actions/indices/put_index_template.rb', line 68

def put_index_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_index_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_index_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_mapping(arguments = {}) ⇒ `Object`

Update field mappings. Add new fields to an existing data stream or index. You can use the update mapping API to:

Add a new field to an existing index
Update mappings for multiple indices in a single request
Add new properties to an object field
Enable multi-fields for an existing field
Update supported mapping parameters
Change a field’s mapping using reindexing
Rename a field using a field alias

Learn how to use the update mapping API with practical examples in the Update mapping API examples guide.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

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. (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:write_index_only (Boolean) —

If ‘true`, the mappings are applied only to the current write index for the target.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping

# File 'lib/elasticsearch/api/actions/indices/put_mapping.rb', line 65

def put_mapping(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_mapping' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_PUT
  path   = "#{Utils.listify(_index)}/_mapping"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_settings(arguments = {}) ⇒ `Object`

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default. To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the ‘preserve_existing` parameter to `true`. For performance optimization during bulk indexing, you can disable the refresh interval. Refer to disable refresh interval for an example. There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:

“‘

"number_of_replicas": 1

“‘

Or you can use an ‘index` setting object:

“‘ {

"index": {
  "number_of_replicas": 1
}

} “‘

Or you can use dot annotation:

“‘

"index.number_of_replicas": 1

“‘

Or you can embed any of the aforementioned options in a ‘settings` object. For example:

“‘ {

"settings": {
  "index": {
    "number_of_replicas": 1
  }
}

} “‘

NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream’s write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream’s write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream’s backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. Refer to updating analyzers on existing indices for step-by-step examples.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:flat_settings (Boolean) —

If ‘true`, returns settings in flat format.
:ignore_unavailable (Boolean) —

If ‘true`, returns settings in flat format.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:preserve_existing (Boolean) —

If ‘true`, existing index settings remain unchanged.
:reopen (Boolean) —

Whether to close and reopen the index to apply non-dynamic settings. If set to ‘true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

settings

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings

# File 'lib/elasticsearch/api/actions/indices/put_settings.rb', line 120

def put_settings(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_settings' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_PUT
  path   = if _index
             "#{Utils.listify(_index)}/_settings"
           else
             '_settings'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#put_template(arguments = {}) ⇒ `Object`

Create or update a legacy index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order. Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. You can use C-style ‘/* */` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Indices matching multiple templates** Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

The name of the template (Required)
:create (Boolean) —

If true, this request cannot replace or update existing index templates.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:order (Integer) —

Order in which Elasticsearch applies this template if index matches multiple templates.Templates with lower ‘order’ values are merged first. Templates with higher ‘order’ values are merged later, overriding templates with lower values.
:cause (String) —

User defined reason for creating/updating the index template
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template

# File 'lib/elasticsearch/api/actions/indices/put_template.rb', line 65

def put_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#recovery(arguments = {}) ⇒ `Object`

Get index recovery information. Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices. All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. Recovery automatically occurs during the following processes:

When creating an index for the first time.
When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.
Creation of new replica shard copies from the primary.
Relocation of a shard copy to a different node in the same cluster.
A snapshot restore operation.
A clone, shrink, or split operation.

You can determine the cause of a shard recovery using the recovery or cat recovery APIs. The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:active_only (Boolean) —

If ‘true`, the response only includes ongoing shard recoveries.
:detailed (Boolean) —

If ‘true`, the response includes detailed information about shard recoveries.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery

# File 'lib/elasticsearch/api/actions/indices/recovery.rb', line 69

def recovery(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.recovery' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "#{Utils.listify(_index)}/_recovery"
           else
             '_recovery'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#refresh(arguments = {}) ⇒ `Object`

Refresh an index. A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices. By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval with the ‘index.refresh_interval` setting. Refresh requests are synchronous and do not return a response until the refresh operation completes. Refreshes are resource-intensive. To ensure good cluster performance, it’s recommended to wait for Elasticsearch’s periodic refresh rather than performing an explicit refresh when possible. If your application workflow indexes documents and then runs a search to retrieve the indexed document, it’s recommended to use the index API’s ‘refresh=wait_for` query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh

# File 'lib/elasticsearch/api/actions/indices/refresh.rb', line 60

def refresh(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.refresh' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_POST
  path   = if _index
             "#{Utils.listify(_index)}/_refresh"
           else
             '_refresh'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#reload_search_analyzers(arguments = {}) ⇒ `Object`

Reload search analyzers. Reload an index’s search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream’s backing indices. IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn’t contain responses derived from the previous versions of the analyzer. You can use the reload search analyzers API to pick up changes to synonym files used in the ‘synonym_graph` or `synonym` token filter of a search analyzer. To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers. NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster–including nodes that don’t contain a shard replica–before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

A comma-separated list of index names to reload analyzers for (Required)
:allow_no_indices (Boolean) —

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, Array<String>) —

Whether to expand wildcard expression to concrete indices that are open, closed or both.
:ignore_unavailable (Boolean) —

Whether specified concrete indices should be ignored when unavailable (missing or closed)
:resource (String) —

Changed resource to reload analyzers from if applicable
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers

# File 'lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb', line 57

def reload_search_analyzers(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.reload_search_analyzers' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "#{Utils.listify(_index)}/_reload_search_analyzers"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#remove_block(arguments = {}) ⇒ `Object`

Remove an index block. Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —

A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are removing blocks from. To allow the removal of blocks from indices with ‘_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. (Required)
:block (String) —

The block type to remove from the index. (Required)
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
:expand_wildcards (String, Array<String>) —

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:master_timeout (Time) —

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to ‘-1` to indicate that the request should never timeout. Server default: 30s.
:timeout (Time) —

The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to ‘-1` to indicate that the request should never timeout. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block

# File 'lib/elasticsearch/api/actions/indices/remove_block.rb', line 62

def remove_block(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.remove_block' }

  defined_params = [:index, :block].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'block' missing" unless arguments[:block]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  _block = arguments.delete(:block)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "#{Utils.listify(_index)}/_block/#{Utils.listify(_block)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#resolve_cluster(arguments = {}) ⇒ `Object`

Resolve the cluster. Resolve the specified index expressions to return information about each cluster, including the local “querying” cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster. This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint. For each cluster in the index expression, information is returned about:

Whether the querying (“local”) cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the ‘remote/info` endpoint.
Whether each remote cluster is configured with ‘skip_unavailable` as `true` or `false`.
Whether there are any indices, aliases, or data streams on that cluster that match the index expression.
Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).
Cluster version information, including the Elasticsearch server version.

For example, ‘GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`. Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.The ability to query without an index expression was added in version 8.18, so when querying remote clusters older than that, the local cluster will send the index expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference to that index expression even though you didn’t request it. If it causes a problem, you can instead include an index expression like ‘:` to bypass the issue.You may want to exclude a cluster or index from a search when:

A remote cluster is not currently connected and is configured with ‘skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.
A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is ‘logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the “error” field in the ‘_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)
A remote cluster is an older version that does not support the feature you want to use in your search.The ‘remote/info` endpoint is commonly used to test whether the “local” cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.

The remote cluster may be available, while the local cluster is not currently connected to it. You can use the ‘_resolve/cluster` API to attempt to reconnect to remote clusters. For example with `GET _resolve/cluster` or `GET _resolve/cluster/:`. The `connected` field in the response will indicate whether it was successful. If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ‘<cluster>`:`<name>` syntax. Index and cluster exclusions (e.g., `-cluster1:*`) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching
:allow_no_indices (Boolean) —

If false, the request returns an error if any wildcard expression, index alias, or ‘_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: open.
:ignore_throttled (Boolean) —

If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the ‘_resolve/cluster` API endpoint that takes no index expression.
:ignore_unavailable (Boolean) —

If false, the request returns an error if it targets a missing or closed index. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the ‘_resolve/cluster` API endpoint that takes no index expression.
:timeout (Time) —

The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out.The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds).
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster

# File 'lib/elasticsearch/api/actions/indices/resolve_cluster.rb', line 95

def resolve_cluster(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_cluster' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_resolve/cluster/#{Utils.listify(_name)}"
           else
             '_resolve/cluster'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#resolve_index(arguments = {}) ⇒ `Object`

Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String, Array<String>) —

Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ‘<cluster>`:`<name>` syntax. (Required)
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index

# File 'lib/elasticsearch/api/actions/indices/resolve_index.rb', line 53

def resolve_index(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_index' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = "_resolve/index/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#rollover(arguments = {}) ⇒ `Object`

Roll over to a new index. TIP: It is recommended to use the index lifecycle rollover action to automate rollovers. The rollover API creates a new index for a data stream or index alias. The API behavior depends on the rollover target. **Roll over a data stream** If you roll over a data stream, the API creates a new write index for the stream. The stream’s previous write index becomes a regular backing index. A rollover also increments the data stream’s generation. **Roll over an index alias with a write index** TIP: Prior to Elasticsearch 7.9, you’d typically use an index alias with a write index to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers. If an index alias points to multiple indices, one of the indices must be a write index. The rollover API creates a new write index for the alias with ‘is_write_index` set to `true`. The API also `sets is_write_index` to `false` for the previous write index. **Roll over an index alias with one index** If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias. NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting. **Increment index names for an alias** When you roll over an index alias, you can specify a name for the new index. If you don’t specify a name and the current index ends with ‘-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number. For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`. This number is always six characters and zero-padded, regardless of the previous index’s name. If you use an index alias for time series data, you can use date math in the index name to track the rollover date. For example, you can create an alias that points to an index named ‘<my-index-now/d-000001>`. If you create the index on May 6, 2099, the index’s name is ‘my-index-2099.05.06-000001`. If you roll over the alias on May 7, 2099, the new index’s name is ‘my-index-2099.05.07-000002`.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:alias (String) —

Name of the data stream or index alias to roll over. (Required)
:new_index (String) —

Name of the index to create. Supports date math. Data streams do not support this parameter.
:dry_run (Boolean) —

If ‘true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:wait_for_active_shards (Integer, String) —

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (‘number_of_replicas+1`). Server default: 1.
:lazy (Boolean) —

If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover

# File 'lib/elasticsearch/api/actions/indices/rollover.rb', line 81

def rollover(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.rollover' }

  defined_params = [:alias, :new_index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _alias = arguments.delete(:alias)

  _new_index = arguments.delete(:new_index)

  method = Elasticsearch::API::HTTP_POST
  path   = if _alias && _new_index
             "#{Utils.listify(_alias)}/_rollover/#{Utils.listify(_new_index)}"
           else
             "#{Utils.listify(_alias)}/_rollover"
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#segments(arguments = {}) ⇒ `Object`

Get index segments. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (‘*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments

# File 'lib/elasticsearch/api/actions/indices/segments.rb', line 53

def segments(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.segments' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "#{Utils.listify(_index)}/_segments"
           else
             '_segments'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#shard_stores(arguments = {}) ⇒ `Object`

Get index shard stores. Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices. The index shard stores API returns the following information:

The node on which each replica shard exists.
The allocation ID for each replica shard.
A unique ID for each replica shard.
Any errors encountered while opening the shard index or from an earlier failure.

By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

List of data streams, indices, and aliases used to limit the request.
:allow_no_indices (Boolean) —

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Server default: open.
:ignore_unavailable (Boolean) —

If true, missing or closed indices are not included in the response.
:status (String, Array<String>) —

List of shard health statuses used to limit the request.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores

# File 'lib/elasticsearch/api/actions/indices/shard_stores.rb', line 58

def shard_stores(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.shard_stores' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "#{Utils.listify(_index)}/_shard_stores"
           else
             '_shard_stores'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#shrink(arguments = {}) ⇒ `Object`

Shrink an index. Shrink an index into a new index with fewer primary shards. Before you can shrink an index:

The index must be read-only.
A copy of every shard in the index must reside on the same node.
The index must have a green health status.

To make shard allocation easier, we recommend you also remove the index’s replica shards. You can later re-add replica shards as part of the shrink operation. The requested number of primary shards in the target index must be a factor of the number of shards in the source index. For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. If the number of shards in the index is a prime number it can only be shrunk into a single primary shard

Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.

The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. A shrink operation:

Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.
Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.
Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the ‘.routing.allocation.initial_recovery._id` index setting.

IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:

The target index must not exist.
The source index must have more primary shards than the target index.
The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.
The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.
The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —

Name of the source index to shrink. (Required)
:target (String) —

Name of the target index to create. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:wait_for_active_shards (Integer, String) —

The number of shard copies that must be active before proceeding with the operation. Set to ‘all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink

# File 'lib/elasticsearch/api/actions/indices/shrink.rb', line 73

def shrink(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.shrink' }

  defined_params = [:index, :target].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  _target = arguments.delete(:target)

  method = Elasticsearch::API::HTTP_PUT
  path   = "#{Utils.listify(_index)}/_shrink/#{Utils.listify(_target)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#simulate_index_template(arguments = {}) ⇒ `Object`

Simulate an index. Get the index configuration that would be applied to the specified index from an existing index template.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Name of the index to simulate (Required)
:create (Boolean) —

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) —

User defined reason for dry-run creating the new template for simulation purposes Server default: false.
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:include_defaults (Boolean) —

If true, returns all relevant default configurations for the index template.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template

# File 'lib/elasticsearch/api/actions/indices/simulate_index_template.rb', line 48

def simulate_index_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_index_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_POST
  path   = "_index_template/_simulate_index/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#simulate_template(arguments = {}) ⇒ `Object`

Simulate an index template. Get the index configuration that would be applied by a particular index template.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (String) —

Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.
:create (Boolean) —

If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.
:cause (String) —

User defined reason for dry-run creating the new template for simulation purposes
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:include_defaults (Boolean) —

If true, returns all relevant default configurations for the index template.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template

# File 'lib/elasticsearch/api/actions/indices/simulate_template.rb', line 50

def simulate_template(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_template' }

  defined_params = [:name].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_POST
  path   = if _name
             "_index_template/_simulate/#{Utils.listify(_name)}"
           else
             '_index_template/_simulate'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#split(arguments = {}) ⇒ `Object`

Split an index. Split an index into a new index with more primary shards.

Before you can split an index:
The index must be read-only.
The cluster health status must be green.

You can do make an index read-only with the following request using the add index block API:

“‘ PUT /my_source_index/_block/write “`

The current write index on a data stream cannot be split. In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split. The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the ‘index.number_of_routing_shards` setting. The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. A split operation:

Creates a new target index with the same definition as the source index, but with a larger number of primary shards.
Hard-links segments from the source index into the target index. If the file system doesn’t support hard-linking, all segments are copied into the new index, which is a much more time consuming process.
Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.
Recovers the target index as though it were a closed index which had just been re-opened.

IMPORTANT: Indices can only be split if they satisfy the following requirements:

The target index must not exist.
The source index must have fewer primary shards than the target index.
The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.
The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String) —

Name of the source index to split. (Required)
:target (String) —

Name of the target index to create. (Required)
:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:wait_for_active_shards (Integer, String) —

The number of shard copies that must be active before proceeding with the operation. Set to ‘all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split

# File 'lib/elasticsearch/api/actions/indices/split.rb', line 76

def split(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.split' }

  defined_params = [:index, :target].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
  raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  _target = arguments.delete(:target)

  method = Elasticsearch::API::HTTP_PUT
  path   = "#{Utils.listify(_index)}/_split/#{Utils.listify(_target)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#stats(arguments = {}) ⇒ `Object`

Get index statistics. For data streams, the API retrieves statistics for the stream’s backing indices. By default, the returned statistics are index-level with ‘primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards. To get shard-level statistics, set the `level` parameter to `shards`. NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:metric (String, Array<String>) —

Limit the information returned the specific metrics.
:index (String, Array) —

A comma-separated list of index names; use ‘_all` or empty string to perform the operation on all indices
:completion_fields (String, Array<String>) —

Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`.
:fielddata_fields (String, Array<String>) —

Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
:fields (String, Array<String>) —

Comma-separated list or wildcard expressions of fields to include in the statistics.
:forbid_closed_indices (Boolean) —

If true, statistics are not collected from closed indices. Server default: true.
:groups (String, Array<String>) —

Comma-separated list of search groups to include in the search statistics.
:include_segment_file_sizes (Boolean) —

If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
:include_unloaded_segments (Boolean) —

If true, the response includes information from segments that are not loaded into memory.
:level (String) —

Indicates whether statistics are aggregated at the cluster, index, or shard level.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats

# File 'lib/elasticsearch/api/actions/indices/stats.rb', line 62

def stats(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.stats' }

  defined_params = [:metric, :index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _metric = arguments.delete(:metric)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index && _metric
             "#{Utils.listify(_index)}/_stats/#{Utils.listify(_metric)}"
           elsif _metric
             "_stats/#{Utils.listify(_metric)}"
           elsif _index
             "#{Utils.listify(_index)}/_stats"
           else
             '_stats'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#update_aliases(arguments = {}) ⇒ `Object`

Create or update an alias. Adds a data stream or index to an alias.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:master_timeout (Time) —

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases

# File 'lib/elasticsearch/api/actions/indices/update_aliases.rb', line 48

def update_aliases(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.update_aliases' }

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  method = Elasticsearch::API::HTTP_POST
  path   = '_aliases'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

#validate_query(arguments = {}) ⇒ `Object`

Validate a query. Validates a query without running it.

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (String, Array) —

Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (‘*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.
:allow_no_indices (Boolean) —

If ‘false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. Server default: true.
:all_shards (Boolean) —

If ‘true`, the validation is executed on all shards instead of one random shard per index.
:analyzer (String) —

Analyzer to use for the query string. This parameter can only be used when the ‘q` query string parameter is specified.
:analyze_wildcard (Boolean) —

If ‘true`, wildcard and prefix queries are analyzed.
:default_operator (String) —

The default operator for query string query: ‘AND` or `OR`. Server default: OR.
:df (String) —

Field to use as default where no field prefix is given in the query string. This parameter can only be used when the ‘q` query string parameter is specified.
:expand_wildcards (String, Array<String>) —

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as ‘open,hidden`. Server default: open.
:explain (Boolean) —

If ‘true`, the response returns detailed information if an error has occurred.
:ignore_unavailable (Boolean) —

If ‘false`, the request returns an error if it targets a missing or closed index.
:lenient (Boolean) —

If ‘true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
:rewrite (Boolean) —

If ‘true`, returns a more detailed explanation showing the actual Lucene query that will be executed.
:q (String) —

Query in the Lucene query string syntax.
:error_trace (Boolean) —

When set to ‘true` Elasticsearch will include the full stack trace of errors when they occur.
:filter_path (String, Array<String>) —

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
:human (Boolean) —

When set to ‘true` will return statistics in a format suitable for humans. For example `“exists_time”: “1h”` for humans and `“exists_time_in_millis”: 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
:pretty (Boolean) —

If set to ‘true` the returned JSON will be “pretty-formatted”. Only use this option for debugging only.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

See Also:

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query

# File 'lib/elasticsearch/api/actions/indices/validate_query.rb', line 64

def validate_query(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'indices.validate_query' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = if body
             Elasticsearch::API::HTTP_POST
           else
             Elasticsearch::API::HTTP_GET
           end

  path   = if _index
             "#{Utils.listify(_index)}/_validate/query"
           else
             '_validate/query'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end

Module: Elasticsearch::API::Indices::Actions

Instance Method Summary collapse

Instance Method Details

#add_block(arguments = {}) ⇒ Object

#analyze(arguments = {}) ⇒ Object

#cancel_migrate_reindex(arguments = {}) ⇒ Object

#clear_cache(arguments = {}) ⇒ Object

#clone(arguments = {}) ⇒ Object

#close(arguments = {}) ⇒ Object

#create(arguments = {}) ⇒ Object

#create_data_stream(arguments = {}) ⇒ Object

#create_from(arguments = {}) ⇒ Object

#data_streams_stats(arguments = {}) ⇒ Object

#delete(arguments = {}) ⇒ Object

#delete_alias(arguments = {}) ⇒ Object

#delete_data_lifecycle(arguments = {}) ⇒ Object

#delete_data_stream(arguments = {}) ⇒ Object

#delete_data_stream_options(arguments = {}) ⇒ Object

#delete_index_template(arguments = {}) ⇒ Object

#delete_template(arguments = {}) ⇒ Object

#disk_usage(arguments = {}) ⇒ Object

#downsample(arguments = {}) ⇒ Object

#exists(arguments = {}) ⇒ Object Also known as: exists?

#exists_alias(arguments = {}) ⇒ Object Also known as: exists_alias?

#exists_index_template(arguments = {}) ⇒ Object Also known as: exists_index_template?

#exists_template(arguments = {}) ⇒ Object Also known as: exists_template?

#explain_data_lifecycle(arguments = {}) ⇒ Object

#field_usage_stats(arguments = {}) ⇒ Object

#flush(arguments = {}) ⇒ Object

#forcemerge(arguments = {}) ⇒ Object

#get(arguments = {}) ⇒ Object

#get_alias(arguments = {}) ⇒ Object

#get_data_lifecycle(arguments = {}) ⇒ Object

#get_data_lifecycle_stats(arguments = {}) ⇒ Object

#get_data_stream(arguments = {}) ⇒ Object

#get_data_stream_options(arguments = {}) ⇒ Object

#get_data_stream_settings(arguments = {}) ⇒ Object

#get_field_mapping(arguments = {}) ⇒ Object

#get_index_template(arguments = {}) ⇒ Object

#get_mapping(arguments = {}) ⇒ Object

#get_migrate_reindex_status(arguments = {}) ⇒ Object

#get_settings(arguments = {}) ⇒ Object

#get_template(arguments = {}) ⇒ Object

#migrate_reindex(arguments = {}) ⇒ Object

#migrate_to_data_stream(arguments = {}) ⇒ Object

#modify_data_stream(arguments = {}) ⇒ Object

#open(arguments = {}) ⇒ Object

#promote_data_stream(arguments = {}) ⇒ Object

#put_alias(arguments = {}) ⇒ Object

#put_data_lifecycle(arguments = {}) ⇒ Object

#put_data_stream_options(arguments = {}) ⇒ Object

#put_data_stream_settings(arguments = {}) ⇒ Object

#put_index_template(arguments = {}) ⇒ Object

#put_mapping(arguments = {}) ⇒ Object

#put_settings(arguments = {}) ⇒ Object

#put_template(arguments = {}) ⇒ Object

#recovery(arguments = {}) ⇒ Object

#refresh(arguments = {}) ⇒ Object

#reload_search_analyzers(arguments = {}) ⇒ Object

#remove_block(arguments = {}) ⇒ Object

#resolve_cluster(arguments = {}) ⇒ Object

#resolve_index(arguments = {}) ⇒ Object

#rollover(arguments = {}) ⇒ Object

#segments(arguments = {}) ⇒ Object

#shard_stores(arguments = {}) ⇒ Object

#shrink(arguments = {}) ⇒ Object

#simulate_index_template(arguments = {}) ⇒ Object

#simulate_template(arguments = {}) ⇒ Object

#split(arguments = {}) ⇒ Object

#stats(arguments = {}) ⇒ Object

#update_aliases(arguments = {}) ⇒ Object

#validate_query(arguments = {}) ⇒ Object

#add_block(arguments = {}) ⇒ `Object`

#analyze(arguments = {}) ⇒ `Object`

#cancel_migrate_reindex(arguments = {}) ⇒ `Object`

#clear_cache(arguments = {}) ⇒ `Object`

#clone(arguments = {}) ⇒ `Object`

#close(arguments = {}) ⇒ `Object`

#create(arguments = {}) ⇒ `Object`

#create_data_stream(arguments = {}) ⇒ `Object`

#create_from(arguments = {}) ⇒ `Object`

#data_streams_stats(arguments = {}) ⇒ `Object`

#delete(arguments = {}) ⇒ `Object`

#delete_alias(arguments = {}) ⇒ `Object`

#delete_data_lifecycle(arguments = {}) ⇒ `Object`

#delete_data_stream(arguments = {}) ⇒ `Object`

#delete_data_stream_options(arguments = {}) ⇒ `Object`

#delete_index_template(arguments = {}) ⇒ `Object`

#delete_template(arguments = {}) ⇒ `Object`

#disk_usage(arguments = {}) ⇒ `Object`

#downsample(arguments = {}) ⇒ `Object`

#exists(arguments = {}) ⇒ `Object` Also known as: exists?

#exists_alias(arguments = {}) ⇒ `Object` Also known as: exists_alias?

#exists_index_template(arguments = {}) ⇒ `Object` Also known as: exists_index_template?

#exists_template(arguments = {}) ⇒ `Object` Also known as: exists_template?

#explain_data_lifecycle(arguments = {}) ⇒ `Object`

#field_usage_stats(arguments = {}) ⇒ `Object`

#flush(arguments = {}) ⇒ `Object`

#forcemerge(arguments = {}) ⇒ `Object`

#get(arguments = {}) ⇒ `Object`

#get_alias(arguments = {}) ⇒ `Object`

#get_data_lifecycle(arguments = {}) ⇒ `Object`

#get_data_lifecycle_stats(arguments = {}) ⇒ `Object`

#get_data_stream(arguments = {}) ⇒ `Object`

#get_data_stream_options(arguments = {}) ⇒ `Object`

#get_data_stream_settings(arguments = {}) ⇒ `Object`

#get_field_mapping(arguments = {}) ⇒ `Object`

#get_index_template(arguments = {}) ⇒ `Object`

#get_mapping(arguments = {}) ⇒ `Object`

#get_migrate_reindex_status(arguments = {}) ⇒ `Object`

#get_settings(arguments = {}) ⇒ `Object`

#get_template(arguments = {}) ⇒ `Object`

#migrate_reindex(arguments = {}) ⇒ `Object`

#migrate_to_data_stream(arguments = {}) ⇒ `Object`

#modify_data_stream(arguments = {}) ⇒ `Object`

#open(arguments = {}) ⇒ `Object`

#promote_data_stream(arguments = {}) ⇒ `Object`

#put_alias(arguments = {}) ⇒ `Object`

#put_data_lifecycle(arguments = {}) ⇒ `Object`

#put_data_stream_options(arguments = {}) ⇒ `Object`

#put_data_stream_settings(arguments = {}) ⇒ `Object`

#put_index_template(arguments = {}) ⇒ `Object`

#put_mapping(arguments = {}) ⇒ `Object`

#put_settings(arguments = {}) ⇒ `Object`

#put_template(arguments = {}) ⇒ `Object`

#recovery(arguments = {}) ⇒ `Object`

#refresh(arguments = {}) ⇒ `Object`

#reload_search_analyzers(arguments = {}) ⇒ `Object`

#remove_block(arguments = {}) ⇒ `Object`

#resolve_cluster(arguments = {}) ⇒ `Object`

#resolve_index(arguments = {}) ⇒ `Object`

#rollover(arguments = {}) ⇒ `Object`

#segments(arguments = {}) ⇒ `Object`

#shard_stores(arguments = {}) ⇒ `Object`

#shrink(arguments = {}) ⇒ `Object`

#simulate_index_template(arguments = {}) ⇒ `Object`

#simulate_template(arguments = {}) ⇒ `Object`

#split(arguments = {}) ⇒ `Object`

#stats(arguments = {}) ⇒ `Object`

#update_aliases(arguments = {}) ⇒ `Object`

#validate_query(arguments = {}) ⇒ `Object`