Class: UU::OperationRegistry::NodeImage

Inherits:
BaseMethods
  • Object
show all
Defined in:
lib/uu/operation_registry/node_image.rb

Overview

Node image.

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

    Session to use for remote calls.



18
19
20
 
# File 'lib/uu/operation_registry/node_image.rb', line 18

def initialize(session = nil)
  super
end

Class Method Details

.create(cloud_uri, attributes) ⇒ UU::OS::UESURI

Creates a new node image. This method is a convenience shortcut for the #create instance method.

Parameters:

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

    Cloud URI.

  • attributes (Hash) —

    Node image attributes.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the created node image.




# File 'lib/uu/operation_registry/node_image.rb', line 40

.delete(node_image_uri) ⇒ void

This method returns an undefined value.

Deletes the specified node image from the registry. This method is a convenience shortcut for the #delete instance method.

Parameters:

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

    Node image URI.




# File 'lib/uu/operation_registry/node_image.rb', line 83

.get_attributes(node_image_uri) ⇒ Hash

Gets the attributes of the node image specified by node image URI and returns its detail. This method is a convenience shortcut for the #get_attributes instance method.

Parameters:

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

    Node image URI.

Returns:

  • (Hash) —

    Node image attributes.




# File 'lib/uu/operation_registry/node_image.rb', line 53

.get_node_image_list(cloud_uri, criteria = {}) ⇒ UU::OS::Persistence::PagedResult<Hash>

Returns list of node images. This method is a convenience shortcut for the #get_node_image_list instance method.

Returns:

  • (UU::OS::Persistence::PagedResult<Hash>) —

    Paged result set.

See Also:



111
112
113
 
# File 'lib/uu/operation_registry/node_image.rb', line 111

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

.set_attributes(node_image_uri, attributes) ⇒ UU::OS::UESURI

Sets attributes of a node image. This method is a convenience shortcut for the #set_attributes instance method.

Parameters:

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

    Node image URI.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the updated node image.




# File 'lib/uu/operation_registry/node_image.rb', line 72

Instance Method Details

#create(cloud_uri, attributes) ⇒ UU::OS::UESURI

Creates a new node image.

Parameters:

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

    Cloud URI.

  • attributes (Hash) —

    Node image attributes.

Options Hash (attributes):

  • name (String) —

    Node image name.

  • code (String) —

    Node image code. May be nil.

  • description (String) —

    Node image description. May be nil.

  • nodeSizeUri (UU::OS::UESURI) —

    Base class URI. May be nil.

  • inboundPorts (Array<Fixnum>) —

    Inbound ports. May be nil.

  • imageUrl (String) —

    Physical location of the actual node image. May be nil.

  • runtimeStackUri (UU:OS::UESURI) —

    Runtime stack URI. May be nil.

  • appDeploymentUri (UU::OS::UESURI) —

    UESURI of deployment that this node image belongs to. May be nil.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the created node image.




# File 'lib/uu/operation_registry/node_image.rb', line 22

#delete(node_image_uri) ⇒ void

This method returns an undefined value.

Deletes the specified node image from the registry.

Parameters:

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

    Node image URI.




# File 'lib/uu/operation_registry/node_image.rb', line 78

#get_attributes(node_image_uri) ⇒ Hash

Gets the attributes of the node image specified by node image URI and returns its detail.

Parameters:

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

    Node image URI.

Returns:

  • (Hash) —

    Node image attributes.




# File 'lib/uu/operation_registry/node_image.rb', line 47

#get_node_image_list(cloud_uri, criteria = {}) ⇒ UU::OS::Persistence::PagedResult<Hash>

Returns a list of node images in the given cloud. Command does not return all node images, only a sublist. The list of returned node images could be filtered using Mongo Query.

Parameters:

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

    Cloud URI.

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

    Criteria for listing node images.

Options Hash (criteria):

  • query (String) —

    Mongo Query to filter the result set. See Mongo Query tutorial. Allowed query filter document fields: name, code, cloudUri

  • pageIndex (Fixnum) —

    Result set page index.

  • pageSize (Fixnum) —

    Result set page size.

Returns:

  • (UU::OS::Persistence::PagedResult<Hash>) —

    Paged result set.



102
103
104
 
# File 'lib/uu/operation_registry/node_image.rb', line 102

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

#set_attributes(node_image_uri, attributes) ⇒ UU::OS::UESURI

Sets attributes of a node image.

Parameters:

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

    Node image URI.

  • attributes (Hash) —

    Node image attributes.

Options Hash (attributes):

  • name (String) —

    Node image name. May be nil.

  • code (String) —

    Node image code. May be nil.

  • description (String) —

    Node image description. May be nil.

  • appDeploymentUri (UU::OS::UESURI) —

    UESURI of deployment that this node image belongs to. May be nil.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the updated node image.




# File 'lib/uu/operation_registry/node_image.rb', line 60