Class: UU::OperationRegistry::CapacityLog

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

Overview

Log of changes in capacity allocation.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session = nil) ⇒ CapacityLog

Returns a new instance of CapacityLog.



15
16
17
18
 
# File 'lib/uu/operation_registry/capacity_log.rb', line 15

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

Class Method Details

.consolidate(cloud_uri, parameters = {}) ⇒ void

This method returns an undefined value.

Adds initial capacity record for all tenants and all resource pools for the specified month. This method is a convenience shortcut for the #consolidate instance method.

Parameters:

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

    Cloud URI.

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

    Parameters for consolidating resource pool capacity.



70
71
72
 
# File 'lib/uu/operation_registry/capacity_log.rb', line 70

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

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

Returns a list of capacity log records for given resource pool. The list of returned records could be filtered using Mongo Query.

Parameters:

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

    Resource pool URI.

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

    Criteria for listing resource pools.

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.



48
49
50
 
# File 'lib/uu/operation_registry/capacity_log.rb', line 48

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

Instance Method Details

#consolidate(cloud_uri, parameters = {}) ⇒ void

This method returns an undefined value.

Adds initial capacity record for all tenants and all resource pools for the specified month. This command creates new capacity log record that represents initial of the particular resource pool capacity to the first day of the specified month at 0:00:00.

Parameters:

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

    Cloud URI.

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

    Parameters for consolidating resource pool capacity.

Options Hash (parameters):

  • month (String) —

    Determines which month to add initial capacity for. Expected format: yyyy-mm.



60
61
62
 
# File 'lib/uu/operation_registry/capacity_log.rb', line 60

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

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

Returns a list of capacity log records for given resource pool. The list of returned records could be filtered using Mongo Query.

Parameters:

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

    Resource pool URI.

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

    Criteria for listing resource pools.

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.



32
33
34
 
# File 'lib/uu/operation_registry/capacity_log.rb', line 32

def get_record_list(resource_pool_uri, criteria = {})
  @client.invoke(:getRecordList, resource_pool_uri, parameters: criteria)
end