Sha256: 31bc9bebf0431a6bcfc4ce0ec27f72af5ca926fd24ceb2bfc09ccaa71c67d18a

Contents?: true

Size: 1.18 KB

Versions: 9

Compression:

Stored size: 1.18 KB

Contents

module Elasticsearch
  module API
    module Cluster
      module Actions

        # Get the cluster settings (previously set with {Cluster::Actions#put_settings})
        #
        # @example Get cluster settings
        #
        #     client.cluster.get_settings
        #
        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
        #                                               (default: false)
        #
        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
        #
        def get_settings(arguments={})
          valid_params = [
            :flat_settings,
            :include_defaults
          ]

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

          method = HTTP_GET
          path   = "_cluster/settings"
          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

9 entries across 9 versions & 1 rubygems

Version Path
elasticsearch-api-1.1.3 lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-2.0.2 lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-2.0.1 lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-1.1.2 lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-1.1.1 lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-2.0.0 lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-1.1.0 lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-2.0.0.pre lib/elasticsearch/api/actions/cluster/get_settings.rb
elasticsearch-api-1.1.pre lib/elasticsearch/api/actions/cluster/get_settings.rb