PHP Class Scalr\Api\Service\User\V1beta0\Controller\ScalingMetrics

Since: 5.11.9 (05.02.2016)
Author: Andrii Penchuk ([email protected])
Inheritance: extends Scalr\Api\Rest\Controller\ApiController
Datei anzeigen Open project: scalr/scalr

Public Methods

Method Description
createAction ( ) : Scalr\Api\DataType\ResultEnvelope Create a new Custom Scaling Metric in this Environment
deleteAction ( string $metricName ) : Scalr\Api\DataType\ResultEnvelope Delete custom Scaling Metric from database
describeAction ( ) : Scalr\Api\DataType\ListResultEnvelope Gets the list of the available Scaling Metric
fetchAction ( string $metricName ) : Scalr\Api\DataType\ResultEnvelope Fetches detailed info about the Scaling Metric
getScalingMetric ( string $metricName, boolean $restrictToCurrentScope = false ) : ScalingMetric Gets Scaling Metric from database
modifyAction ( string $metricName ) : Scalr\Api\DataType\ResultEnvelope Modifies Custom Scaling Metrics attributes

Private Methods

Method Description
getDefaultCriteria ( ) : array Gets default search criteria for Scaling Metric

Method Details

createAction() public method

Create a new Custom Scaling Metric in this Environment
public createAction ( ) : Scalr\Api\DataType\ResultEnvelope
return Scalr\Api\DataType\ResultEnvelope

deleteAction() public method

Delete custom Scaling Metric from database
public deleteAction ( string $metricName ) : Scalr\Api\DataType\ResultEnvelope
$metricName string Scaling metric's name.
return Scalr\Api\DataType\ResultEnvelope

describeAction() public method

Gets the list of the available Scaling Metric
public describeAction ( ) : Scalr\Api\DataType\ListResultEnvelope
return Scalr\Api\DataType\ListResultEnvelope

fetchAction() public method

Fetches detailed info about the Scaling Metric
public fetchAction ( string $metricName ) : Scalr\Api\DataType\ResultEnvelope
$metricName string Scaling metric's name.
return Scalr\Api\DataType\ResultEnvelope

getScalingMetric() public method

Gets Scaling Metric from database
public getScalingMetric ( string $metricName, boolean $restrictToCurrentScope = false ) : ScalingMetric
$metricName string Scaling metric's name.
$restrictToCurrentScope boolean optional Whether it should additionally check that role corresponds to current scope
return Scalr\Model\Entity\ScalingMetric

modifyAction() public method

Modifies Custom Scaling Metrics attributes
public modifyAction ( string $metricName ) : Scalr\Api\DataType\ResultEnvelope
$metricName string Scaling metric's name.
return Scalr\Api\DataType\ResultEnvelope