Class: ForemanApi::Resources::SmartProxy

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc 



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

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

Instance Method Details

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

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],

    • url [String],



37
38
39
40
41
 
# File 'lib/foreman_api/resources/smart_proxy.rb', line 37

def create(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/smart_proxies", params
  call(:post", url, params, headers)
end

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

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) 


61
62
63
64
65
 
# File 'lib/foreman_api/resources/smart_proxy.rb', line 61

def destroy(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/smart_proxies/:id", params
  call(:delete", url, params, headers)
end

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

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



14
15
16
17
18
 
# File 'lib/foreman_api/resources/smart_proxy.rb', line 14

def index(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/smart_proxies", params
  call(:get", url, params, headers)
end

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

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) 


24
25
26
27
28
 
# File 'lib/foreman_api/resources/smart_proxy.rb', line 24

def show(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/smart_proxies/:id", params
  call(:get", url, params, headers)
end

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

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

    allowed keys are:

    • name [String],

    • url [String],



51
52
53
54
55
 
# File 'lib/foreman_api/resources/smart_proxy.rb', line 51

def update(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/smart_proxies/:id", params
  call(:put", url, params, headers)
end