Class: KatelloApi::Resources::GpgKey

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

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

Instance Method Details

#content(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) —

    gpg key numeric identifier

  • content (String) —

    file contents

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

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

  • organization_id (String) —

    organization identifier

  • content (String) —

    public key block in der encoding

  • name (String) —

    identifier of the gpg key

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



32
33
34
 
# File 'lib/katello_api/resources/gpg_key.rb', line 32

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

    gpg key numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

  • organization_id (String) —

    organization identifier

  • order (String) —

    sort field and order, eg. ‘name desc’

  • page (String) —

    page number, starting at 1

  • per_page (String) —

    number of results per page to return

  • search (String) —

    search string

  • sort (Hash) —

    hash version of ‘order’ param allowed keys are:

    • by [String] field to sort the results on

    • order [String] how to order the sorted results (e.g. asc for ascending)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



21
22
23
 
# File 'lib/katello_api/resources/gpg_key.rb', line 21

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

    gpg key numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



41
42
43
 
# File 'lib/katello_api/resources/gpg_key.rb', line 41

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

    gpg key numeric identifier

  • content (String) —

    public key block in der encoding

  • name (String) —

    identifier of the gpg key

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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