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

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

Public Methods

Method Description
createAction ( integer $scriptId ) : Scalr\Api\DataType\ResultEnvelope Create a new version of script
deleteAction ( integer $scriptId, integer $versionNumber ) : Scalr\Api\DataType\ResultEnvelope Remove script version
describeAction ( $scriptId ) : array Retrieves the list of the script versions
fetchAction ( string $scriptId, integer $versionNumber ) : Scalr\Api\DataType\ResultEnvelope Fetches detailed info about one script
getVersion ( string $scriptId, integer $versionNumber, boolean $modify = false ) : Scalr\Model\Entity\ScriptVersion Gets specified Version for the Script taking into account both scope and authentication token
modifyAction ( integer $scriptId, integer $versionNumber ) : Scalr\Api\DataType\ResultEnvelope Change version attributes.

Method Details

createAction() public method

Create a new version of script
public createAction ( integer $scriptId ) : Scalr\Api\DataType\ResultEnvelope
$scriptId integer Unique identifier of the script
return Scalr\Api\DataType\ResultEnvelope

deleteAction() public method

Remove script version
public deleteAction ( integer $scriptId, integer $versionNumber ) : Scalr\Api\DataType\ResultEnvelope
$scriptId integer Script ID
$versionNumber integer Version number
return Scalr\Api\DataType\ResultEnvelope

describeAction() public method

Retrieves the list of the script versions
public describeAction ( $scriptId ) : array
$scriptId
return array Returns describe result

fetchAction() public method

Fetches detailed info about one script
public fetchAction ( string $scriptId, integer $versionNumber ) : Scalr\Api\DataType\ResultEnvelope
$scriptId string Numeric identifier of the script
$versionNumber integer Script version Number
return Scalr\Api\DataType\ResultEnvelope

getVersion() public method

Gets specified Version for the Script taking into account both scope and authentication token
public getVersion ( string $scriptId, integer $versionNumber, boolean $modify = false ) : Scalr\Model\Entity\ScriptVersion
$scriptId string Numeric identifier of the Script
$versionNumber integer Script version number
$modify boolean optional Flag checking write permissions
return Scalr\Model\Entity\ScriptVersion Returns the Script Entity on success

modifyAction() public method

Change version attributes.
public modifyAction ( integer $scriptId, integer $versionNumber ) : Scalr\Api\DataType\ResultEnvelope
$scriptId integer Unique identifier of the script
$versionNumber integer Script version number
return Scalr\Api\DataType\ResultEnvelope