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

Author: N.V.

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

Protected Properties

Property	Type	Description
$entityClass
$entityDescriminator	string	The name of entity field in charge of inheritance
$inheritanceMap
$inheritedNamespace	string	Namespace for inherited adapters
$objectDiscriminator	string	The name of data field in charge of inheritance

Method	Description
adapter ( string \| CloudCredentials \| object $name, string $scope = null, string $version = null, array $transform = null ) : ApiEntityAdapter	Gets a new Instance of the adapter
createAction ( )
deleteAction ( $cloudCredentialsId )
describeAction ( ) : Scalr\Api\DataType\ListResultEnvelope	Retrieves the list of the cloud credentials
fetchAction ( $cloudCredentialsId )
getCloudCredentials ( string $cloudCredentialsId, boolean $modify = false ) : CloudCredentials	Gets CloudCredentials entity
getDefaultCriteria ( ) : array	Gets default search criteria according request scope
modifyAction ( $cloudCredentialsId )

Gets a new Instance of the adapter

public adapter ( string \| CloudCredentials \| object $name, string $scope = null, string $version = null, array $transform = null ) : ApiEntityAdapter
$name	string \| CloudCredentials \| object	The name of the adapter, or CloudCredentials entity, or cloud credentials data
$scope	string	optional The scope of the adapter
$version	string	optional The version of the adapter
$transform	array	optional The transformation rules for the type of the cloud credentials
return	Scalr\Api\DataType\ApiEntityAdapter	Returns the instance of cloud credentials adapter

public createAction ( )

public deleteAction ( $cloudCredentialsId )

Retrieves the list of the cloud credentials

public describeAction ( ) : Scalr\Api\DataType\ListResultEnvelope
return	Scalr\Api\DataType\ListResultEnvelope	Returns describe result

public fetchAction ( $cloudCredentialsId )

Gets CloudCredentials entity

public getCloudCredentials ( string $cloudCredentialsId, boolean $modify = false ) : CloudCredentials
$cloudCredentialsId	string	Unique identifier of the CloudCredentials
$modify	boolean	Obtaining CloudCredentials in modification purposes
return	Scalr\Model\Entity\CloudCredentials

Gets default search criteria according request scope

public getDefaultCriteria ( ) : array
return	array	Returns array of the search criteria

public modifyAction ( $cloudCredentialsId )

protected $entityClass

The name of entity field in charge of inheritance

protected static string $entityDescriminator
return	string

protected static $inheritanceMap

Namespace for inherited adapters

protected static string $inheritedNamespace
return	string

The name of data field in charge of inheritance

protected static string $objectDiscriminator
return	string