Sha256: be07c0acb2d4ba1b9a5b3a6fc4daf6fa6445fc4ca2dd77c3e4fe43e44cd2574c
Contents?: true
Size: 1.77 KB
Versions: 8
Compression:
Stored size: 1.77 KB
Contents
module Elasticsearch
module API
module Snapshot
module Actions
# Return information about specific (or all) snapshots
#
# @example Return information about the `snapshot-2` snapshot
#
# client.snapshot.get repository: 'my-backup', snapshot: 'snapshot-2'
#
# @example Return information about multiple snapshots
#
# client.snapshot.get repository: 'my-backup', snapshot: ['snapshot-2', 'snapshot-3']
#
# @example Return information about all snapshots in the repository
#
# client.snapshot.get repository: 'my-backup', snapshot: '_all'
#
# @option arguments [String] :repository A repository name (*Required*)
# @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
#
# @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
#
def get(arguments={})
raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
valid_params = [
:master_timeout ]
repository = arguments.delete(:repository)
snapshot = arguments.delete(:snapshot)
method = 'GET'
path = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
params = Utils.__validate_and_extract_params arguments, valid_params
body = nil
perform_request(method, path, params, body).body
end
end
end
end
end
Version data entries
8 entries across 8 versions & 1 rubygems