Class: ForemanApi::Resources::OverrideValue

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



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

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

Instance Method Details

- (Array) create(params = {}, headers = {})

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):

  • smart_class_parameter_id (Object)

    Part of /api/smart_class_parameters/:smart_class_parameter_id/override_values path

  • smart_variable_id (String)
  • override_value (Hash, nil)

    allowed keys are:

    • match [String, nil]

    • value [String, nil]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



41
42
43
# File 'lib/foreman_api/resources/override_value.rb', line 41

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

- (Array) destroy(params = {}, headers = {})

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_id (Object)

    Part of /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id path

  • smart_variable_id (Object)

    Part of /api/smart_variables/:smart_variable_id/override_values/:id path

Returns:

  • (Array)

    First item: parsed data; second item: raw body



67
68
69
# File 'lib/foreman_api/resources/override_value.rb', line 67

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

- (Array) index(params = {}, headers = {})

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):

  • smart_class_parameter_id (String)
  • smart_variable_id (String)
  • page (String)

    paginate results

  • per_page (String)

    number of entries per request

Returns:

  • (Array)

    First item: parsed data; second item: raw body



16
17
18
# File 'lib/foreman_api/resources/override_value.rb', line 16

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

- (Array) show(params = {}, headers = {})

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_id (String)
  • smart_variable_id (String)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



27
28
29
# File 'lib/foreman_api/resources/override_value.rb', line 27

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

- (Array) update(params = {}, headers = {})

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 (Object)

    Part of /api/smart_variables/:smart_variable_id/override_values/:id path

  • smart_class_parameter_id (Object)

    Part of /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id path

  • smart_variable_id (Object)

    Part of /api/smart_variables/:smart_variable_id/override_values/:id path

  • override_value (Hash, nil)

    allowed keys are:

    • match [String, nil]

    • value [String, nil]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



56
57
58
# File 'lib/foreman_api/resources/override_value.rb', line 56

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