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

Since: 5.4.0 (03.03.2015)

Author: Vitaliy Demidov ([email protected])

Inheritance: extends Scalr\Api\Rest\Controller\ApiController

Public Methods

Method	Description
copyAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope	Copies image to different location
deregisterAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope	De-registers an Image from this Environment
describeAction ( )	Retrieves the list of the images
fetchAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope	Fetches detailed info about one image
getImage ( string $imageId, boolean $restrictToCurrentScope = false ) : Image	Gets specified Image taking into account both scope and authentication token
getImageByCloudId ( string $cloudImageId, string $platform, string $cloudLocation ) : boolean	Checks whether Image does exist in the user's scope
modifyAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope	Change image attributes. Only the name be can changed!
registerAction ( )	Register an Image in the Environment

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

Copies image to different location

public copyAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope
$imageId	string	Unique identifier of the image (uuid)
return	Scalr\Api\DataType\ResultEnvelope

De-registers an Image from this Environment

public deregisterAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope
$imageId	string	Unique identifier of the image (uuid)
return	Scalr\Api\DataType\ResultEnvelope

Retrieves the list of the images

public describeAction ( )

Fetches detailed info about one image

public fetchAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope
$imageId	string	Unique identifier of the image (uuid)
return	Scalr\Api\DataType\ResultEnvelope

Gets specified Image taking into account both scope and authentication token

public getImage ( string $imageId, boolean $restrictToCurrentScope = false ) : Image
$imageId	string	The unique identifier of the Image (UUID)
$restrictToCurrentScope	boolean	optional Whether it should additionally check the Image corresponds to current scope
return	Scalr\Model\Entity\Image	Returns the Image Entity on success

Checks whether Image does exist in the user's scope

public getImageByCloudId ( string $cloudImageId, string $platform, string $cloudLocation ) : boolean
$cloudImageId	string	The identifier of the image on the Cloud
$platform	string	The cloud platform
$cloudLocation	string	The cloud location
return	boolean	Returns TRUE if image exists in the user's scope

Change image attributes. Only the name be can changed!

public modifyAction ( string $imageId ) : Scalr\Api\DataType\ResultEnvelope
$imageId	string	Unique identifier of the image (uuid)
return	Scalr\Api\DataType\ResultEnvelope

public registerAction ( )