Method: Elasticsearch::API::Indices::Actions#delete_alias

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

#delete_alias(arguments = {}) ⇒ Object

Deletes an alias.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :index (List) —

    A comma-separated list of index names (supports wildcards); use _all for all indices

  • :name (List) —

    A comma-separated list of aliases to delete (supports wildcards); use _all to delete all aliases for the specified indices.

  • :timeout (Time) —

    Explicit timestamp for the document

  • :master_timeout (Time) —

    Specify timeout for connection to master

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



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

def delete_alias(arguments = {})
  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   = if _index && _name
             "#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}"
           end
  params = Utils.process_params(arguments)

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