Class: KatelloApi::Resources::SmartProxy

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/smart_proxy.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/smart_proxy.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["smart_proxies"]
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_proxy (Hash, nil)

    allowed keys are:

    • name [String]

    • url [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



49
50
51
# File 'lib/katello_api/resources/smart_proxy.rb', line 49

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)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



71
72
73
# File 'lib/katello_api/resources/smart_proxy.rb', line 71

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

- (Array) import_puppetclasses(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)
  • environment_id (String)
  • smart_proxy_id (String)
  • dryrun (String)
  • except (String)

    optional comma-deliminated string containing either ‘new,updated,obsolete’ used to limit the import_puppetclasses actions

Returns:

  • (Array)

    First item: parsed data; second item: raw body



17
18
19
# File 'lib/katello_api/resources/smart_proxy.rb', line 17

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

  • page (String)

    paginate results

  • per_page (String)

    number of entries per request

  • type (String)

    filter by type

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) refresh(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)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



80
81
82
# File 'lib/katello_api/resources/smart_proxy.rb', line 80

def refresh(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)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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)
  • smart_proxy (Hash, nil)

    allowed keys are:

    • name [String]

    • url [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



62
63
64
# File 'lib/katello_api/resources/smart_proxy.rb', line 62

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