Sha256: f895be0ca66aa2b5b8bb0ff1ce984cb241becbafdb24eef0796b2dba35d87963

Contents?: true

Size: 1.91 KB

Versions: 8

Compression:

Stored size: 1.91 KB

Contents

# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.

module OpenSearch
  module API
    module Cat
      module Actions
        # Returns information about the cluster_manager node.
        #
        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
        # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
        # @option arguments [List] :h Comma-separated list of column names to display
        # @option arguments [Boolean] :help Return help information
        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
        # @option arguments [Boolean] :v Verbose mode. Display column headers
        # @option arguments [Hash] :headers Custom HTTP headers
        #
        #
        def cluster_manager(arguments = {})
          headers = arguments.delete(:headers) || {}

          arguments = arguments.clone

          method = OpenSearch::API::HTTP_GET
          path   = '_cat/cluster_manager'
          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

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

        # Register this action with its valid params when the module is loaded.
        #
        # @since 6.2.0
        ParamsRegistry.register(:cluster_manager, %i[
          format
          local
          cluster_manager_timeout
          h
          help
          s
          v
        ].freeze)
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 2 rubygems

Version Path
opensearch-ruby-3.4.0 lib/opensearch/api/actions/cat/cluster_manager.rb
opensearch-ruby-3.3.0 lib/opensearch/api/actions/cat/cluster_manager.rb
opensearch-ruby-3.2.0 lib/opensearch/api/actions/cat/cluster_manager.rb
opensearch-ruby-3.1.0 lib/opensearch/api/actions/cat/cluster_manager.rb
opensearch-ruby-3.0.1 lib/opensearch/api/actions/cat/cluster_manager.rb
opensearch-ruby-3.0.0 lib/opensearch/api/actions/cat/cluster_manager.rb
opensearch-api-2.2.0 lib/opensearch/api/actions/cat/cluster_manager.rb
opensearch-api-2.1.0 lib/opensearch/api/actions/cat/cluster_manager.rb