Class: UU::CloudRuntime::NodeImage

Inherits:
RuntimeBaseClass
  • Object
show all
Defined in:
lib/uu/cloud_runtime/node_image.rb

Overview

NodeImage class.

Defined Under Namespace

Classes: Status

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session = nil) ⇒ NodeImage

Creates a new instance of NodeImage.

Parameters:

  • session (UU::OS::Security::Session) (defaults to: nil) —

    Instance of session representing authenticated user (can be obtained with OS::Security::Session#current_session method).



33
34
35
 
# File 'lib/uu/cloud_runtime/node_image.rb', line 33

def initialize(session = nil)
  @client = UU::OS::CMD::CommandClient.new(PATH, session)
end

Class Method Details

.get_node_image_list(cloud_uri, parameters = {}) ⇒ Hash

Returns a paged list of NodeImages filterable by status.

Examples:

require 'uu_c3'
UU::OS::Security::Session.('...')
CLOUD_URI = UU::OS::UESURI.new("ues:OT-BT:PLUS4U_CLOUD")

list = UU::CloudRuntime::NodeImage.get_node_image_list(
  CLOUD_URI,
  :pageIndex => 0,
  :pageSize => 500,
  :status => UU::CloudRuntime::NodeImage::Status::UNUSED
)

puts list[:totalSize]
puts list[:criteria]
list[:pageEntries].each do |node_image|
  puts node_image #something...
end

Parameters:

  • cloud_uri (UU::OS::UESURI, String) —

    Cloud uri.

  • parameters (Hash) (defaults to: {}) —

    Filtering criteria.

Options Hash (parameters):

  • pageIndex (Fixnum) —

    Index of paged list.

  • pageSize (Fixnum) —

    Maximum records per paged list.

  • status (UU::CloudRuntime::NodeImage::Status, String) —

    Filter records by current status.

    • USED - NodeImage is being used by running Node of application, Gateway or RuntimeStack.

    • UNUSED - NodeImage is not being used by any application, Gateway or RuntimeStack.

Returns:

  • (Hash) —

    Structured hash.

See Also:



81
82
83
 
# File 'lib/uu/cloud_runtime/node_image.rb', line 81

def self.get_node_image_list(cloud_uri, parameters = {})
  self.new(UU::OS::Security::Session.current_session).get_node_image_list(cloud_uri, parameters)
end

Instance Method Details

#get_node_image_list(cloud_uri, parameters = {}) ⇒ Hash

Returns a paged list of NodeImages filterable by status.

Parameters:

  • cloud_uri (UU::OS::UESURI, String) —

    Cloud uri.

  • parameters (Hash) (defaults to: {}) —

    Filtering criteria.

Options Hash (parameters):

  • pageIndex (Fixnum) —

    Index of paged list.

  • pageSize (Fixnum) —

    Maximum records per paged list.

  • status (UU::CloudRuntime::NodeImage::Status, String) —

    Filter records by current status.

    • USED - NodeImage is being used by running Node of application, Gateway or RuntimeStack.

    • UNUSED - NodeImage is not being used by any application, Gateway or RuntimeStack.

Returns:

  • (Hash) —

    Structured hash.

See Also:



48
49
50
 
# File 'lib/uu/cloud_runtime/node_image.rb', line 48

def get_node_image_list(cloud_uri, parameters = {})
  @client.invoke(:getNodeImageList, cloud_uri, parameters: parameters)
end