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

    name of organization

  • description (String) —

    description of the environment

  • name (String) —

    name of the environment

  • prior (String) —

    name of an environment that is prior to the new environment in the chain. it has to be either ‘library’ or an environment at the end of a chain.

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



39
40
41
 
# File 'lib/katello_api/resources/environment.rb', line 39

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

    id of the environment

  • organization_id (String) —

    organization identifier

  • name (String) —

    name of the environment

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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 environments

  • name (String) —

    filter only environments containing this name

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

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

    Part of /api/organization/:organization_id/environments/paths path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

def paths(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) —

    id of the environment

  • environment_id (Object) —

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

  • organization_id (String) —

    id of the organization

  • name (String) —

    name of the environment

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

    id of the environment

  • organization_id (String) —

    name of the organization

  • description (String) —

    description of the environment

  • name (String) —

    name of the environment

  • new_name (String) —

    new name to be given to the environment

  • prior (String) —

    name of an environment that is prior to the new environment in the chain. it has to be either ‘library’ or an environment at the end of a chain.

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



53
54
55
 
# File 'lib/katello_api/resources/environment.rb', line 53

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