Sha256: 01684f7d6ad723cfad07f591d1fb65b149cd844ec194d3649f8c7b757f766e3f

Contents?: true

Size: 1.68 KB

Versions: 12

Compression:

Stored size: 1.68 KB

Contents

module Elasticsearch
  module API
    module Indices
      module Actions

        # Retrieve information about one or more indices
        #
        # @option arguments [List] :index A comma-separated list of index names (*Required*)
        # @option arguments [List] :feature A comma-separated list of features
        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
        #                                    (default: false)
        # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
        # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete
        #                                               indices (default: false)
        # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded
        #                                            to open or closed indices (default: open)
        #
        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-index.html
        #
        def get(arguments={})
          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

          valid_params = [
            :local,
            :ignore_unavailable,
            :allow_no_indices,
            :expand_wildcards ]

          method = HTTP_GET

          path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__listify(arguments.delete(:feature))

          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

12 entries across 12 versions & 1 rubygems

Version Path
elasticsearch-api-1.0.17 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.16 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.16.pre2 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.16.pre lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.15 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.14 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.13 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.12 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.11 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.10 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.9 lib/elasticsearch/api/actions/indices/get.rb
elasticsearch-api-1.0.7 lib/elasticsearch/api/actions/indices/get.rb