Class: UU::OperationRegistry::Region

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

Overview

Region.

Constant Summary

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Region) initialize(session = nil)

Creates a new instance of Region.

Parameters:

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

    Session to use for remote calls.



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

def initialize(session = nil)
  super
end

Class Method Details

+ (UU::OS::UESURI) create(cloud_uri, attributes)

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

Parameters:

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

    Cloud URI.

  • attributes (Hash) —

    Region attributes.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the created region.




# File 'lib/uu/operation_registry/region.rb', line 32

+ (void) delete(region_uri)

This method returns an undefined value.

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

Parameters:

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

    Region URI.




# File 'lib/uu/operation_registry/region.rb', line 73

+ (Hash) get_attributes(region_uri)

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

Parameters:

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

    Region URI.

Returns:

  • (Hash) —

    Region attributes.




# File 'lib/uu/operation_registry/region.rb', line 45

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

Returns list of regions. This method is a convenience shortcut for the #get_region_list instance method.

Returns:

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

    Paged result set.

See Also:



100
101
102
 
# File 'lib/uu/operation_registry/region.rb', line 100

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

+ (UU::OS::UESURI) set_attributes(region_uri, attributes)

Sets attributes of an region. This method is a convenience shortcut for the #set_attributes instance method.

Parameters:

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

    Region URI.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the updated region.




# File 'lib/uu/operation_registry/region.rb', line 62

Instance Method Details

- (UU::OS::UESURI) create(cloud_uri, attributes)

Creates a new region.

Parameters:

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

    Cloud URI.

  • attributes (Hash) —

    Region attributes.

Options Hash (attributes):

  • name (String) —

    Region name. May be nil.

  • code (String) —

    Region code. May be nil.

  • description (String) —

    Region description. May be nil.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the created region.




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

- (void) delete(region_uri)

This method returns an undefined value.

Deletes the specified region from the registry.

Parameters:

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

    Region URI.




# File 'lib/uu/operation_registry/region.rb', line 68

- (Hash) get_attributes(region_uri)

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

Parameters:

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

    Region URI.

Returns:

  • (Hash) —

    Region attributes.




# File 'lib/uu/operation_registry/region.rb', line 39

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

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

Parameters:

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

    Cloud URI.

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

    Criteria for listing regions.

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.



91
92
93
 
# File 'lib/uu/operation_registry/region.rb', line 91

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

- (UU::OS::UESURI) set_attributes(region_uri, attributes)

Sets attributes of an region.

Parameters:

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

    Region URI.

  • attributes (Hash) —

    Region attributes.

Options Hash (attributes):

  • name (String) —

    Region name. May be nil.

  • code (String) —

    Region code. May be nil.

  • description (String) —

    Region description. May be nil.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the updated region.




# File 'lib/uu/operation_registry/region.rb', line 52