environments

Overview

Name	environments
Type	Resource
Id	google.composer.environments

Fields

Name	Datatype	Description
name	string	The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
config	object	Configuration information for an environment.
createTime	string	Output only. The time at which this environment was created.
labels	object	Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
state	string	The current state of the environment.
updateTime	string	Output only. The time at which this environment was last modified.
uuid	string	Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	environmentsId, locationsId, projectsId	Get an existing environment.
list	SELECT	locationsId, projectsId	List environments.
create	INSERT	locationsId, projectsId	Create a new environment.
delete	DELETE	environmentsId, locationsId, projectsId	Delete an environment.
_list	EXEC	locationsId, projectsId	List environments.
database_failover	EXEC	environmentsId, locationsId, projectsId	Triggers database failover (only for highly resilient environments).
execute_airflow_command	EXEC	environmentsId, locationsId, projectsId	Executes Airflow CLI command.
load_snapshot	EXEC	environmentsId, locationsId, projectsId	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.
patch	EXEC	environmentsId, locationsId, projectsId	Update an environment.
poll_airflow_command	EXEC	environmentsId, locationsId, projectsId	Polls Airflow CLI command execution and fetches logs.
save_snapshot	EXEC	environmentsId, locationsId, projectsId	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.
stop_airflow_command	EXEC	environmentsId, locationsId, projectsId	Stops Airflow CLI command execution.