Environments
extends CloudApiBase
in
implements
CloudApiInterface
Class Environments
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| copyFiles() | Copies files from an environment to another environment. | OperationResponse |
| get() | Gets information about an environment. | EnvironmentResponse |
| getAll() | Shows all environments in an application. | EnvironmentsResponse |
| update() | Modifies configuration settings for an environment. | OperationResponse |
| rename() | Renames an environment. | OperationResponse |
| enableLiveDev() | Enable livedev mode for an environment. | OperationResponse |
| disableLiveDev() | Disable livedev mode for an environment. | OperationResponse |
| enableProductionMode() | Enable production mode for an environment. | OperationResponse |
| disableProductionMode() | Disable production mode for an environment. | OperationResponse |
| create() | Add a new continuous delivery environment to an application. | OperationResponse |
| delete() | Deletes a CD environment. | OperationResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
copyFiles()
Copies files from an environment to another environment.
public
copyFiles(
$environmentUuidFrom :
string
, $environmentUuidTo :
string
)
: OperationResponse
Parameters
- $environmentUuidFrom : string
- $environmentUuidTo : string
Return values
OperationResponseget()
Gets information about an environment.
public
get(
$environmentUuid :
string
)
: EnvironmentResponse
Parameters
- $environmentUuid : string
Return values
EnvironmentResponsegetAll()
Shows all environments in an application.
public
getAll(
$applicationUuid :
string
)
: EnvironmentsResponse
Parameters
- $applicationUuid : string
Return values
EnvironmentsResponseupdate()
Modifies configuration settings for an environment.
public
update(
$environmentUuid :
string
, $config :
array
)
: OperationResponse
Parameters
- $environmentUuid : string
- $config : array
Return values
OperationResponserename()
Renames an environment.
public
rename(
$environmentUuid :
string
, $label :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
- $label : string
Return values
OperationResponseenableLiveDev()
Enable livedev mode for an environment.
public
enableLiveDev(
$environmentUuid :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
Return values
OperationResponsedisableLiveDev()
Disable livedev mode for an environment.
public
disableLiveDev(
$environmentUuid :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
Return values
OperationResponseenableProductionMode()
Enable production mode for an environment.
public
enableProductionMode(
$environmentUuid :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
Return values
OperationResponsedisableProductionMode()
Disable production mode for an environment.
public
disableProductionMode(
$environmentUuid :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
Return values
OperationResponsecreate()
Add a new continuous delivery environment to an application.
public
create(
$applicationUuid :
string
, $label :
string
, $branch :
string
, $databases :
array
)
: OperationResponse
Parameters
- $applicationUuid : string
- $label : string
- $branch : string
- $databases : array
Return values
OperationResponsedelete()
Deletes a CD environment.
public
delete(
$environmentUuid :
string
)
: OperationResponse
Parameters
- $environmentUuid : string
Return values
OperationResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface