- Resource: Environment
- EnvironmentConfig
- SoftwareConfig
- CloudDataLineageIntegration
- WebServerPluginsMode
- NodeConfig
- IPAllocationPolicy
- PrivateEnvironmentConfig
- PrivateClusterConfig
- NetworkingConfig
- ConnectionType
- WebServerNetworkAccessControl
- AllowedIpRange
- DatabaseConfig
- WebServerConfig
- EncryptionConfig
- MaintenanceWindow
- WorkloadsConfig
- SchedulerResource
- WebServerResource
- WorkerResource
- TriggererResource
- DagProcessorResource
- EnvironmentSize
- MasterAuthorizedNetworksConfig
- CidrBlock
- RecoveryConfig
- ScheduledSnapshotsConfig
- ResilienceMode
- DataRetentionConfig
- AirflowMetadataRetentionPolicyConfig
- RetentionMode
- TaskLogsRetentionConfig
- TaskLogsStorageMode
- State
- StorageConfig
- Methods
Resource: Environment
An environment for running orchestration tasks.
JSON representation |
---|
{ "name": string, "config": { object ( |
Fields | |
---|---|
name |
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 |
Configuration parameters for this environment. |
uuid |
Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. |
state |
The current state of the environment. |
createTime |
Output only. The time at which this environment was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time at which this environment was last modified. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
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:
An object containing a list of |
satisfiesPzs |
Output only. Reserved for future use. |
satisfiesPzi |
Output only. Reserved for future use. |
storageConfig |
Optional. Storage configuration for this environment. |
EnvironmentConfig
Configuration information for an environment.
JSON representation |
---|
{ "gkeCluster": string, "dagGcsPrefix": string, "nodeCount": integer, "softwareConfig": { object ( |
Fields | |
---|---|
gkeCluster |
Output only. The Kubernetes Engine cluster used to run this environment. |
dagGcsPrefix |
Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix. |
nodeCount |
The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
softwareConfig |
The configuration settings for software inside the environment. |
nodeConfig |
The configuration used for the Kubernetes Engine cluster. |
privateEnvironmentConfig |
The configuration used for the Private IP Cloud Composer environment. |
webServerNetworkAccessControl |
Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied. |
databaseConfig |
Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software. |
webServerConfig |
Optional. The configuration settings for the Airflow web server App Engine instance. |
encryptionConfig |
Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated. |
maintenanceWindow |
Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week. |
workloadsConfig |
Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers workloads. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
environmentSize |
Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
airflowUri |
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface). |
airflowByoidUri |
Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see Access environments with workforce identity federation). |
masterAuthorizedNetworksConfig |
Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is: - in case of private environment: enabled with no external networks allowlisted. - in case of public environment: disabled. |
recoveryConfig |
Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
resilienceMode |
Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer. |
dataRetentionConfig |
Optional. The configuration setting for Airflow database data retention mechanism. |
SoftwareConfig
Specifies the selection and configuration of software inside the environment.
JSON representation |
---|
{ "imageVersion": string, "airflowConfigOverrides": { string: string, ... }, "pypiPackages": { string: string, ... }, "envVariables": { string: string, ... }, "pythonVersion": string, "schedulerCount": integer, "cloudDataLineageIntegration": { object ( |
Fields | |
---|---|
imageVersion |
The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also version list and versioning overview. |
airflowConfigOverrides |
Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blocked, and cannot be overridden. An object containing a list of |
pypiPackages |
Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value. An object containing a list of |
envVariables |
Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression
An object containing a list of |
pythonVersion |
Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '3'. Cannot be updated. This field is only supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. Environments in newer versions always use Python major version 3. |
schedulerCount |
Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. |
cloudDataLineageIntegration |
Optional. The configuration for Cloud Data Lineage integration. |
webServerPluginsMode |
Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. |
CloudDataLineageIntegration
Configuration for Cloud Data Lineage integration.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Optional. Whether or not Cloud Data Lineage integration is enabled. |
WebServerPluginsMode
Web server plugins mode of the Cloud Composer environment.
Enums | |
---|---|
WEB_SERVER_PLUGINS_MODE_UNSPECIFIED |
Default mode. |
PLUGINS_DISABLED |
Web server plugins are not supported. |
PLUGINS_ENABLED |
Web server plugins are supported. |
NodeConfig
The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
JSON representation |
---|
{
"location": string,
"machineType": string,
"network": string,
"subnetwork": string,
"diskSizeGb": integer,
"oauthScopes": [
string
],
"serviceAccount": string,
"tags": [
string
],
"ipAllocationPolicy": {
object ( |
Fields | |
---|---|
location |
Optional. The Compute Engine zone in which to deploy the VMs used to run the Apache Airflow software, specified as a relative resource name. For example: "projects/{projectId}/zones/{zoneId}". This This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
machineType |
Optional. The Compute Engine machine type used for cluster instances, specified as a relative resource name. For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The The If this field is unspecified, the This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
network |
Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name. For example: "projects/{projectId}/global/networks/{networkId}". If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, |
subnetwork |
Optional. The Compute Engine subnetwork to be used for machine communications, specified as a relative resource name. For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, |
diskSizeGb |
Optional. The disk size in GB used for node VMs. Minimum size is 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
oauthScopes[] |
Optional. The set of Google API scopes to be made available on all node VMs. If This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
serviceAccount |
Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. |
tags[] |
Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated. |
ipAllocationPolicy |
Optional. The configuration for controlling how IPs are allocated in the GKE cluster. |
enableIpMasqAgent |
Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent |
composerNetworkAttachment |
Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user's VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user's VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. |
composerInternalIpv4CidrBlock |
Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. |
IPAllocationPolicy
Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.
JSON representation |
---|
{ "useIpAliases": boolean, // Union field |
Fields | |
---|---|
useIpAliases |
Optional. Whether or not to enable Alias IPs in the GKE cluster. If This field is only supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. Environments in newer versions always use VPC-native GKE clusters. |
Union field cluster_ip_allocation . Configuration of allocating IP addresses for pods in the GKE cluster. cluster_ip_allocation can be only one of the following: |
|
clusterSecondaryRangeName |
Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when |
clusterIpv4CidrBlock |
Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
Union field services_ip_allocation . Configuration of allocating IP addresses for services in the GKE cluster. services_ip_allocation can be only one of the following: |
|
servicesSecondaryRangeName |
Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when |
servicesIpv4CidrBlock |
Optional. The IP address range of the services IP addresses in this GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
PrivateEnvironmentConfig
The configuration information for configuring a Private IP Cloud Composer environment.
JSON representation |
---|
{ "enablePrivateEnvironment": boolean, "enablePrivateBuildsOnly": boolean, "privateClusterConfig": { object ( |
Fields | |
---|---|
enablePrivateEnvironment |
Optional. If |
enablePrivateBuildsOnly |
Optional. If This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. |
privateClusterConfig |
Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment. |
webServerIpv4CidrBlock |
Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
cloudSqlIpv4CidrBlock |
Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from |
webServerIpv4ReservedRange |
Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
cloudComposerNetworkIpv4CidrBlock |
Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from privateClusterConfig.master_ipv4_cidr_block and cloudSqlIpv4CidrBlock. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
cloudComposerNetworkIpv4ReservedRange |
Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
enablePrivatelyUsedPublicIps |
Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for |
cloudComposerConnectionSubnetwork |
Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. |
networkingConfig |
Optional. Configuration for the network connections configuration in the environment. |
PrivateClusterConfig
Configuration options for the private GKE cluster in a Cloud Composer environment.
JSON representation |
---|
{ "enablePrivateEndpoint": boolean, "masterIpv4CidrBlock": string, "masterIpv4ReservedRange": string } |
Fields | |
---|---|
enablePrivateEndpoint |
Optional. If |
masterIpv4CidrBlock |
Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used. |
masterIpv4ReservedRange |
Output only. The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the GKE cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. |
NetworkingConfig
Configuration options for networking connections in the Composer 2 environment.
JSON representation |
---|
{
"connectionType": enum ( |
Fields | |
---|---|
connectionType |
Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. |
ConnectionType
Represents connection type between Composer environment in Customer Project and the corresponding Tenant project, from a predefined list of available connection modes.
Enums | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
No specific connection type was requested, so the environment uses the default value corresponding to the rest of its configuration. |
VPC_PEERING |
Requests the use of VPC peerings for connecting the Customer and Tenant projects. |
PRIVATE_SERVICE_CONNECT |
Requests the use of Private Service Connect for connecting the Customer and Tenant projects. |
WebServerNetworkAccessControl
Network-level access control policy for the Airflow web server.
JSON representation |
---|
{
"allowedIpRanges": [
{
object ( |
Fields | |
---|---|
allowedIpRanges[] |
A collection of allowed IP ranges with descriptions. |
AllowedIpRange
Allowed IP range with user-provided description.
JSON representation |
---|
{ "value": string, "description": string } |
Fields | |
---|---|
value |
IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: IP range prefixes should be properly truncated. For example, |
description |
Optional. User-provided description. It must contain at most 300 characters. |
DatabaseConfig
The configuration of Cloud SQL instance that is used by the Apache Airflow software.
JSON representation |
---|
{ "machineType": string, "zone": string } |
Fields | |
---|---|
machineType |
Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
zone |
Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*. |
WebServerConfig
The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*
JSON representation |
---|
{ "machineType": string } |
Fields | |
---|---|
machineType |
Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values. |
EncryptionConfig
The encryption options for the Cloud Composer environment and its dependencies.Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
JSON representation |
---|
{ "kmsKeyName": string } |
Fields | |
---|---|
kmsKeyName |
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used. |
MaintenanceWindow
The configuration settings for Cloud Composer maintenance window. The following example:
{
"startTime":"2019-08-01T01:00:00Z"
"endTime":"2019-08-01T07:00:00Z"
"recurrence":"FREQ=WEEKLY;BYDAY=TU,WE"
}
would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.
JSON representation |
---|
{ "startTime": string, "endTime": string, "recurrence": string } |
Fields | |
---|---|
startTime |
Required. Start time of the first recurrence of the maintenance window. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
recurrence |
Required. Maintenance window recurrence. Format is a subset of RFC-5545 |
WorkloadsConfig
The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.
JSON representation |
---|
{ "scheduler": { object ( |
Fields | |
---|---|
scheduler |
Optional. Resources used by Airflow schedulers. |
webServer |
Optional. Resources used by Airflow web server. |
worker |
Optional. Resources used by Airflow workers. |
triggerer |
Optional. Resources used by Airflow triggerers. |
dagProcessor |
Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. |
SchedulerResource
Configuration for resources used by Airflow schedulers.
JSON representation |
---|
{ "cpu": number, "memoryGb": number, "storageGb": number, "count": integer } |
Fields | |
---|---|
cpu |
Optional. CPU request and limit for a single Airflow scheduler replica. |
memoryGb |
Optional. Memory (GB) request and limit for a single Airflow scheduler replica. |
storageGb |
Optional. Storage (GB) request and limit for a single Airflow scheduler replica. |
count |
Optional. The number of schedulers. |
WebServerResource
Configuration for resources used by Airflow web server.
JSON representation |
---|
{ "cpu": number, "memoryGb": number, "storageGb": number } |
Fields | |
---|---|
cpu |
Optional. CPU request and limit for Airflow web server. |
memoryGb |
Optional. Memory (GB) request and limit for Airflow web server. |
storageGb |
Optional. Storage (GB) request and limit for Airflow web server. |
WorkerResource
Configuration for resources used by Airflow workers.
JSON representation |
---|
{ "cpu": number, "memoryGb": number, "storageGb": number, "minCount": integer, "maxCount": integer } |
Fields | |
---|---|
cpu |
Optional. CPU request and limit for a single Airflow worker replica. |
memoryGb |
Optional. Memory (GB) request and limit for a single Airflow worker replica. |
storageGb |
Optional. Storage (GB) request and limit for a single Airflow worker replica. |
minCount |
Optional. Minimum number of workers for autoscaling. |
maxCount |
Optional. Maximum number of workers for autoscaling. |
TriggererResource
Configuration for resources used by Airflow triggerers.
JSON representation |
---|
{ "count": integer, "cpu": number, "memoryGb": number } |
Fields | |
---|---|
count |
Optional. The number of triggerers. |
cpu |
Optional. CPU request and limit for a single Airflow triggerer replica. |
memoryGb |
Optional. Memory (GB) request and limit for a single Airflow triggerer replica. |
DagProcessorResource
Configuration for resources used by Airflow DAG processors.
This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
JSON representation |
---|
{ "cpu": number, "memoryGb": number, "storageGb": number, "count": integer } |
Fields | |
---|---|
cpu |
Optional. CPU request and limit for a single Airflow DAG processor replica. |
memoryGb |
Optional. Memory (GB) request and limit for a single Airflow DAG processor replica. |
storageGb |
Optional. Storage (GB) request and limit for a single Airflow DAG processor replica. |
count |
Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created. |
EnvironmentSize
The size of the Cloud Composer environment.
Enums | |
---|---|
ENVIRONMENT_SIZE_UNSPECIFIED |
The size of the environment is unspecified. |
ENVIRONMENT_SIZE_SMALL |
The environment size is small. |
ENVIRONMENT_SIZE_MEDIUM |
The environment size is medium. |
ENVIRONMENT_SIZE_LARGE |
The environment size is large. |
MasterAuthorizedNetworksConfig
Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
JSON representation |
---|
{
"enabled": boolean,
"cidrBlocks": [
{
object ( |
Fields | |
---|---|
enabled |
Whether or not master authorized networks feature is enabled. |
cidrBlocks[] |
Up to 50 external networks that could access Kubernetes master through HTTPS. |
CidrBlock
CIDR block with an optional name.
JSON representation |
---|
{ "displayName": string, "cidrBlock": string } |
Fields | |
---|---|
displayName |
User-defined name that identifies the CIDR block. |
cidrBlock |
CIDR block that must be specified in CIDR notation. |
RecoveryConfig
The Recovery settings of an environment.
JSON representation |
---|
{
"scheduledSnapshotsConfig": {
object ( |
Fields | |
---|---|
scheduledSnapshotsConfig |
Optional. The configuration for scheduled snapshot creation mechanism. |
ScheduledSnapshotsConfig
The configuration for scheduled snapshot creation mechanism.
JSON representation |
---|
{ "enabled": boolean, "snapshotLocation": string, "snapshotCreationSchedule": string, "timeZone": string } |
Fields | |
---|---|
enabled |
Optional. Whether scheduled snapshots creation is enabled. |
snapshotLocation |
Optional. The Cloud Storage location for storing automatically created snapshots. |
snapshotCreationSchedule |
Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution. |
timeZone |
Optional. Time zone that sets the context to interpret snapshotCreationSchedule. |
ResilienceMode
Resilience mode of the Cloud Composer Environment.
Enums | |
---|---|
RESILIENCE_MODE_UNSPECIFIED |
Default mode doesn't change environment parameters. |
HIGH_RESILIENCE |
Enabled High Resilience mode, including Cloud SQL HA. |
DataRetentionConfig
The configuration setting for Airflow database data retention mechanism.
JSON representation |
---|
{ "airflowMetadataRetentionConfig": { object ( |
Fields | |
---|---|
airflowMetadataRetentionConfig |
Optional. The retention policy for airflow metadata database. |
taskLogsRetentionConfig |
Optional. The configuration settings for task logs retention |
AirflowMetadataRetentionPolicyConfig
The policy for airflow metadata database retention.
JSON representation |
---|
{
"retentionMode": enum ( |
Fields | |
---|---|
retentionMode |
Optional. Retention can be either enabled or disabled. |
retentionDays |
Optional. How many days data should be retained for. |
RetentionMode
Describes retention policy.
Enums | |
---|---|
RETENTION_MODE_UNSPECIFIED |
Default mode doesn't change environment parameters. |
RETENTION_MODE_ENABLED |
Retention policy is enabled. |
RETENTION_MODE_DISABLED |
Retention policy is disabled. |
TaskLogsRetentionConfig
The configuration setting for Task Logs.
JSON representation |
---|
{
"storageMode": enum ( |
Fields | |
---|---|
storageMode |
Optional. The mode of storage for Airflow workers task logs. |
TaskLogsStorageMode
The definition of taskLogsStorageMode.
Enums | |
---|---|
TASK_LOGS_STORAGE_MODE_UNSPECIFIED |
This configuration is not specified by the user. |
CLOUD_LOGGING_AND_CLOUD_STORAGE |
Store task logs in Cloud Logging and in the environment's Cloud Storage bucket. |
CLOUD_LOGGING_ONLY |
Store task logs in Cloud Logging only. |
State
State of the environment.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state of the environment is unknown. |
CREATING |
The environment is in the process of being created. |
RUNNING |
The environment is currently running and healthy. It is ready for use. |
UPDATING |
The environment is being updated. It remains usable but cannot receive additional update requests or be deleted at this time. |
DELETING |
The environment is undergoing deletion. It cannot be used. |
ERROR |
The environment has encountered an error and cannot be used. |
StorageConfig
The configuration for data storage in the environment.
JSON representation |
---|
{ "bucket": string } |
Fields | |
---|---|
bucket |
Optional. The name of the Cloud Storage bucket used by the environment. No |
Methods |
|
---|---|
|
Check if an upgrade operation on the environment will succeed. |
|
Create a new environment. |
|
Triggers database failover (only for highly resilient environments). |
|
Delete an environment. |
|
Executes Airflow CLI command. |
|
Fetches database properties. |
|
Get an existing environment. |
|
List environments. |
|
Loads a snapshot of a Cloud Composer environment. |
|
Update an environment. |
|
Polls Airflow CLI command execution and fetches logs. |
|
Creates a snapshots of a Cloud Composer environment. |
|
Stops Airflow CLI command execution. |