Sha256: 2a2fc6d78ef6b7a4bf143630d007ab931b53c9cbad413305f70c920ed3d33890
Contents?: true
Size: 1.58 KB
Versions: 31
Compression:
Stored size: 1.58 KB
Contents
module Elasticsearch
module API
module Indices
module Actions
# Create or update a single index alias.
#
# @example Create an alias for current month
#
# client.indices.put_alias index: 'logs-2013-06', name: 'current-month'
#
# @example Create an alias for multiple indices
#
# client.indices.put_alias index: 'logs-2013-06', name: 'year-2013'
# client.indices.put_alias index: 'logs-2013-05', name: 'year-2013'
#
# See the {Indices::Actions#update_aliases} for performing operations with index aliases in bulk.
#
# @option arguments [String] :index The name of the index with an alias
# @option arguments [String] :name The name of the alias to be created or updated
# @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
# @option arguments [Time] :timeout Explicit timestamp for the document
#
# @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
#
def put_alias(arguments={})
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
valid_params = [ :timeout ]
method = HTTP_PUT
path = Utils.__pathify Utils.__listify(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
params = Utils.__validate_and_extract_params arguments, valid_params
body = arguments[:body]
perform_request(method, path, params, body).body
end
end
end
end
end
Version data entries
31 entries across 31 versions & 2 rubygems