Class: ForemanApi::Resources::SmartClassParameter

Inherits:
Base
  • Object
show all
Defined in:
lib/foreman_api/resources/smart_class_parameter.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config, #logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from ForemanApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/foreman_api/resources/smart_class_parameter.rb', line 4

def self.doc
  @doc ||= ForemanApi.doc['resources']["smart_class_parameters"]
end

Instance Method Details

#index(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • environment_id (String)
  • host_id (String)
  • hostgroup_id (String)
  • puppetclass_id (String)
  • order (String) —

    sort results

  • page (String) —

    paginate results

  • per_page (String) —

    number of entries per request

  • search (String) —

    filter results

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



20
21
22
 
# File 'lib/foreman_api/resources/smart_class_parameter.rb', line 20

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#show(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



29
30
31
 
# File 'lib/foreman_api/resources/smart_class_parameter.rb', line 29

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#update(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String)
  • smart_class_parameter (Hash) —

    allowed keys are:

    • default_value [String]

    • description [String]

    • override [String]

    • override_value_order [String]

    • parameter_type [String]

    • path [String]

    • required [String]

    • validator_rule [String]

    • validator_type [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



49
50
51
 
# File 'lib/foreman_api/resources/smart_class_parameter.rb', line 49

def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end