Method: OpenSearch::API::Cluster::Actions#get_settings

Defined in:
lib/opensearch/api/actions/cluster/get_settings.rb

#get_settings(arguments = {}) ⇒ Object

Returns cluster settings.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :flat_settings (Boolean) —

    Return settings in flat format (default: false)

  • :master_timeout (Time) —

    Explicit operation timeout for connection to master node

  • :timeout (Time) —

    Explicit operation timeout

  • :include_defaults (Boolean) —

    Whether to return all default clusters setting.

  • :headers (Hash) —

    Custom HTTP headers



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/opensearch/api/actions/cluster/get_settings.rb', line 40

def get_settings(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = OpenSearch::API::HTTP_GET
  path   = "_cluster/settings"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end