Contents

module Elasticsearch
  module API
    module Cat
      module Actions

        # Shows all snapshots that belong to a specific repository
        #
        # @example Return snapshots for 'my_repository'
        #
        #     client.cat.snapshots repository: 'my_repository'
        #
        # @example Return id, status and start_epoch for 'my_repository'
        #
        #     client.cat.snapshots repository: 'my_repository', h: 'id,status,start_epoch'
        #
        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
        # @option arguments [List] :h Comma-separated list of column names to display
        # @option arguments [Boolean] :help Return help information
        # @option arguments [Boolean] :v Verbose mode. Display column headers
        #
        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html
        #
        def snapshots(arguments={})
          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

          valid_params = [
            :master_timeout,
            :h,
            :help,
            :v ]

          unsupported_params = [ :format ]
          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)

          repository = arguments.delete(:repository)

          method = HTTP_GET
          path   = Utils.__pathify "_cat/snapshots", 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

4 entries across 4 versions & 1 rubygems

Version	Path
elasticsearch-api-2.0.2	lib/elasticsearch/api/actions/cat/snapshots.rb
elasticsearch-api-2.0.1	lib/elasticsearch/api/actions/cat/snapshots.rb
elasticsearch-api-2.0.0	lib/elasticsearch/api/actions/cat/snapshots.rb
elasticsearch-api-2.0.0.pre	lib/elasticsearch/api/actions/cat/snapshots.rb