Method: Elasticsearch::API::Indices::Actions#simulate_index_template

Defined in:
lib/elasticsearch/api/actions/indices/simulate_index_template.rb

#simulate_index_template(arguments = {}) ⇒ Object

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

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :name (String) —

    The name of the index (it must be a concrete index name)

  • :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

  • :master_timeout (Time) —

    Specify timeout for connection to master

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    New index template definition, which will be included in the simulation, as if it already exists in the system

Raises:

  • (ArgumentError)

See Also:


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/elasticsearch/api/actions/indices/simulate_index_template.rb', line 36

def simulate_index_template(arguments = {})
  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_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)
  )
end