Class: KatelloApi::Resources::Provider

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

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

Instance Method Details

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

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

  • organization_id (String) —

    organization identifier

  • provider (Hash) —

    allowed keys are:

    • description [String, nil] provider description
    • name [String] provider name
    • provider_type [String]
    • repository_url [String, nil] repository url

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



38
39
40
 
# File 'lib/katello_api/resources/provider.rb', line 38

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

- (Array) delete_manifest(params = {}, headers = {})

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

    provider numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



100
101
102
 
# File 'lib/katello_api/resources/provider.rb', line 100

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

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

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

    provider numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



61
62
63
 
# File 'lib/katello_api/resources/provider.rb', line 61

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

- (Array) discovery(params = {}, headers = {})

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/providers/:id/discovery path

  • url (String) —

    remote url to perform discovery

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



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

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

- (Array) import_manifest(params = {}, headers = {})

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

    provider numeric identifier

  • force (String) —

    force import

  • import (String) —

    manifest file

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



91
92
93
 
# File 'lib/katello_api/resources/provider.rb', line 91

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

- (Array) import_products(params = {}, headers = {})

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

    provider numeric identifier

  • products (String) —

    array of products to import

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



119
120
121
 
# File 'lib/katello_api/resources/provider.rb', line 119

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

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

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

  • organization_id (String) —

    organization identifier

  • name (String) —

    filter providers by name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



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

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

- (Array) product_create(params = {}, headers = {})

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

    provider numeric identifier

  • product (Hash) —

    allowed keys are:

    • description [String, nil] product description
    • gpg_key_name [String, nil] identifier of the gpg key
    • label [String]
    • name [String] product name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



134
135
136
 
# File 'lib/katello_api/resources/provider.rb', line 134

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

- (Array) products(params = {}, headers = {})

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

    provider numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



70
71
72
 
# File 'lib/katello_api/resources/provider.rb', line 70

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

- (Array) refresh_products(params = {}, headers = {})

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

    provider numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



109
110
111
 
# File 'lib/katello_api/resources/provider.rb', line 109

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

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

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

    provider numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



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

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

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

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

    provider numeric identifier

  • provider (Hash) —

    allowed keys are:

    • description [String, nil] provider description
    • name [String] provider name
    • repository_url [String, nil] repository url

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



52
53
54
 
# File 'lib/katello_api/resources/provider.rb', line 52

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