PHP Class Scalr\Model\Entity\ScalingMetric

Since: 5.9 (10.06.2015)
Author: Roman Kolodnitskyi ([email protected])
Inheritance: extends Scalr\Model\AbstractEntity, implements Scalr\DataType\ScopeInterface
Mostra file Open project: scalr/scalr Class Usage Examples

Public Properties

Property Type Description
$accountId integer The identifier of the client's account.
$algorithm string Algorithm.
$alias string Alias.
$calcFunction string Calculating function.
$envId integer The identifier of the client's environment.
$filePath string File path.
$id integer ID.
$isInvert boolean Should it follow inverted logic
$name string Metric's Name.
$retrieveMethod string Retrieve method.

Public Methods

Method Description
getAlgorithm ( string $algoName ) : Scalr_Scaling_Algorithms_DateTim\Scalr_Scaling_Algorithms_DateTime | Scalr_Scaling_Algorithms_Senso\Scalr_Scaling_Algorithms_Sensor Get specified algorithm object
getList ( integer $envId ) : array Get list with basic info about metrics.
getScope ( )
isUsed ( ) : integer | false Checks whether the ScalingMetric is already used in some FarmRoleScalingMetric

Method Details

getAlgorithm() public static method

Get specified algorithm object
public static getAlgorithm ( string $algoName ) : Scalr_Scaling_Algorithms_DateTim\Scalr_Scaling_Algorithms_DateTime | Scalr_Scaling_Algorithms_Senso\Scalr_Scaling_Algorithms_Sensor
$algoName string Name of algorithm
return Scalr_Scaling_Algorithms_DateTim\Scalr_Scaling_Algorithms_DateTime | Scalr_Scaling_Algorithms_Senso\Scalr_Scaling_Algorithms_Sensor Algorithm object

getList() public static method

Get list with basic info about metrics.
public static getList ( integer $envId ) : array
$envId integer Identifier of environment
return array

getScope() public method

See also: Scalr\DataType\ScopeInterface::getScope()
public getScope ( )

isUsed() public method

Checks whether the ScalingMetric is already used in some FarmRoleScalingMetric
public isUsed ( ) : integer | false
return integer | false Number of FarmRoleScalingMetric using this metric or false

Property Details

$accountId public_oe property

The identifier of the client's account.
public int $accountId
return integer

$algorithm public_oe property

Algorithm.
public string $algorithm
return string

$alias public_oe property

Alias.
public string $alias
return string

$calcFunction public_oe property

Calculating function.
public string $calcFunction
return string

$envId public_oe property

The identifier of the client's environment.
public int $envId
return integer

$filePath public_oe property

File path.
public string $filePath
return string

$id public_oe property

ID.
public int $id
return integer

$isInvert public_oe property

Should it follow inverted logic
public bool $isInvert
return boolean

$name public_oe property

Metric's Name.
public string $name
return string

$retrieveMethod public_oe property

Retrieve method.
public string $retrieveMethod
return string