Sha256: a68b2e6354eae9ec863d818376241f6d8c469e28c7eb38c3a987ad1514f4c116

Contents?: true

Size: 1.84 KB

Versions: 11

Compression:

Stored size: 1.84 KB

Contents

module Elasticsearch
  module API
    module Cluster
      module Actions

        # Get information about the cluster state (indices settings, allocations, etc)
        #
        # @example
        #
        #     client.cluster.state
        #
        # @option arguments [Boolean] :filter_blocks Do not return information about blocks
        # @option arguments [Boolean] :filter_index_templates Do not return information about index templates
        # @option arguments [List] :filter_indices Limit returned metadata information to specific indices
        # @option arguments [Boolean] :filter_metadata Do not return information about indices metadata
        # @option arguments [Boolean] :filter_nodes Do not return information about nodes
        # @option arguments [Boolean] :filter_routing_table Do not return information about shard allocation
        #                                                   (`routing_table` and `routing_nodes`)
        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
        #                                    (default: false)
        # @option arguments [Time] :master_timeout Specify timeout for connection to master
        #
        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-state/
        #
        def state(arguments={})
          valid_params = [
            :filter_blocks,
            :filter_index_templates,
            :filter_indices,
            :filter_metadata,
            :filter_nodes,
            :filter_routing_table,
            :local,
            :master_timeout ]

          method = 'GET'
          path   = "_cluster/state"

          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

11 entries across 11 versions & 1 rubygems

Version Path
elasticsearch-api-0.4.11 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.10 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.9 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.8 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.7 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.6 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.5 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.4 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.3 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.2 lib/elasticsearch/api/actions/cluster/state.rb
elasticsearch-api-0.4.1 lib/elasticsearch/api/actions/cluster/state.rb