RubyDoc.info: Module: ElasticsearchServerless::API::Indices::Actions – Documentation for elasticsearch-serverless (0.7.0)

#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.
: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-serverless/api/indices/add_block.rb', line 51

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "#{Utils.listify(_index)}/_block/#{Utils.listify(_block)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
: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-serverless/api/indices/analyze.rb', line 40

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
             ElasticsearchServerless::API::HTTP_POST
           else
             ElasticsearchServerless::API::HTTP_GET
           end

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

  ElasticsearchServerless::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. (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.
: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-serverless/api/indices/create.rb', line 54

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = Utils.listify(_index).to_s
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
: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-serverless/api/indices/create_data_stream.rb', line 40

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_data_stream/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/delete.rb', line 51

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 = ElasticsearchServerless::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
      ElasticsearchServerless::API::Response.new(
        perform_request(method, path, params, body, headers, request_opts)
      )
    end
  else
    ElasticsearchServerless::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.
: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-serverless/api/indices/delete_alias.rb', line 40

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 = ElasticsearchServerless::API::HTTP_DELETE
  path   = ("#{Utils.listify(_index)}/_aliases/#{Utils.listify(_name)}" if _index && _name)
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
: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-serverless/api/indices/delete_data_stream.rb', line 35

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 = ElasticsearchServerless::API::HTTP_DELETE
  path   = "_data_stream/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
: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-serverless/api/indices/delete_index_template.rb', line 37

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 = ElasticsearchServerless::API::HTTP_DELETE
  path   = "_index_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/exists.rb', line 43

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 = ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
: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-serverless/api/indices/exists_alias.rb', line 44

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 = ElasticsearchServerless::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)
: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.
: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-serverless/api/indices/exists_index_template.rb', line 34

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 = ElasticsearchServerless::API::HTTP_HEAD
  path   = "_index_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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
: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-serverless/api/indices/explain_data_lifecycle.rb', line 35

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 = ElasticsearchServerless::API::HTTP_GET
  path   = "#{Utils.listify(_index)}/_lifecycle/explain"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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’].
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/get.rb', line 47

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 = ElasticsearchServerless::API::HTTP_GET
  path   = Utils.listify(_index).to_s
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
:headers (Hash) —

Custom HTTP headers

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/get_alias.rb', line 47

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 = ElasticsearchServerless::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)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
: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-serverless/api/indices/get_data_lifecycle.rb', line 40

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 = ElasticsearchServerless::API::HTTP_GET
  path   = "_data_stream/#{Utils.listify(_name)}/_lifecycle"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
:headers (Hash) —

Custom HTTP headers

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/get_data_stream.rb', line 39

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 = ElasticsearchServerless::API::HTTP_GET
  path   = if _name
             "_data_stream/#{Utils.listify(_name)}"
           else
             '_data_stream'
           end
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
:headers (Hash) —

Custom HTTP headers

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/get_index_template.rb', line 37

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 = ElasticsearchServerless::API::HTTP_GET
  path   = if _name
             "_index_template/#{Utils.listify(_name)}"
           else
             '_index_template'
           end
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
:headers (Hash) —

Custom HTTP headers

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/get_mapping.rb', line 45

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 = ElasticsearchServerless::API::HTTP_GET
  path   = if _index
             "#{Utils.listify(_index)}/_mapping"
           else
             '_mapping'
           end
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
:headers (Hash) —

Custom HTTP headers

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/get_settings.rb', line 53

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 = ElasticsearchServerless::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)

  ElasticsearchServerless::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.
: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-serverless/api/indices/migrate_to_data_stream.rb', line 44

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 = ElasticsearchServerless::API::HTTP_POST
  path   = "_data_stream/_migrate/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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):

: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-serverless/api/indices/modify_data_stream.rb', line 33

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 = ElasticsearchServerless::API::HTTP_POST
  path   = '_data_stream/_modify'
  params = {}

  ElasticsearchServerless::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.
: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-serverless/api/indices/put_alias.rb', line 43

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = ("#{Utils.listify(_index)}/_aliases/#{Utils.listify(_name)}" if _index && _name)
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, hidden, open, closed, none. 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.
: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-serverless/api/indices/put_data_lifecycle.rb', line 44

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_data_stream/#{Utils.listify(_name)}/_lifecycle"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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
: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-serverless/api/indices/put_index_template.rb', line 57

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "_index_template/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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 also use this API to change the search settings of existing fields and add new properties to existing object fields. For data streams, these changes are applied to all backing indices by default. **Add multi-fields to an existing field** Multi-fields let you index the same field in different ways. You can use this API to update the fields mapping parameter and enable multi-fields for an existing field. WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field. You can populate the new multi-field with the update by query API. **Change supported mapping parameters for an existing field** The documentation for each mapping parameter indicates whether you can update it for an existing field using this API. For example, you can use the update mapping API to update the ignore_above parameter. **Change the mapping of an existing field** Except for supported mapping parameters, you can’t change the mapping or field type of an existing field. Changing an existing field could invalidate data that’s already indexed. If you need to change the mapping of a field in a data stream’s backing indices, refer to documentation about modifying data streams. If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index. **Rename a field** Renaming a field would invalidate data already indexed under the old field name. Instead, add an alias field to create an alternate field name.

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. Valid values are: all, open, closed, hidden, none. 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.
: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-serverless/api/indices/put_mapping.rb', line 64

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = "#{Utils.listify(_index)}/_mapping"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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 module documentation. To preserve existing settings from being updated, set the preserve_existing parameter to true. 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.

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.
: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.
: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-serverless/api/indices/put_settings.rb', line 65

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 = ElasticsearchServerless::API::HTTP_PUT
  path   = if _index
             "#{Utils.listify(_index)}/_settings"
           else
             '_settings'
           end
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. Server default: open.
:ignore_unavailable (Boolean) —

If false, the request returns an error if it targets a missing or closed index.
:headers (Hash) —

Custom HTTP headers

See Also:

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

# File 'lib/elasticsearch-serverless/api/indices/refresh.rb', line 50

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 = ElasticsearchServerless::API::HTTP_POST
  path   = if _index
             "#{Utils.listify(_index)}/_refresh"
           else
             '_refresh'
           end
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
: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-serverless/api/indices/resolve_index.rb', line 43

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 = ElasticsearchServerless::API::HTTP_GET
  path   = "_resolve/index/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
: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-serverless/api/indices/rollover.rb', line 68

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 = ElasticsearchServerless::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)

  ElasticsearchServerless::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)
: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.
: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-serverless/api/indices/simulate_index_template.rb', line 35

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 = ElasticsearchServerless::API::HTTP_POST
  path   = "_index_template/_simulate_index/#{Utils.listify(_name)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
: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.
: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-serverless/api/indices/simulate_template.rb', line 38

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 = ElasticsearchServerless::API::HTTP_POST
  path   = if _name
             "_index_template/_simulate/#{Utils.listify(_name)}"
           else
             '_index_template/_simulate'
           end
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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.
: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-serverless/api/indices/update_aliases.rb', line 37

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 = ElasticsearchServerless::API::HTTP_POST
  path   = '_aliases'
  params = Utils.process_params(arguments)

  ElasticsearchServerless::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. Valid values are: all, open, closed, hidden, none. 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.
: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-serverless/api/indices/validate_query.rb', line 54

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
             ElasticsearchServerless::API::HTTP_POST
           else
             ElasticsearchServerless::API::HTTP_GET
           end

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

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

Module: ElasticsearchServerless::API::Indices::Actions

Instance Method Summary collapse

Instance Method Details

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

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

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

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

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

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

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

#delete_index_template(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?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Module: ElasticsearchServerless::API::Indices::Actions

Instance Method Summary collapse

Instance Method Details

#add_block(arguments = {}) ⇒ Object

#analyze(arguments = {}) ⇒ Object

#create(arguments = {}) ⇒ Object

#create_data_stream(arguments = {}) ⇒ Object

#delete(arguments = {}) ⇒ Object

#delete_alias(arguments = {}) ⇒ Object

#delete_data_stream(arguments = {}) ⇒ Object

#delete_index_template(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?

#explain_data_lifecycle(arguments = {}) ⇒ Object

#get(arguments = {}) ⇒ Object

#get_alias(arguments = {}) ⇒ Object

#get_data_lifecycle(arguments = {}) ⇒ Object

#get_data_stream(arguments = {}) ⇒ Object

#get_index_template(arguments = {}) ⇒ Object

#get_mapping(arguments = {}) ⇒ Object

#get_settings(arguments = {}) ⇒ Object

#migrate_to_data_stream(arguments = {}) ⇒ Object

#modify_data_stream(arguments = {}) ⇒ Object

#put_alias(arguments = {}) ⇒ Object

#put_data_lifecycle(arguments = {}) ⇒ Object

#put_index_template(arguments = {}) ⇒ Object

#put_mapping(arguments = {}) ⇒ Object

#put_settings(arguments = {}) ⇒ Object

#refresh(arguments = {}) ⇒ Object

#resolve_index(arguments = {}) ⇒ Object

#rollover(arguments = {}) ⇒ Object

#simulate_index_template(arguments = {}) ⇒ Object

#simulate_template(arguments = {}) ⇒ Object

#update_aliases(arguments = {}) ⇒ Object

#validate_query(arguments = {}) ⇒ Object

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

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

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

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

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

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

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

#delete_index_template(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?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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