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

Author: N.V.

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

Public Methods

Method	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

Method	Description
getDefaultCriteria ( ) : array	Gets default search criteria according current account

Method Details

allowTeamAction() public method

Allows team access to environment

public allowTeamAction ( integer $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId	integer	Environment ID
return	Scalr\Api\DataType\ResultEnvelope

attachCredentialsAction() public method

Configures cloud credentials

public attachCredentialsAction ( integer $envId, string $cloud ) : Scalr\Api\DataType\ResultEnvelope
$envId	integer	Environment ID
$cloud	string	Cloud platform name
return	Scalr\Api\DataType\ResultEnvelope

createAction() public method

Create a new Environment in this Account

public createAction ( )

deleteAction() public method

Delete an Environment from this Account

public deleteAction ( string $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId	string	Unique identifier of the Environment
return	Scalr\Api\DataType\ResultEnvelope

denyTeamAction() public method

Revoke team access to specified environment

public denyTeamAction ( integer $envId, integer $teamId ) : Scalr\Api\DataType\ResultEnvelope
$envId	integer	Environment ID
$teamId	integer	Team ID
return	Scalr\Api\DataType\ResultEnvelope

describeAction() public method

Retrieves the list of the Environments

public describeAction ( ) : array
return	array	Returns describe result

describeCloudsAction() public method

Lists configured clouds for specified Environment

public describeCloudsAction ( string $envId ) : Scalr\Api\DataType\ListResultEnvelope
$envId	string	Unique identifier of the Environment
return	Scalr\Api\DataType\ListResultEnvelope

describeTeamsAction() public method

Describes teams that have access to specified environment

public describeTeamsAction ( integer $envId ) : Scalr\Api\DataType\ListResultEnvelope
$envId	integer	Environment ID
return	Scalr\Api\DataType\ListResultEnvelope

detachCredentialsAction() public method

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
return	Scalr\Api\DataType\ResultEnvelope

fetchAction() public method

Fetches detailed info about one environment

public fetchAction ( string $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId	string	Numeric identifier of the environment
return	Scalr\Api\DataType\ResultEnvelope

fetchCloudCredentialsAction() public method

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
return	Scalr\Api\DataType\ResultEnvelope

getCloudCredentials() public method

Gets CloudCredentials entity

public getCloudCredentials ( string $cloudCredentialsId ) : CloudCredentials
$cloudCredentialsId	string	Unique identifier of the CloudCredentials
return	Scalr\Model\Entity\CloudCredentials

getCloudCredsController() public method

Gets CloudCredentials controller

public getCloudCredsController ( ) : CloudCredentials
return	Scalr\Api\Service\User\V1beta0\Controller\CloudCredentials

getCostCenter() public method

Gets CostCentre entity

public getCostCenter ( string $ccId ) : Scalr\Stats\CostAnalytics\Entity\CostCentreEntity
$ccId	string	Unique identifier of the CostCentre
return	Scalr\Stats\CostAnalytics\Entity\CostCentreEntity

getCostCentersController() public method

Gets CostCenters controller

public getCostCentersController ( ) : CostCenters
return	Scalr\Api\Service\User\V1beta0\Controller\CostCenters

getEnv() public method

Gets specified Environment

public getEnv ( string $envId ) : Environment
$envId	string	Numeric identifier of the Environment
return	Scalr\Model\Entity\Account\Environment	Returns the Environment Entity on success

getTeam() public method

Gets Team entity

public getTeam ( string $teamId ) : Team
$teamId	string	Unique identifier of the Team
return	Scalr\Model\Entity\Account\Team

getTeamsController() public method

Gets Teams controller

public getTeamsController ( ) : Teams
return	Teams

modifyAction() public method

Change environment attributes.

public modifyAction ( integer $envId ) : Scalr\Api\DataType\ResultEnvelope
$envId	integer	Unique identifier of the environment
return	Scalr\Api\DataType\ResultEnvelope