Class: KatelloApi::Resources::Template

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

Constant Summary

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

+ (Object) doc 



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

def self.doc
  @doc ||= KatelloApi.doc['resources']["templates"]
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):

  • environment_id (String) —

    environment numeric identifier

  • template (Hash) —

    allowed keys are:

    • parent_id [String, nil] parent template numeric identifier

    • description [String, nil] template description

    • name [String] new template name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



37
38
39
 
# File 'lib/katello_api/resources/template.rb', line 37

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

    template numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



60
61
62
 
# File 'lib/katello_api/resources/template.rb', line 60

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

- (Array) export(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) —

    template numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



93
94
95
 
# File 'lib/katello_api/resources/template.rb', line 93

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

- (Array) import(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):

  • environment_id (String) —

    environment numeric identifier

  • template (Hash) —

    allowed keys are:

    • parent_id [String, nil] parent template numeric identifier

    • description [String, nil] template description

    • name [String] new template name

  • template_file (String) —

    template file to import

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



75
76
77
 
# File 'lib/katello_api/resources/template.rb', line 75

def import(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):

  • environment_id (String) —

    environment numeric identifier

  • name (String) —

    system template identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



14
15
16
 
# File 'lib/katello_api/resources/template.rb', line 14

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

    system template numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



23
24
25
 
# File 'lib/katello_api/resources/template.rb', line 23

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 (String) —

    template numeric identifier

  • template (Hash) —

    allowed keys are:

    • parent_id [String, nil] parent template numeric identifier

    • description [String, nil] template description

    • name [String] new template name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



51
52
53
 
# File 'lib/katello_api/resources/template.rb', line 51

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

- (Array) validate(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) —

    template numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



84
85
86
 
# File 'lib/katello_api/resources/template.rb', line 84

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