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

Author: N.V.
Inheritance: extends Scalr\Api\Rest\Controller\ApiController
Show file Open project: scalr/scalr

Public Methods

Method Description
createAction ( ) : Scalr\Api\DataType\ResultEnvelope Create a new Orchestration Rule for an Account
deleteAction ( integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope Delete rule from account
describeAction ( ) : array Retrieves the list of account orchestration rules
fetchAction ( integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope Fetches detailed info about specified rule
getRule ( integer $ruleId, boolean $modify = false ) : Scalr\Model\Entity\AccountScript Gets specified orchestration rule
modifyAction ( integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope Change rule attributes.

Method Details

createAction() public method

Create a new Orchestration Rule for an Account
public createAction ( ) : Scalr\Api\DataType\ResultEnvelope
return Scalr\Api\DataType\ResultEnvelope

deleteAction() public method

Delete rule from account
public deleteAction ( integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope
$ruleId integer Numeric identifier of the rule
return Scalr\Api\DataType\ResultEnvelope

describeAction() public method

Retrieves the list of account orchestration rules
public describeAction ( ) : array
return array Returns describe result

fetchAction() public method

Fetches detailed info about specified rule
public fetchAction ( integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope
$ruleId integer Numeric identifier of the rule
return Scalr\Api\DataType\ResultEnvelope

getRule() public method

Gets specified orchestration rule
public getRule ( integer $ruleId, boolean $modify = false ) : Scalr\Model\Entity\AccountScript
$ruleId integer Numeric identifier of the rule
$modify boolean optional Modifying flag
return Scalr\Model\Entity\AccountScript Returns the Script Entity on success

modifyAction() public method

Change rule attributes.
public modifyAction ( integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope
$ruleId integer Numeric identifier of the rule
return Scalr\Api\DataType\ResultEnvelope