Contents

module Elasticsearch
  module API
    module Snapshot
      module Actions

        # Get information about snapshot repositories or a specific repository
        #
        # @example Get all repositories
        #
        #     client.snapshot.get_repository
        #
        # @example Get a specific repository
        #
        #     client.snapshot.get_repository repository: 'my-backups'
        #
        # @option arguments [List] :repository A comma-separated list of repository names. Leave blank or use `_all`
        #                                      to get a list of repositories
        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
        #                                    (default: false)
        #
        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
        #
        def get_repository(arguments={})
          valid_params = [
            :master_timeout,
            :local ]

          repository = arguments.delete(:repository)

          method = HTTP_GET
          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )

          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

6 entries across 6 versions & 1 rubygems

Version	Path
elasticsearch-api-1.0.13	lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.12	lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.11	lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.10	lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.9	lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.7	lib/elasticsearch/api/actions/snapshot/get_repository.rb