Class: KatelloApi::Resources::SmartProxy

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

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

  • smart_proxy (Hash) —

    allowed keys are:

    • name [String] the smart proxy name

    • url [String] the smart proxy url starting with ‘http://’ or ‘https://’

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



35
36
37
 
# File 'lib/katello_api/resources/smart_proxy.rb', line 35

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

  • id (String) —

    domain name (no slashes)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



57
58
59
 
# File 'lib/katello_api/resources/smart_proxy.rb', line 57

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

  • order (String) —

    sort results

  • search (String) —

    filter results

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

    domain name (no slashes)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

    Part of /api/smart_proxies/:id path

  • smart_proxy (Hash) —

    allowed keys are:

    • name [String] the smart proxy name

    • url [String] the smart proxy url starting with ‘http://’ or ‘https://’

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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