Class: KatelloApi::Resources::CustomInfo

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/custom_info.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config

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 KatelloApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/katello_api/resources/custom_info.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["custom_info"]
end

Instance Method Details

#create(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):

  • informable_id (String) —

    resource identifier

  • custom_info (Hash) —

    allowed keys are:

    • keyname [String]

    • value [String]

  • informable_type (String) —

    name of the resource

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



18
19
20
 
# File 'lib/katello_api/resources/custom_info.rb', line 18

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

#destroy(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):

  • informable_id (String) —

    resource identifier

  • informable_type (String) —

    name of the resource

  • keyname (String) —

    custom info key

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



64
65
66
 
# File 'lib/katello_api/resources/custom_info.rb', line 64

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

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

  • informable_id (String) —

    resource identifier

  • informable_type (String) —

    name of the resource

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



28
29
30
 
# File 'lib/katello_api/resources/custom_info.rb', line 28

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

  • informable_id (String) —

    resource identifier

  • informable_type (String) —

    name of the resource

  • keyname (String) —

    custom info key

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



39
40
41
 
# File 'lib/katello_api/resources/custom_info.rb', line 39

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

  • informable_id (String) —

    resource identifier

  • custom_info (Hash) —

    allowed keys are:

    • value [String]

  • informable_type (String) —

    name of the resource

  • keyname (String) —

    custom info key

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



53
54
55
 
# File 'lib/katello_api/resources/custom_info.rb', line 53

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