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

Author: N.V.
Inheritance: extends Scalr\Api\Rest\Controller\ApiController
显示文件 Open project: scalr/scalr

Public Methods

Method Description
createAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope Create a new Orchestration Rule for this Role
deleteAction ( integer $roleId, integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope Delete rule from specified role
describeAction ( integer $roleId ) : array Retrieves the list of orchestration rules of the role
fetchAction ( integer $roleId, integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope Fetches detailed info about specified rule
getRole ( integer $roleId, boolean $modify = false ) : Role | null Gets role from database using User's Environment
getRule ( integer $ruleId, boolean $modify = false ) : Scalr\Model\Entity\RoleScript Gets specified orchestration rule
modifyAction ( integer $roleId, integer $ruleId ) : Scalr\Api\DataType\ResultEnvelope Change rule attributes.

Method Details

createAction() public method

Create a new Orchestration Rule for this Role
public createAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope
$roleId integer Numeric identifier of the role
return Scalr\Api\DataType\ResultEnvelope

deleteAction() public method

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

describeAction() public method

Retrieves the list of orchestration rules of the role
public describeAction ( integer $roleId ) : array
$roleId integer Numeric role id
return array Returns describe result

fetchAction() public method

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

getRole() public method

Gets role from database using User's Environment
public getRole ( integer $roleId, boolean $modify = false ) : Role | null
$roleId integer The identifier of the Role
$modify boolean optional Flag checking write permissions
return Scalr\Model\Entity\Role | null

getRule() public method

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

modifyAction() public method

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