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

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

Public Methods

Method Description
createAction ( ) Create a new Script in this Environment
deleteAction ( string $scriptId ) : Scalr\Api\DataType\ResultEnvelope Delete an Script from this Environment
describeAction ( ) : array Retrieves the list of the scripts
fetchAction ( string $scriptId ) : Scalr\Api\DataType\ResultEnvelope Fetches detailed info about one script
getScript ( string $scriptId, boolean $modify = false ) : Script Gets specified Script taking into account both scope and authentication token
modifyAction ( integer $scriptId ) : Scalr\Api\DataType\ResultEnvelope Change script attributes.

Private Methods

Method Description
getDefaultCriteria ( ) : array Gets default search criteria according environment scope

Method Details

createAction() public method

Create a new Script in this Environment
public createAction ( )

deleteAction() public method

Delete an Script from this Environment
public deleteAction ( string $scriptId ) : Scalr\Api\DataType\ResultEnvelope
$scriptId string Unique identifier of the script
return Scalr\Api\DataType\ResultEnvelope

describeAction() public method

Retrieves the list of the scripts
public describeAction ( ) : array
return array Returns describe result

fetchAction() public method

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

getScript() public method

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

modifyAction() public method

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