Sha256: d937744c02fc2d700aa6bbdb76f5afa38402a322aa6472e0d6c06f2069fab965

Contents?: true

Size: 853 Bytes

Versions: 12

Compression:

Stored size: 853 Bytes

Contents

module Elasticsearch
  module API
    module Actions

      # Abort a particular scroll search and clear all the resources associated with it.
      #
      # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear;
      #                                     use `_all` clear all scroll search contexts
      #
      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-search-type.html#clear-scroll
      #
      def clear_scroll(arguments={})
        raise ArgumentError, "Required argument 'scroll_id' missing" unless arguments[:scroll_id]

        method = 'DELETE'
        path   = Utils.__pathify '_search/scroll', Utils.__listify(arguments[:scroll_id])
        params = {}
        body   = nil

        perform_request(method, path, params, body).body
      end
    end
  end
end

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
elasticsearch-api-1.0.6 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.5 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.4 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.2 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.1 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.0 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-0.4.11 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-0.4.10 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-0.4.9 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.0.rc2 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.0.rc1 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-0.4.8 lib/elasticsearch/api/actions/clear_scroll.rb