ProjectsLocationsEnvironments
class ProjectsLocationsEnvironments extends Resource (View source)
The "environments" collection of methods.
Typical usage is:
$composerService = new Google\Service\CloudComposer(...);
$environments = $composerService->projects_locations_environments;Methods
Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.
Create a new environment. (environments.create)
Triggers database failover (only for highly resilient environments).
Executes Airflow CLI command. (environments.executeAirflowCommand)
Fetches database properties. (environments.fetchDatabaseProperties)
Get an existing environment. (environments.get)
List environments. (environments.listProjectsLocationsEnvironments)
Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment. (environments.loadSnapshot)
Update an environment. (environments.patch)
Polls Airflow CLI command execution and fetches logs.
Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest. (environments.saveSnapshot)
Stops Airflow CLI command execution. (environments.stopAirflowCommand)
Details
Operation
checkUpgrade(string $environment, CheckUpgradeRequest $postBody, array $optParams = [])
Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.
(environments.checkUpgrade)
Operation
create(string $parent, Environment $postBody, array $optParams = [])
Create a new environment. (environments.create)
Operation
databaseFailover(string $environment, DatabaseFailoverRequest $postBody, array $optParams = [])
Triggers database failover (only for highly resilient environments).
(environments.databaseFailover)
Operation
delete(string $name, array $optParams = [])
Delete an environment. (environments.delete)
ExecuteAirflowCommandResponse
executeAirflowCommand(string $environment, ExecuteAirflowCommandRequest $postBody, array $optParams = [])
Executes Airflow CLI command. (environments.executeAirflowCommand)
FetchDatabasePropertiesResponse
fetchDatabaseProperties(string $environment, array $optParams = [])
Fetches database properties. (environments.fetchDatabaseProperties)
Environment
get(string $name, array $optParams = [])
Get an existing environment. (environments.get)
ListEnvironmentsResponse
listProjectsLocationsEnvironments(string $parent, array $optParams = [])
List environments. (environments.listProjectsLocationsEnvironments)
Operation
loadSnapshot(string $environment, LoadSnapshotRequest $postBody, array $optParams = [])
Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment. (environments.loadSnapshot)
Operation
patch(string $name, Environment $postBody, array $optParams = [])
Update an environment. (environments.patch)
PollAirflowCommandResponse
pollAirflowCommand(string $environment, PollAirflowCommandRequest $postBody, array $optParams = [])
Polls Airflow CLI command execution and fetches logs.
(environments.pollAirflowCommand)
Operation
saveSnapshot(string $environment, SaveSnapshotRequest $postBody, array $optParams = [])
Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest. (environments.saveSnapshot)
StopAirflowCommandResponse
stopAirflowCommand(string $environment, StopAirflowCommandRequest $postBody, array $optParams = [])
Stops Airflow CLI command execution. (environments.stopAirflowCommand)