Метод | Описание | |
---|---|---|
createAction ( ) | Creates a new Role in this Environment | |
createVariableAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | Creates role's global var | |
deleteAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | Deletes the role from the environment | |
deleteVariableAction ( integer $roleId, string $name ) : Scalr\Api\DataType\ResultEnvelope | Deletes role's global variable | |
deregisterImageAction ( integer $roleId, string $imageId ) : Scalr\Api\DataType\ResultEnvelope | Disassociates the specified Image. | |
describeAction ( ) | Retrieves the list of the roles that are available on the Environment | |
describeImagesAction ( integer $roleId ) : array | Retrieves the list of the Images associated with this Role | |
describeVariablesAction ( integer $roleId ) : array | Gets the list of the available Global Variables of the role | |
fetchAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | Retrieves a specified role | |
fetchImageAction ( integer $roleId, string $imageId ) : mixed | Fetches specified Image. It actually checks relations and redirects to Image | |
fetchVariableAction ( integer $roleId, string $name ) : Scalr\Api\DataType\ResultEnvelope | Gets specific global var of the role | |
getImage ( integer $roleId, string $imageId ) : |
Gets the Image that is associated with the specified Role using User's Environment | |
getRole ( integer $roleId, boolean $restrictToCurrentScope = false, boolean $modify = null ) : |
Gets role from database using User's Environment | |
getVariableInstance ( ) : Scalr_Scripting_GlobalVariables | Gets global variable object | |
modifyAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | Modifies role attributes | |
modifyVariableAction ( integer $roleId, string $name ) : Scalr\Api\DataType\ResultEnvelope | Modifies role's global variable | |
registerImageAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | Associates a new Image with the Role | |
replaceImageAction ( integer $roleId, string $imageId ) : Scalr\Api\DataType\ResultEnvelope | Associates a new Image with the Role |
Метод | Описание | |
---|---|---|
setImage ( ) | Add, replace or remove image in role |
Метод | Описание | |
---|---|---|
getDefaultCriteria ( ) : array | Gets Default search criteria for the Environment scope |
public createVariableAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | |
Результат | Scalr\Api\DataType\ResultEnvelope |
public deleteAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | The identifier of the role |
Результат | Scalr\Api\DataType\ResultEnvelope |
public deleteVariableAction ( integer $roleId, string $name ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | |
$name | string | |
Результат | Scalr\Api\DataType\ResultEnvelope |
public deregisterImageAction ( integer $roleId, string $imageId ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | The identifier of the Role |
$imageId | string | The identifier of the Image (uuid) |
Результат | Scalr\Api\DataType\ResultEnvelope |
public describeAction ( ) |
public describeImagesAction ( integer $roleId ) : array | ||
$roleId | integer | The identifier of the role |
Результат | array |
public describeVariablesAction ( integer $roleId ) : array | ||
$roleId | integer | |
Результат | array |
public fetchAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | The identifier of the role |
Результат | Scalr\Api\DataType\ResultEnvelope |
public fetchVariableAction ( integer $roleId, string $name ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | |
$name | string | |
Результат | Scalr\Api\DataType\ResultEnvelope |
public getRole ( integer $roleId, boolean $restrictToCurrentScope = false, boolean $modify = null ) : |
||
$roleId | integer | The identifier of the Role |
$restrictToCurrentScope | boolean | optional Whether it should additionally check that role corresponds to current scope |
$modify | boolean | optional Whether it should check access permission with modify flag |
Результат | Returns Role entity on success or NULL otherwise |
public getVariableInstance ( ) : Scalr_Scripting_GlobalVariables | ||
Результат | Scalr_Scripting_GlobalVariables |
public modifyAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | The identifier of the role |
Результат | Scalr\Api\DataType\ResultEnvelope |
public modifyVariableAction ( integer $roleId, string $name ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | |
$name | string | |
Результат | Scalr\Api\DataType\ResultEnvelope |
public registerImageAction ( integer $roleId ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | The Identifier of the role |
Результат | Scalr\Api\DataType\ResultEnvelope |
public replaceImageAction ( integer $roleId, string $imageId ) : Scalr\Api\DataType\ResultEnvelope | ||
$roleId | integer | The Identifier of the role |
$imageId | string | The Identifier of the image |
Результат | Scalr\Api\DataType\ResultEnvelope |
protected setImage ( ) |