Sha256: 0878a26c2cbd1e80fa562c6d41d2b5e21a0b8c977a96f996e460096555fe80d9

Contents?: true

Size: 1.45 KB

Versions: 8

Compression:

Stored size: 1.45 KB

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 = '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

8 entries across 8 versions & 1 rubygems

Version Path
elasticsearch-api-1.0.6 lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.5 lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.4 lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.2 lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.1 lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.0 lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.0.rc2 lib/elasticsearch/api/actions/snapshot/get_repository.rb
elasticsearch-api-1.0.0.rc1 lib/elasticsearch/api/actions/snapshot/get_repository.rb