PHP Class Scalr\Api\Service\Account\V1beta0\Controller\Environments

Author: N.V.
Inheritance: extends Scalr\Api\Rest\Controller\ApiController
Afficher le fichier Open project: scalr/scalr

Méthodes publiques

Méthode Description
allowTeamAction ( integer $envId ) : Scalr\Api\DataType\ResultEnvelope Allows team access to environment
attachCredentialsAction ( integer $envId, string $cloud ) : Scalr\Api\DataType\ResultEnvelope Configures cloud credentials
createAction ( ) Create a new Environment in this Account
deleteAction ( string $envId ) : Scalr\Api\DataType\ResultEnvelope Delete an Environment from this Account
denyTeamAction ( integer $envId, integer $teamId ) : Scalr\Api\DataType\ResultEnvelope Revoke team access to specified environment
describeAction ( ) : array Retrieves the list of the Environments
describeCloudsAction ( string $envId ) : Scalr\Api\DataType\ListResultEnvelope Lists configured clouds for specified Environment
describeTeamsAction ( integer $envId ) : Scalr\Api\DataType\ListResultEnvelope Describes teams that have access to specified environment
detachCredentialsAction ( integer $envId, string $cloud ) : Scalr\Api\DataType\ResultEnvelope Detach configured cloud configuration from specified environment
fetchAction ( string $envId ) : Scalr\Api\DataType\ResultEnvelope Fetches detailed info about one environment
fetchCloudCredentialsAction ( integer $envId, string $cloud ) : Scalr\Api\DataType\ResultEnvelope Fetch detailed info about specified cloud configuration
getCloudCredentials ( string $cloudCredentialsId ) : CloudCredentials Gets CloudCredentials entity
getCloudCredsController ( ) : CloudCredentials Gets CloudCredentials controller
getCostCenter ( string $ccId ) : Scalr\Stats\CostAnalytics\Entity\CostCentreEntity Gets CostCentre entity
getCostCentersController ( ) : CostCenters Gets CostCenters controller
getEnv ( string $envId ) : Environment Gets specified Environment
getTeam ( string $teamId ) : Team Gets Team entity
getTeamsController ( ) : Teams Gets Teams controller
modifyAction ( integer $envId ) : Scalr\Api\DataType\ResultEnvelope Change environment attributes.

Private Methods

Méthode Description
getDefaultCriteria ( ) : array Gets default search criteria according current account

Method Details

allowTeamAction() public méthode

Allows team access to environment
public allowTeamAction ( integer $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId integer Environment ID
Résultat Scalr\Api\DataType\ResultEnvelope

attachCredentialsAction() public méthode

Configures cloud credentials
public attachCredentialsAction ( integer $envId, string $cloud ) : Scalr\Api\DataType\ResultEnvelope
$envId integer Environment ID
$cloud string Cloud platform name
Résultat Scalr\Api\DataType\ResultEnvelope

createAction() public méthode

Create a new Environment in this Account
public createAction ( )

deleteAction() public méthode

Delete an Environment from this Account
public deleteAction ( string $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId string Unique identifier of the Environment
Résultat Scalr\Api\DataType\ResultEnvelope

denyTeamAction() public méthode

Revoke team access to specified environment
public denyTeamAction ( integer $envId, integer $teamId ) : Scalr\Api\DataType\ResultEnvelope
$envId integer Environment ID
$teamId integer Team ID
Résultat Scalr\Api\DataType\ResultEnvelope

describeAction() public méthode

Retrieves the list of the Environments
public describeAction ( ) : array
Résultat array Returns describe result

describeCloudsAction() public méthode

Lists configured clouds for specified Environment
public describeCloudsAction ( string $envId ) : Scalr\Api\DataType\ListResultEnvelope
$envId string Unique identifier of the Environment
Résultat Scalr\Api\DataType\ListResultEnvelope

describeTeamsAction() public méthode

Describes teams that have access to specified environment
public describeTeamsAction ( integer $envId ) : Scalr\Api\DataType\ListResultEnvelope
$envId integer Environment ID
Résultat Scalr\Api\DataType\ListResultEnvelope

detachCredentialsAction() public méthode

Detach configured cloud configuration from specified environment
public detachCredentialsAction ( integer $envId, string $cloud ) : Scalr\Api\DataType\ResultEnvelope
$envId integer Environment ID
$cloud string Cloud platform name
Résultat Scalr\Api\DataType\ResultEnvelope

fetchAction() public méthode

Fetches detailed info about one environment
public fetchAction ( string $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId string Numeric identifier of the environment
Résultat Scalr\Api\DataType\ResultEnvelope

fetchCloudCredentialsAction() public méthode

Fetch detailed info about specified cloud configuration
public fetchCloudCredentialsAction ( integer $envId, string $cloud ) : Scalr\Api\DataType\ResultEnvelope
$envId integer Environment ID
$cloud string Cloud platform name
Résultat Scalr\Api\DataType\ResultEnvelope

getCloudCredentials() public méthode

Gets CloudCredentials entity
public getCloudCredentials ( string $cloudCredentialsId ) : CloudCredentials
$cloudCredentialsId string Unique identifier of the CloudCredentials
Résultat Scalr\Model\Entity\CloudCredentials

getCloudCredsController() public méthode

Gets CloudCredentials controller
public getCloudCredsController ( ) : CloudCredentials
Résultat Scalr\Api\Service\User\V1beta0\Controller\CloudCredentials

getCostCenter() public méthode

Gets CostCentre entity
public getCostCenter ( string $ccId ) : Scalr\Stats\CostAnalytics\Entity\CostCentreEntity
$ccId string Unique identifier of the CostCentre
Résultat Scalr\Stats\CostAnalytics\Entity\CostCentreEntity

getCostCentersController() public méthode

Gets CostCenters controller
public getCostCentersController ( ) : CostCenters
Résultat Scalr\Api\Service\User\V1beta0\Controller\CostCenters

getEnv() public méthode

Gets specified Environment
public getEnv ( string $envId ) : Environment
$envId string Numeric identifier of the Environment
Résultat Scalr\Model\Entity\Account\Environment Returns the Environment Entity on success

getTeam() public méthode

Gets Team entity
public getTeam ( string $teamId ) : Team
$teamId string Unique identifier of the Team
Résultat Scalr\Model\Entity\Account\Team

getTeamsController() public méthode

Gets Teams controller
public getTeamsController ( ) : Teams
Résultat Teams

modifyAction() public méthode

Change environment attributes.
public modifyAction ( integer $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId integer Unique identifier of the environment
Résultat Scalr\Api\DataType\ResultEnvelope