Class: UU::OperationRegistry::Cloud

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

Overview

Cloud.

Constant Summary

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Cloud) initialize(session = nil)

Creates a new instance of Cloud.

Parameters:

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

    Session to use for remote calls.



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

def initialize(session = nil)
  super
end

Class Method Details

+ (UU::OS::Persistence::PagedResult<Hash>) get_container_list(cloud_uri, criteria = {})

Returns list of containers. This method is a convenience shortcut for the #get_container_list instance method.

Returns:

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

    Paged result set.

See Also:



43
44
45
# File 'lib/uu/operation_registry/cloud.rb', line 43

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

+ (UU::OS::Persistence::PagedResult<Hash>) get_host_list(cloud_uri, criteria = {})

Returns list of hosts. This method is a convenience shortcut for the #get_host_list instance method.

Returns:

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

    Paged result set.

See Also:



93
94
95
# File 'lib/uu/operation_registry/cloud.rb', line 93

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

+ (UU::OS::Persistence::PagedResult<Hash>) get_node_list(cloud_uri, criteria = {})

Returns list of nodes. This method is a convenience shortcut for the #get_node_list instance method.

Returns:

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

    Paged result set.

See Also:



118
119
120
# File 'lib/uu/operation_registry/cloud.rb', line 118

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

+ (UU::OS::Persistence::PagedResult<Hash>) get_resource_group_list(cloud_uri, criteria = {})

Returns list of resource groups. This method is a convenience shortcut for the #get_resource_group_list instance method.

Returns:

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

    Paged result set.

See Also:



68
69
70
# File 'lib/uu/operation_registry/cloud.rb', line 68

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

Instance Method Details

- (UU::OS::Persistence::PagedResult<Hash>) get_container_list(cloud_uri, criteria = {})

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

Parameters:

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

    Cloud URI.

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

    Criteria for listing containers.

Options Hash (criteria):

  • query (String)

    Mongo Query to filter the result set. See Mongo Query tutorial.

  • pageIndex (Fixnum)

    Result set page index.

  • pageSize (Fixnum)

    Result set page size.

Returns:

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

    Paged result set.



34
35
36
# File 'lib/uu/operation_registry/cloud.rb', line 34

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

- (UU::OS::Persistence::PagedResult<Hash>) get_host_list(cloud_uri, criteria = {})

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

Parameters:

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

    Cloud URI.

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

    Criteria for listing hosts.

Options Hash (criteria):

  • query (String)

    Mongo Query to filter the result set. See Mongo Query tutorial.

  • pageIndex (Fixnum)

    Result set page index.

  • pageSize (Fixnum)

    Result set page size.

Returns:

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

    Paged result set.



84
85
86
# File 'lib/uu/operation_registry/cloud.rb', line 84

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

- (UU::OS::Persistence::PagedResult<Hash>) get_node_list(cloud_uri, criteria = {})

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

Parameters:

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

    Cloud URI.

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

    Criteria for listing nodes.

Options Hash (criteria):

  • query (String)

    Mongo Query to filter the result set. See Mongo Query tutorial.

  • pageIndex (Fixnum)

    Result set page index.

  • pageSize (Fixnum)

    Result set page size.

Returns:

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

    Paged result set.



109
110
111
# File 'lib/uu/operation_registry/cloud.rb', line 109

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

- (UU::OS::Persistence::PagedResult<Hash>) get_resource_group_list(cloud_uri, criteria = {})

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

Parameters:

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

    Cloud URI.

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

    Criteria for listing resource groups.

Options Hash (criteria):

  • query (String)

    Mongo Query to filter the result set. See Mongo Query tutorial.

  • pageIndex (Fixnum)

    Result set page index.

  • pageSize (Fixnum)

    Result set page size.

Returns:

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

    Paged result set.



59
60
61
# File 'lib/uu/operation_registry/cloud.rb', line 59

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