Class: KatelloApi::Resources::Environment

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

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

  • organization_id (String) —

    organization identifier

  • environment (Hash) —

    allowed keys are:

    • description [String, nil]

    • name [String] name of the environment (identifier)

    • prior [String] identifier of an environment that is prior the new environment in the chain, it has to be either library or an environment at the end of the chain

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



50
51
52
 
# File 'lib/katello_api/resources/environment.rb', line 50

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

    environment identifier

  • organization_id (String) —

    organization identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



74
75
76
 
# File 'lib/katello_api/resources/environment.rb', line 74

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

  • library (String) —

    set true if you want to see only library environment

  • name (String) —

    filter only environments with this identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



15
16
17
 
# File 'lib/katello_api/resources/environment.rb', line 15

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

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

    environment identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



94
95
96
 
# File 'lib/katello_api/resources/environment.rb', line 94

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

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

    environment identifier

  • organization_id (String) —

    organization identifier

  • include_disabled (String) —

    set to true if you want to see also disabled repositories

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



85
86
87
 
# File 'lib/katello_api/resources/environment.rb', line 85

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

#rhsm_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

  • library (String) —

    set true if you want to see only library environment

  • name (String) —

    filter only environments with this identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



26
27
28
 
# File 'lib/katello_api/resources/environment.rb', line 26

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

    environment identifier

  • organization_id (String) —

    organization identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



36
37
38
 
# File 'lib/katello_api/resources/environment.rb', line 36

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

  • organization_id (Object) —

    Part of /api/organizations/:organization_id/environments/:id path

  • environment (Hash) —

    allowed keys are:

    • description [String, nil]

    • name [String] name of the environment (identifier)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



64
65
66
 
# File 'lib/katello_api/resources/environment.rb', line 64

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