module Elasticsearch::API::Cluster::Actions::ParamsRegistry

Constants

PARAMS

A Mapping of all the actions to their list of valid params.

@since 6.1.1

Public Instance Methods

get(action) click to toggle source

Get the list of valid params for a given action.

@example Get the list of valid params.

ParamsRegistry.get(:benchmark)

@param [ Symbol ] action The action.

@return [ Array<Symbol> ] The list of valid params for the action.

@since 6.1.1

# File lib/elasticsearch/api/actions/cluster/params_registry.rb, line 53
def get(action)
  PARAMS.fetch(action, [])
end
register(action, valid_params) click to toggle source

Register an action with its list of valid params.

@example Register the action.

ParamsRegistry.register(:benchmark, [ :verbose ])

@param [ Symbol ] action The action to register. @param [ Array ] valid_params The list of valid params.

@since 6.1.1

# File lib/elasticsearch/api/actions/cluster/params_registry.rb, line 39
def register(action, valid_params)
  PARAMS[action.to_sym] = valid_params
end