Index
Environments
(interface)ImageVersions
(interface)AirflowMetadataRetentionPolicyConfig
(message)AirflowMetadataRetentionPolicyConfig.RetentionMode
(enum)CheckUpgradeRequest
(message)CheckUpgradeResponse
(message)CheckUpgradeResponse.ConflictResult
(enum)CloudDataLineageIntegration
(message)CreateEnvironmentRequest
(message)CreateUserWorkloadsConfigMapRequest
(message)CreateUserWorkloadsSecretRequest
(message)DataRetentionConfig
(message)DatabaseConfig
(message)DatabaseFailoverRequest
(message)DatabaseFailoverResponse
(message)DeleteEnvironmentRequest
(message)DeleteUserWorkloadsConfigMapRequest
(message)DeleteUserWorkloadsSecretRequest
(message)EncryptionConfig
(message)Environment
(message)Environment.State
(enum)EnvironmentConfig
(message)EnvironmentConfig.EnvironmentSize
(enum)EnvironmentConfig.ResilienceMode
(enum)ExecuteAirflowCommandRequest
(message)ExecuteAirflowCommandResponse
(message)FetchDatabasePropertiesRequest
(message)FetchDatabasePropertiesResponse
(message)GetEnvironmentRequest
(message)GetUserWorkloadsConfigMapRequest
(message)GetUserWorkloadsSecretRequest
(message)IPAllocationPolicy
(message)ImageVersion
(message)ListEnvironmentsRequest
(message)ListEnvironmentsResponse
(message)ListImageVersionsRequest
(message)ListImageVersionsResponse
(message)ListUserWorkloadsConfigMapsRequest
(message)ListUserWorkloadsConfigMapsResponse
(message)ListUserWorkloadsSecretsRequest
(message)ListUserWorkloadsSecretsResponse
(message)ListWorkloadsRequest
(message)ListWorkloadsResponse
(message)ListWorkloadsResponse.ComposerWorkload
(message)ListWorkloadsResponse.ComposerWorkloadState
(enum)ListWorkloadsResponse.ComposerWorkloadStatus
(message)ListWorkloadsResponse.ComposerWorkloadType
(enum)LoadSnapshotRequest
(message)LoadSnapshotResponse
(message)MaintenanceWindow
(message)MasterAuthorizedNetworksConfig
(message)MasterAuthorizedNetworksConfig.CidrBlock
(message)NetworkingConfig
(message)NetworkingConfig.ConnectionType
(enum)NodeConfig
(message)OperationMetadata
(message)OperationMetadata.State
(enum)OperationMetadata.Type
(enum)PollAirflowCommandRequest
(message)PollAirflowCommandResponse
(message)PollAirflowCommandResponse.ExitInfo
(message)PollAirflowCommandResponse.Line
(message)PrivateClusterConfig
(message)PrivateEnvironmentConfig
(message)RecoveryConfig
(message)RestartWebServerRequest
(message)SaveSnapshotRequest
(message)SaveSnapshotResponse
(message)ScheduledSnapshotsConfig
(message)SoftwareConfig
(message)SoftwareConfig.WebServerPluginsMode
(enum)StopAirflowCommandRequest
(message)StopAirflowCommandResponse
(message)StorageConfig
(message)TaskLogsRetentionConfig
(message)TaskLogsRetentionConfig.TaskLogsStorageMode
(enum)UpdateEnvironmentRequest
(message)UpdateUserWorkloadsConfigMapRequest
(message)UpdateUserWorkloadsSecretRequest
(message)UserWorkloadsConfigMap
(message)UserWorkloadsSecret
(message)WebServerConfig
(message)WebServerNetworkAccessControl
(message)WebServerNetworkAccessControl.AllowedIpRange
(message)WorkloadsConfig
(message)WorkloadsConfig.DagProcessorResource
(message)WorkloadsConfig.SchedulerResource
(message)WorkloadsConfig.TriggererResource
(message)WorkloadsConfig.WebServerResource
(message)WorkloadsConfig.WorkerResource
(message)
Environments
Managed Apache Airflow Environments.
CheckUpgrade |
---|
Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.
|
CreateEnvironment |
---|
Create a new environment.
|
CreateUserWorkloadsConfigMap |
---|
Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
CreateUserWorkloadsSecret |
---|
Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
DatabaseFailover |
---|
Triggers database failover (only for highly resilient environments).
|
DeleteEnvironment |
---|
Delete an environment.
|
DeleteUserWorkloadsConfigMap |
---|
Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
DeleteUserWorkloadsSecret |
---|
Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
ExecuteAirflowCommand |
---|
Executes Airflow CLI command.
|
FetchDatabaseProperties |
---|
Fetches database properties.
|
GetEnvironment |
---|
Get an existing environment.
|
GetUserWorkloadsConfigMap |
---|
Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
GetUserWorkloadsSecret |
---|
Gets an existing user workloads Secret. Values of the "data" field in the response are cleared. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
ListEnvironments |
---|
List environments.
|
ListUserWorkloadsConfigMaps |
---|
Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
ListUserWorkloadsSecrets |
---|
Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
ListWorkloads |
---|
Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
LoadSnapshot |
---|
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.
|
PollAirflowCommand |
---|
Polls Airflow CLI command execution and fetches logs.
|
RestartWebServer |
---|
Restart Airflow web server.
|
SaveSnapshot |
---|
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.
|
StopAirflowCommand |
---|
Stops Airflow CLI command execution.
|
UpdateEnvironment |
---|
Update an environment.
|
UpdateUserWorkloadsConfigMap |
---|
Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
UpdateUserWorkloadsSecret |
---|
Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
|
ImageVersions
Readonly service to query available ImageVersions.
ListImageVersions |
---|
List ImageVersions for provided location.
|
AirflowMetadataRetentionPolicyConfig
The policy for airflow metadata database retention.
Fields | |
---|---|
retention_mode |
Optional. Retention can be either enabled or disabled. |
retention_days |
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. |
CheckUpgradeRequest
Request to check whether image upgrade will succeed.
Fields | |
---|---|
environment |
The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
image_version |
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. |
CheckUpgradeResponse
Message containing information about the result of an upgrade check operation.
Fields | |
---|---|
build_log_uri |
Output only. Url for a docker build log of an upgraded image. |
contains_pypi_modules_conflict |
Output only. Whether build has succeeded or failed on modules conflicts. |
pypi_conflict_build_log_extract |
Output only. Extract from a docker image build log containing information about pypi modules conflicts. |
image_version |
Composer image for which the build was happening. |
pypi_dependencies |
Pypi dependencies specified in the environment configuration, at the time when the build was triggered. |
ConflictResult
Whether there were python modules conflict during image build.
Enums | |
---|---|
CONFLICT_RESULT_UNSPECIFIED |
It is unknown whether build had conflicts or not. |
CONFLICT |
There were python packages conflicts. |
NO_CONFLICT |
There were no python packages conflicts. |
CloudDataLineageIntegration
Configuration for Cloud Data Lineage integration.
Fields | |
---|---|
enabled |
Optional. Whether or not Cloud Data Lineage integration is enabled. |
CreateEnvironmentRequest
Create a new environment.
Fields | |
---|---|
parent |
The parent must be of the form "projects/{projectId}/locations/{locationId}". Authorization requires the following IAM permission on the specified resource
|
environment |
The environment to create. |
CreateUserWorkloadsConfigMapRequest
Create user workloads ConfigMap request.
Fields | |
---|---|
parent |
Required. The environment name to create a ConfigMap for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
user_workloads_config_map |
Required. User workloads ConfigMap to create. |
CreateUserWorkloadsSecretRequest
Create user workloads Secret request.
Fields | |
---|---|
parent |
Required. The environment name to create a Secret for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
user_workloads_secret |
Required. User workloads Secret to create. |
DataRetentionConfig
The configuration setting for Airflow database data retention mechanism.
Fields | |
---|---|
airflow_database_retention_days |
Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0. |
task_logs_retention_config |
Optional. The configuration settings for task logs retention |
airflow_metadata_retention_config |
Optional. The retention policy for airflow metadata database. |
DatabaseConfig
The configuration of Cloud SQL instance that is used by the Apache Airflow software.
Fields | |
---|---|
machine_type |
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-*.*.*. |
DatabaseFailoverRequest
Request to trigger database failover (only for highly resilient environments).
Fields | |
---|---|
environment |
Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
DatabaseFailoverResponse
This type has no fields.
Response for DatabaseFailoverRequest.
DeleteEnvironmentRequest
Delete an environment.
Fields | |
---|---|
name |
The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
DeleteUserWorkloadsConfigMapRequest
Delete user workloads ConfigMap request.
Fields | |
---|---|
name |
Required. The ConfigMap to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}" Authorization requires the following IAM permission on the specified resource
|
DeleteUserWorkloadsSecretRequest
Delete user workloads Secret request.
Fields | |
---|---|
name |
Required. The Secret to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" Authorization requires the following IAM permission on the specified resource
|
EncryptionConfig
The encryption options for the Cloud Composer environment and its dependencies. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
Fields | |
---|---|
kms_key_name |
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used. |
Environment
An environment for running orchestration tasks.
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. |
create_time |
Output only. The time at which this environment was created. |
update_time |
Output only. The time at which this environment was last modified. |
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:
|
satisfies_pzs |
Output only. Reserved for future use. |
satisfies_pzi |
Output only. Reserved for future use. |
storage_config |
Optional. Storage configuration for this environment. |
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. |
EnvironmentConfig
Configuration information for an environment.
Fields | |
---|---|
gke_cluster |
Output only. The Kubernetes Engine cluster used to run this environment. |
dag_gcs_prefix |
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. |
node_count |
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-*.*.*. |
software_config |
The configuration settings for software inside the environment. |
node_config |
The configuration used for the Kubernetes Engine cluster. |
private_environment_config |
The configuration used for the Private IP Cloud Composer environment. |
web_server_network_access_control |
Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied. |
database_config |
Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software. |
web_server_config |
Optional. The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
airflow_uri |
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface). |
airflow_byoid_uri |
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). |
encryption_config |
Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated. |
maintenance_window |
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. |
workloads_config |
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. |
environment_size |
Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
master_authorized_networks_config |
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. |
recovery_config |
Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
data_retention_config |
Optional. The configuration setting for Airflow database data retention mechanism. |
resilience_mode |
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. |
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. |
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. |
ExecuteAirflowCommandRequest
Execute Airflow Command request.
Fields | |
---|---|
environment |
The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". Authorization requires the following IAM permission on the specified resource
|
command |
Airflow command. |
subcommand |
Airflow subcommand. |
parameters[] |
Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like |
ExecuteAirflowCommandResponse
Response to ExecuteAirflowCommandRequest.
Fields | |
---|---|
execution_id |
The unique ID of the command execution for polling. |
pod |
The name of the pod where the command is executed. |
pod_namespace |
The namespace of the pod where the command is executed. |
error |
Error message. Empty if there was no error. |
FetchDatabasePropertiesRequest
Request to fetch properties of environment's database.
Fields | |
---|---|
environment |
Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
FetchDatabasePropertiesResponse
Response for FetchDatabasePropertiesRequest.
Fields | |
---|---|
primary_gce_zone |
The Compute Engine zone that the instance is currently serving from. |
secondary_gce_zone |
The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance. |
is_failover_replica_available |
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true. |
GetEnvironmentRequest
Get an environment.
Fields | |
---|---|
name |
The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
GetUserWorkloadsConfigMapRequest
Get user workloads ConfigMap request.
Fields | |
---|---|
name |
Required. The resource name of the ConfigMap to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}" Authorization requires the following IAM permission on the specified resource
|
GetUserWorkloadsSecretRequest
Get user workloads Secret request.
Fields | |
---|---|
name |
Required. The resource name of the Secret to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" Authorization requires the following IAM permission on the specified resource
|
IPAllocationPolicy
Configuration for controlling how IPs are allocated in the GKE cluster.
Fields | |
---|---|
use_ip_aliases |
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. |
cluster_secondary_range_name |
Optional. The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when |
services_secondary_range_name |
Optional. The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when |
cluster_ipv4_cidr_block |
Optional. The IP address range used to allocate IP addresses to pods in the 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. |
services_ipv4_cidr_block |
Optional. The IP address range of the services IP addresses in this 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. |
ImageVersion
Image Version information
Fields | |
---|---|
image_version_id |
The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b.c" |
is_default |
Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. |
supported_python_versions[] |
supported python versions |
release_date |
The date of the version release. |
creation_disabled |
Whether it is impossible to create an environment with the image version. |
upgrade_disabled |
Whether it is impossible to upgrade an environment running with the image version. |
ListEnvironmentsRequest
List environments in a project and location.
Fields | |
---|---|
parent |
List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of environments to return. |
page_token |
The next_page_token value returned from a previous List request, if any. |
ListEnvironmentsResponse
The environments in a project and location.
Fields | |
---|---|
environments[] |
The list of environments returned by a ListEnvironmentsRequest. |
next_page_token |
The page token used to query for the next page if one exists. |
ListImageVersionsRequest
List ImageVersions in a project and location.
Fields | |
---|---|
parent |
List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of image_versions to return. |
page_token |
The next_page_token value returned from a previous List request, if any. |
include_past_releases |
Whether or not image versions from old releases should be included. |
ListImageVersionsResponse
The ImageVersions in a project and location.
Fields | |
---|---|
image_versions[] |
The list of supported ImageVersions in a location. |
next_page_token |
The page token used to query for the next page if one exists. |
ListUserWorkloadsConfigMapsRequest
List user workloads ConfigMaps request.
Fields | |
---|---|
parent |
Required. List ConfigMaps in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of ConfigMaps to return. |
page_token |
Optional. The next_page_token value returned from a previous List request, if any. |
ListUserWorkloadsConfigMapsResponse
The user workloads ConfigMaps for a given environment.
Fields | |
---|---|
user_workloads_config_maps[] |
The list of ConfigMaps returned by a ListUserWorkloadsConfigMapsRequest. |
next_page_token |
The page token used to query for the next page if one exists. |
ListUserWorkloadsSecretsRequest
List user workloads Secrets request.
Fields | |
---|---|
parent |
Required. List Secrets in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of Secrets to return. |
page_token |
Optional. The next_page_token value returned from a previous List request, if any. |
ListUserWorkloadsSecretsResponse
The user workloads Secrets for a given environment.
Fields | |
---|---|
user_workloads_secrets[] |
The list of Secrets returned by a ListUserWorkloadsSecretsRequest. |
next_page_token |
The page token used to query for the next page if one exists. |
ListWorkloadsRequest
Request for listing workloads in a Cloud Composer environment.
Fields | |
---|---|
parent |
Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of environments to return. |
page_token |
Optional. The next_page_token value returned from a previous List request, if any. |
filter |
Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned. |
ListWorkloadsResponse
Response to ListWorkloadsRequest.
Fields | |
---|---|
workloads[] |
The list of environment workloads. |
next_page_token |
The page token used to query for the next page if one exists. |
ComposerWorkload
Information about a single workload.
Fields | |
---|---|
name |
Name of a workload. |
type |
Type of a workload. |
status |
Output only. Status of a workload. |
ComposerWorkloadState
Workload states.
Enums | |
---|---|
COMPOSER_WORKLOAD_STATE_UNSPECIFIED |
Not able to determine the status of the workload. |
PENDING |
Workload is in pending state and has not yet started. |
OK |
Workload is running fine. |
WARNING |
Workload is running but there are some non-critical problems. |
ERROR |
Workload is not running due to an error. |
SUCCEEDED |
Workload has finished execution with success. |
FAILED |
Workload has finished execution with failure. |
ComposerWorkloadStatus
Workload status.
Fields | |
---|---|
state |
Output only. Workload state. |
status_message |
Output only. Text to provide more descriptive status. |
detailed_status_message |
Output only. Detailed message of the status. |
ComposerWorkloadType
Supported workload types.
Enums | |
---|---|
COMPOSER_WORKLOAD_TYPE_UNSPECIFIED |
Not able to determine the type of the workload. |
CELERY_WORKER |
Celery worker. |
KUBERNETES_WORKER |
Kubernetes worker. |
KUBERNETES_OPERATOR_POD |
Workload created by Kubernetes Pod Operator. |
SCHEDULER |
Airflow scheduler. |
DAG_PROCESSOR |
Airflow Dag processor. |
TRIGGERER |
Airflow triggerer. |
WEB_SERVER |
Airflow web server UI. |
REDIS |
Redis. |
LoadSnapshotRequest
Request to load a snapshot into a Cloud Composer environment.
Fields | |
---|---|
environment |
The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
snapshot_path |
A Cloud Storage path to a snapshot to load, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". |
skip_pypi_packages_installation |
Whether or not to skip installing Pypi packages when loading the environment's state. |
skip_environment_variables_setting |
Whether or not to skip setting environment variables when loading the environment's state. |
skip_airflow_overrides_setting |
Whether or not to skip setting Airflow overrides when loading the environment's state. |
skip_gcs_data_copying |
Whether or not to skip copying Cloud Storage data when loading the environment's state. |
LoadSnapshotResponse
This type has no fields.
Response to LoadSnapshotRequest.
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.
Fields | |
---|---|
start_time |
Required. Start time of the first recurrence of the maintenance window. |
end_time |
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 |
recurrence |
Required. Maintenance window recurrence. Format is a subset of RFC-5545 |
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.
Fields | |
---|---|
enabled |
Whether or not master authorized networks feature is enabled. |
cidr_blocks[] |
Up to 50 external networks that could access Kubernetes master through HTTPS. |
CidrBlock
CIDR block with an optional name.
Fields | |
---|---|
display_name |
User-defined name that identifies the CIDR block. |
cidr_block |
CIDR block that must be specified in CIDR notation. |
NetworkingConfig
Configuration options for networking connections in the Composer 2 environment.
Fields | |
---|---|
connection_type |
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. |
NodeConfig
The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
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-*.*.*. |
machine_type |
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 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, |
disk_size_gb |
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-*.*.*. |
oauth_scopes[] |
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-*.*.*. |
service_account |
Optional. The Google Cloud Platform Service Account to be used by the workloads. 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. |
ip_allocation_policy |
Optional. The IPAllocationPolicy fields for the GKE cluster. |
max_pods_per_node |
Optional. The maximum number of pods per node in the Cloud Composer GKE cluster. The value must be between 8 and 110 and it can be set only if the environment is VPC-native. The default value is 32. Values of this field will be propagated both to the This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
enable_ip_masq_agent |
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 |
composer_network_attachment |
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. |
composer_internal_ipv4_cidr_block |
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. |
OperationMetadata
Metadata describing an operation.
Fields | |
---|---|
state |
Output only. The current operation state. |
operation_type |
Output only. The type of operation being performed. |
resource |
Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name). |
resource_uuid |
Output only. The UUID of the resource being operated on. |
create_time |
Output only. The time the operation was submitted to the server. |
end_time |
Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing. |
State
An enum describing the overall state of an operation.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unused. |
PENDING |
The operation has been created but is not yet started. |
RUNNING |
The operation is underway. |
SUCCESSFUL |
The operation completed successfully. |
FAILED |
The operation is no longer running but did not succeed. |
Type
Type of longrunning operation.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unused. |
CREATE |
A resource creation operation. |
DELETE |
A resource deletion operation. |
UPDATE |
A resource update operation. |
CHECK |
A resource check operation. |
SAVE_SNAPSHOT |
Saves snapshot of the resource operation. |
LOAD_SNAPSHOT |
Loads snapshot of the resource operation. |
DATABASE_FAILOVER |
Triggers failover of environment's Cloud SQL instance (only for highly resilient environments). |
PollAirflowCommandRequest
Poll Airflow Command request.
Fields | |
---|---|
environment |
The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
execution_id |
The unique ID of the command execution. |
pod |
The name of the pod where the command is executed. |
pod_namespace |
The namespace of the pod where the command is executed. |
next_line_number |
Line number from which new logs should be fetched. |
PollAirflowCommandResponse
Response to PollAirflowCommandRequest.
Fields | |
---|---|
output[] |
Output from the command execution. It may not contain the full output and the caller may need to poll for more lines. |
output_end |
Whether the command execution has finished and there is no more output. |
exit_info |
The result exit status of the command. |
ExitInfo
Information about how a command ended.
Fields | |
---|---|
exit_code |
The exit code from the command execution. |
error |
Error message. Empty if there was no error. |
Line
Contains information about a single line from logs.
Fields | |
---|---|
line_number |
Number of the line. |
content |
Text content of the log line. |
PrivateClusterConfig
Configuration options for the private GKE cluster in a Cloud Composer environment.
Fields | |
---|---|
enable_private_endpoint |
Optional. If |
master_ipv4_cidr_block |
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. |
master_ipv4_reserved_range |
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 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. |
PrivateEnvironmentConfig
The configuration information for configuring a Private IP Cloud Composer environment.
Fields | |
---|---|
enable_private_environment |
Optional. If |
enable_private_builds_only |
Optional. If This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. |
private_cluster_config |
Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment. |
web_server_ipv4_cidr_block |
Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. |
cloud_sql_ipv4_cidr_block |
Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block |
web_server_ipv4_reserved_range |
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-*.*.*. |
cloud_composer_network_ipv4_cidr_block |
Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. |
cloud_composer_network_ipv4_reserved_range |
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. |
enable_privately_used_public_ips |
Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for |
cloud_composer_connection_subnetwork |
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. |
networking_config |
Optional. Configuration for the network connections configuration in the environment. |
RecoveryConfig
The Recovery settings of an environment.
Fields | |
---|---|
scheduled_snapshots_config |
Optional. The configuration for scheduled snapshot creation mechanism. |
RestartWebServerRequest
Restart Airflow web server.
Fields | |
---|---|
name |
The resource name of the environment to restart the web server for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
SaveSnapshotRequest
Request to create a snapshot of a Cloud Composer environment.
Fields | |
---|---|
environment |
The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
snapshot_location |
Location in a Cloud Storage where the snapshot is going to be stored, e.g.: "gs://my-bucket/snapshots". |
SaveSnapshotResponse
Response to SaveSnapshotRequest.
Fields | |
---|---|
snapshot_path |
The fully-resolved Cloud Storage path of the created snapshot, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". This field is populated only if the snapshot creation was successful. |
ScheduledSnapshotsConfig
The configuration for scheduled snapshot creation mechanism.
Fields | |
---|---|
enabled |
Optional. Whether scheduled snapshots creation is enabled. |
snapshot_location |
Optional. The Cloud Storage location for storing automatically created snapshots. |
snapshot_creation_schedule |
Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution. |
time_zone |
Optional. Time zone that sets the context to interpret snapshot_creation_schedule. |
SoftwareConfig
Specifies the selection and configuration of software inside the environment.
Fields | |
---|---|
image_version |
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. |
airflow_config_overrides |
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. |
pypi_packages |
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. |
env_variables |
Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression
|
python_version |
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. |
scheduler_count |
Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. |
cloud_data_lineage_integration |
Optional. The configuration for Cloud Data Lineage integration. |
web_server_plugins_mode |
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. |
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. |
StopAirflowCommandRequest
Stop Airflow Command request.
Fields | |
---|---|
environment |
The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". Authorization requires the following IAM permission on the specified resource
|
execution_id |
The unique ID of the command execution. |
pod |
The name of the pod where the command is executed. |
pod_namespace |
The namespace of the pod where the command is executed. |
force |
If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup. |
StopAirflowCommandResponse
Response to StopAirflowCommandRequest.
Fields | |
---|---|
is_done |
Whether the execution is still running. |
output[] |
Output message from stopping execution request. |
StorageConfig
The configuration for data storage in the environment.
Fields | |
---|---|
bucket |
Optional. The name of the Cloud Storage bucket used by the environment. No |
TaskLogsRetentionConfig
The configuration setting for Task Logs.
Fields | |
---|---|
storage_mode |
Optional. The mode of storage for Airflow workers task logs. |
TaskLogsStorageMode
The definition of task_logs_storage_mode.
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. |
UpdateEnvironmentRequest
Update an environment.
Fields | |
---|---|
name |
The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Authorization requires the following IAM permission on the specified resource
|
environment |
A patch environment. Fields specified by the |
update_mask |
Required. A comma-separated list of paths, relative to
Note that in the above example, any existing PyPI packages other than scikit-learn and argparse will be unaffected. Only one update type may be included in a single request's
Note that in the above example, any existing labels that are not included in the It is also possible to replace an entire map field by providing the map field's path in the
Note: Only the following fields can be updated:
|
UpdateUserWorkloadsConfigMapRequest
Update user workloads ConfigMap request.
Fields | |
---|---|
user_workloads_config_map |
Optional. User workloads ConfigMap to override. |
UpdateUserWorkloadsSecretRequest
Update user workloads Secret request.
Fields | |
---|---|
user_workloads_secret |
Optional. User workloads Secret to override. |
UserWorkloadsConfigMap
User workloads ConfigMap used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.
Fields | |
---|---|
name |
Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}" |
data |
Optional. The "data" field of Kubernetes ConfigMap, organized in key-value pairs. For details see: https://kubernetes.io/docs/concepts/configuration/configmap/ |
UserWorkloadsSecret
User workloads Secret used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.
Fields | |
---|---|
name |
Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" |
data |
Optional. The "data" field of Kubernetes Secret, organized in key-value pairs, which can contain sensitive values such as a password, a token, or a key. The values for all keys have to be base64-encoded strings. For details see: https://kubernetes.io/docs/concepts/configuration/secret/ |
WebServerConfig
The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
Fields | |
---|---|
machine_type |
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. |
WebServerNetworkAccessControl
Network-level access control policy for the Airflow web server.
Fields | |
---|---|
allowed_ip_ranges[] |
A collection of allowed IP ranges with descriptions. |
AllowedIpRange
Allowed IP range with user-provided description.
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. |
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.
Fields | |
---|---|
scheduler |
Optional. Resources used by Airflow schedulers. |
web_server |
Optional. Resources used by Airflow web server. |
worker |
Optional. Resources used by Airflow workers. |
triggerer |
Optional. Resources used by Airflow triggerers. |
dag_processor |
Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. |
DagProcessorResource
Configuration for resources used by Airflow DAG processors.
This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
Fields | |
---|---|
cpu |
Optional. CPU request and limit for a single Airflow DAG processor replica. |
memory_gb |
Optional. Memory (GB) request and limit for a single Airflow DAG processor replica. |
storage_gb |
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. |
SchedulerResource
Configuration for resources used by Airflow schedulers.
Fields | |
---|---|
cpu |
Optional. CPU request and limit for a single Airflow scheduler replica. |
memory_gb |
Optional. Memory (GB) request and limit for a single Airflow scheduler replica. |
storage_gb |
Optional. Storage (GB) request and limit for a single Airflow scheduler replica. |
count |
Optional. The number of schedulers. |
TriggererResource
Configuration for resources used by Airflow triggerers.
Fields | |
---|---|
count |
Optional. The number of triggerers. |
cpu |
Optional. CPU request and limit for a single Airflow triggerer replica. |
memory_gb |
Optional. Memory (GB) request and limit for a single Airflow triggerer replica. |
WebServerResource
Configuration for resources used by Airflow web server.
Fields | |
---|---|
cpu |
Optional. CPU request and limit for Airflow web server. |
memory_gb |
Optional. Memory (GB) request and limit for Airflow web server. |
storage_gb |
Optional. Storage (GB) request and limit for Airflow web server. |
WorkerResource
Configuration for resources used by Airflow workers.
Fields | |
---|---|
cpu |
Optional. CPU request and limit for a single Airflow worker replica. |
memory_gb |
Optional. Memory (GB) request and limit for a single Airflow worker replica. |
storage_gb |
Optional. Storage (GB) request and limit for a single Airflow worker replica. |
min_count |
Optional. Minimum number of workers for autoscaling. |
max_count |
Optional. Maximum number of workers for autoscaling. |