Types for Google Cloud Orchestration Airflow Service v1 API¶
- class google.cloud.orchestration.airflow.service_v1.types.AirflowMetadataRetentionPolicyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe policy for airflow metadata database retention.
- retention_mode¶
Optional. Retention can be either enabled or disabled.
- class RetentionMode(value)[source]¶
Bases:
proto.enums.EnumDescribes retention policy.
- Values:
- RETENTION_MODE_UNSPECIFIED (0):
Default mode doesn’t change environment parameters.
- RETENTION_MODE_ENABLED (1):
Retention policy is enabled.
- RETENTION_MODE_DISABLED (2):
Retention policy is disabled.
- class google.cloud.orchestration.airflow.service_v1.types.CheckUpgradeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to check whether image upgrade will succeed.
- environment¶
Required. The resource name of the environment to check upgrade for, in the form:
“projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- image_version¶
Optional. 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
composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?). When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version.The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or
latest. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias.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.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.CheckUpgradeResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage containing information about the result of an upgrade check operation.
- 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.
- Type
- pypi_dependencies¶
Pypi dependencies specified in the environment configuration, at the time when the build was triggered.
- class ConflictResult(value)[source]¶
Bases:
proto.enums.EnumWhether there were python modules conflict during image build.
- Values:
- CONFLICT_RESULT_UNSPECIFIED (0):
It is unknown whether build had conflicts or not.
- CONFLICT (1):
There were python packages conflicts.
- NO_CONFLICT (2):
There were no python packages conflicts.
- class PypiDependenciesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.orchestration.airflow.service_v1.types.CloudDataLineageIntegration(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for Cloud Data Lineage integration.
- class google.cloud.orchestration.airflow.service_v1.types.CreateEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreate a new environment.
- environment¶
The environment to create.
- class google.cloud.orchestration.airflow.service_v1.types.CreateUserWorkloadsConfigMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreate user workloads ConfigMap request.
- parent¶
Required. The environment name to create a ConfigMap for, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- user_workloads_config_map¶
Required. User workloads ConfigMap to create.
- class google.cloud.orchestration.airflow.service_v1.types.CreateUserWorkloadsSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreate user workloads Secret request.
- parent¶
Required. The environment name to create a Secret for, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- user_workloads_secret¶
Required. User workloads Secret to create.
- class google.cloud.orchestration.airflow.service_v1.types.DataRetentionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration setting for Airflow database data retention mechanism.
- airflow_metadata_retention_config¶
Optional. The retention policy for airflow metadata database.
- task_logs_retention_config¶
Optional. The configuration settings for task logs retention
- class google.cloud.orchestration.airflow.service_v1.types.DatabaseConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration of Cloud SQL instance that is used by the Apache Airflow software.
- 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-..*.
- Type
- 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-..*.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.DatabaseFailoverRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to trigger database failover (only for highly resilient environments).
- class google.cloud.orchestration.airflow.service_v1.types.DatabaseFailoverResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for DatabaseFailoverRequest.
- class google.cloud.orchestration.airflow.service_v1.types.DeleteEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDelete an environment.
- class google.cloud.orchestration.airflow.service_v1.types.DeleteUserWorkloadsConfigMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDelete user workloads ConfigMap request.
- class google.cloud.orchestration.airflow.service_v1.types.DeleteUserWorkloadsSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDelete user workloads Secret request.
- class google.cloud.orchestration.airflow.service_v1.types.EncryptionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe encryption options for the Cloud Composer environment and its dependencies.Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- class google.cloud.orchestration.airflow.service_v1.types.Environment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn environment for running orchestration tasks.
- 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.
- Type
- 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.
- Type
- 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:
Keys must conform to regexp: [p{Ll}p{Lo}][p{Ll}p{Lo}p{N}_-]{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.
- storage_config¶
Optional. Storage configuration for this environment.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumState of the environment.
- Values:
- STATE_UNSPECIFIED (0):
The state of the environment is unknown.
- CREATING (1):
The environment is in the process of being created.
- RUNNING (2):
The environment is currently running and healthy. It is ready for use.
- UPDATING (3):
The environment is being updated. It remains usable but cannot receive additional update requests or be deleted at this time.
- DELETING (4):
The environment is undergoing deletion. It cannot be used.
- ERROR (5):
The environment has encountered an error and cannot be used.
- class google.cloud.orchestration.airflow.service_v1.types.EnvironmentConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration information for an 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.
- Type
- 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-..*.
- Type
- 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.
- 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.
- airflow_uri¶
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
- Type
- 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).
- Type
- 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.
- 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.
- data_retention_config¶
Optional. The configuration setting for Airflow database data retention mechanism.
- class EnvironmentSize(value)[source]¶
Bases:
proto.enums.EnumThe size of the Cloud Composer environment.
- Values:
- ENVIRONMENT_SIZE_UNSPECIFIED (0):
The size of the environment is unspecified.
- ENVIRONMENT_SIZE_SMALL (1):
The environment size is small.
- ENVIRONMENT_SIZE_MEDIUM (2):
The environment size is medium.
- ENVIRONMENT_SIZE_LARGE (3):
The environment size is large.
- class ResilienceMode(value)[source]¶
Bases:
proto.enums.EnumResilience mode of the Cloud Composer Environment.
- Values:
- RESILIENCE_MODE_UNSPECIFIED (0):
Default mode doesn’t change environment parameters.
- HIGH_RESILIENCE (1):
Enabled High Resilience mode, including Cloud SQL HA.
- class google.cloud.orchestration.airflow.service_v1.types.ExecuteAirflowCommandRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExecute Airflow Command request.
- environment¶
The resource name of the environment in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.ExecuteAirflowCommandResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to ExecuteAirflowCommandRequest.
- class google.cloud.orchestration.airflow.service_v1.types.FetchDatabasePropertiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to fetch properties of environment’s database.
- class google.cloud.orchestration.airflow.service_v1.types.FetchDatabasePropertiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for FetchDatabasePropertiesRequest.
- secondary_gce_zone¶
The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.GetEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGet an environment.
- class google.cloud.orchestration.airflow.service_v1.types.GetUserWorkloadsConfigMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGet user workloads ConfigMap request.
- class google.cloud.orchestration.airflow.service_v1.types.GetUserWorkloadsSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGet user workloads Secret request.
- class google.cloud.orchestration.airflow.service_v1.types.IPAllocationPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- use_ip_aliases¶
Optional. Whether or not to enable Alias IPs in the GKE cluster. If
true, a VPC-native cluster is created.This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
- Type
- cluster_secondary_range_name¶
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
use_ip_aliasesis true.This field is a member of oneof
cluster_ip_allocation.- Type
- cluster_ipv4_cidr_block¶
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
use_ip_aliasesis true.Set to blank to have GKE choose a range with the default size.
Set to /netmask (e.g.
/14) to have GKE choose a range with a specific netmask.Set to a CIDR notation (e.g.
10.96.0.0/14) from the RFC-1918 private networks (e.g.10.0.0.0/8,172.16.0.0/12,192.168.0.0/16) to pick a specific range to use.This field is a member of oneof
cluster_ip_allocation.- Type
- services_secondary_range_name¶
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
use_ip_aliasesis true.This field is a member of oneof
services_ip_allocation.- Type
- services_ipv4_cidr_block¶
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
use_ip_aliasesis true.Set to blank to have GKE choose a range with the default size.
Set to /netmask (e.g.
/14) to have GKE choose a range with a specific netmask.Set to a CIDR notation (e.g.
10.96.0.0/14) from the RFC-1918 private networks (e.g.10.0.0.0/8,172.16.0.0/12,192.168.0.0/16) to pick a specific range to use.This field is a member of oneof
services_ip_allocation.- Type
- class google.cloud.orchestration.airflow.service_v1.types.ImageVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageImageVersion information
- image_version_id¶
The string identifier of the ImageVersion, in the form: “composer-x.y.z-airflow-a.b.c”.
- Type
- is_default¶
Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified.
- Type
- release_date¶
The date of the version release.
- Type
google.type.date_pb2.Date
- creation_disabled¶
Whether it is impossible to create an environment with the image version.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.ListEnvironmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList environments in a project and location.
- parent¶
List environments in the given project and location, in the form: “projects/{projectId}/locations/{locationId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.ListEnvironmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe environments in a project and location.
- environments¶
The list of environments returned by a ListEnvironmentsRequest.
- Type
MutableSequence[google.cloud.orchestration.airflow.service_v1.types.Environment]
- class google.cloud.orchestration.airflow.service_v1.types.ListImageVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList ImageVersions in a project and location.
- parent¶
List ImageVersions in the given project and location, in the form: “projects/{projectId}/locations/{locationId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.ListImageVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe ImageVersions in a project and location.
- image_versions¶
The list of supported ImageVersions in a location.
- Type
MutableSequence[google.cloud.orchestration.airflow.service_v1.types.ImageVersion]
- class google.cloud.orchestration.airflow.service_v1.types.ListUserWorkloadsConfigMapsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList user workloads ConfigMaps request.
- parent¶
Required. List ConfigMaps in the given environment, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.ListUserWorkloadsConfigMapsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe user workloads ConfigMaps for a given environment.
- user_workloads_config_maps¶
The list of ConfigMaps returned by a ListUserWorkloadsConfigMapsRequest.
- Type
MutableSequence[google.cloud.orchestration.airflow.service_v1.types.UserWorkloadsConfigMap]
- class google.cloud.orchestration.airflow.service_v1.types.ListUserWorkloadsSecretsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList user workloads Secrets request.
- parent¶
Required. List Secrets in the given environment, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.ListUserWorkloadsSecretsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe user workloads Secrets for a given environment.
- user_workloads_secrets¶
The list of Secrets returned by a ListUserWorkloadsSecretsRequest.
- Type
MutableSequence[google.cloud.orchestration.airflow.service_v1.types.UserWorkloadsSecret]
- class google.cloud.orchestration.airflow.service_v1.types.ListWorkloadsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for listing workloads in a Cloud Composer environment.
- parent¶
Required. The environment name to get workloads for, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- page_token¶
Optional. The next_page_token value returned from a previous List request, if any.
- Type
- 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.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.ListWorkloadsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to ListWorkloadsRequest.
- workloads¶
The list of environment workloads.
- class ComposerWorkload(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about a single workload.
- type_¶
Type of a workload.
- status¶
Output only. Status of a workload.
- class ComposerWorkloadState(value)[source]¶
Bases:
proto.enums.EnumWorkload states.
- Values:
- COMPOSER_WORKLOAD_STATE_UNSPECIFIED (0):
Not able to determine the status of the workload.
- PENDING (1):
Workload is in pending state and has not yet started.
- OK (2):
Workload is running fine.
- WARNING (3):
Workload is running but there are some non-critical problems.
- ERROR (4):
Workload is not running due to an error.
- SUCCEEDED (5):
Workload has finished execution with success.
- FAILED (6):
Workload has finished execution with failure.
- class ComposerWorkloadStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWorkload status.
- state¶
Output only. Workload state.
- class ComposerWorkloadType(value)[source]¶
Bases:
proto.enums.EnumSupported workload types.
- Values:
- COMPOSER_WORKLOAD_TYPE_UNSPECIFIED (0):
Not able to determine the type of the workload.
- CELERY_WORKER (1):
Celery worker.
- KUBERNETES_WORKER (2):
Kubernetes worker.
- KUBERNETES_OPERATOR_POD (3):
Workload created by Kubernetes Pod Operator.
- SCHEDULER (4):
Airflow scheduler.
- DAG_PROCESSOR (5):
Airflow Dag processor.
- TRIGGERER (6):
Airflow triggerer.
- WEB_SERVER (7):
Airflow web server UI.
- REDIS (8):
Redis.
- class google.cloud.orchestration.airflow.service_v1.types.LoadSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to load a snapshot into a Cloud Composer environment.
- environment¶
The resource name of the target environment in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- snapshot_path¶
A Cloud Storage path to a snapshot to load, e.g.: “gs://my-bucket/snapshots/project_location_environment_timestamp”.
- Type
- skip_pypi_packages_installation¶
Whether or not to skip installing Pypi packages when loading the environment’s state.
- Type
- skip_environment_variables_setting¶
Whether or not to skip setting environment variables when loading the environment’s state.
- Type
- skip_airflow_overrides_setting¶
Whether or not to skip setting Airflow overrides when loading the environment’s state.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.LoadSnapshotResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to LoadSnapshotRequest.
- class google.cloud.orchestration.airflow.service_v1.types.MaintenanceWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
- 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
start_time.
- class google.cloud.orchestration.airflow.service_v1.types.MasterAuthorizedNetworksConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration 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.
- cidr_blocks¶
Up to 50 external networks that could access Kubernetes master through HTTPS.
- class google.cloud.orchestration.airflow.service_v1.types.NetworkingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration options for networking connections in the Composer 2 environment.
- 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.
- class ConnectionType(value)[source]¶
Bases:
proto.enums.EnumRepresents connection type between Composer environment in Customer Project and the corresponding Tenant project, from a predefined list of available connection modes.
- Values:
- CONNECTION_TYPE_UNSPECIFIED (0):
No specific connection type was requested, so the environment uses the default value corresponding to the rest of its configuration.
- VPC_PEERING (1):
Requests the use of VPC peerings for connecting the Customer and Tenant projects.
- PRIVATE_SERVICE_CONNECT (2):
Requests the use of Private Service Connect for connecting the Customer and Tenant projects.
- class google.cloud.orchestration.airflow.service_v1.types.NodeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
- 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
locationmust belong to the enclosing environment’s project and location. If both this field andnodeConfig.machineTypeare specified,nodeConfig.machineTypemust belong to thislocation; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (locationornodeConfig.machineType) is specified, the location information from the specified field will be propagated to the unspecified field.This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Type
- 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
machineTypemust belong to the enclosing environment’s project and location. If both this field andnodeConfig.locationare specified, thismachineTypemust belong to thenodeConfig.location; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field andnodeConfig.locationis specified, the location information from the specified field will be propagated to the unspecified field.The
machineTypeIdmust not be a shared-core machine type.If this field is unspecified, the
machineTypeIddefaults to “n1-standard-1”.This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Type
- 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,
nodeConfig.subnetworkmust also be provided. For Shared VPC subnetwork requirements, seenodeConfig.subnetwork.- Type
- 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,
nodeConfig.networkmust also be provided, and the subnetwork must belong to the enclosing environment’s project and location.- Type
- 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-..*.
- Type
- oauth_scopes¶
Optional. The set of Google API scopes to be made available on all node VMs. If
oauth_scopesis empty, defaults to [”https://www.googleapis.com/auth/cloud-platform”]. Cannot be updated.This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Type
MutableSequence[str]
- service_account¶
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.
- Type
- 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.
- Type
MutableSequence[str]
- ip_allocation_policy¶
Optional. The configuration for controlling how IPs are allocated in the GKE cluster.
- 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
- Type
- 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.
- Type
- 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.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata describing an operation.
- 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.
- Type
- 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.
- class State(value)[source]¶
Bases:
proto.enums.EnumAn enum describing the overall state of an operation.
- Values:
- STATE_UNSPECIFIED (0):
Unused.
- PENDING (1):
The operation has been created but is not yet started.
- RUNNING (2):
The operation is underway.
- SUCCEEDED (3):
The operation completed successfully.
- SUCCESSFUL (3):
No description available.
- FAILED (4):
The operation is no longer running but did not succeed.
- class Type(value)[source]¶
Bases:
proto.enums.EnumType of longrunning operation.
- Values:
- TYPE_UNSPECIFIED (0):
Unused.
- CREATE (1):
A resource creation operation.
- DELETE (2):
A resource deletion operation.
- UPDATE (3):
A resource update operation.
- CHECK (4):
A resource check operation.
- SAVE_SNAPSHOT (5):
Saves snapshot of the resource operation.
- LOAD_SNAPSHOT (6):
Loads snapshot of the resource operation.
- DATABASE_FAILOVER (7):
Triggers failover of environment’s Cloud SQL instance (only for highly resilient environments).
- class google.cloud.orchestration.airflow.service_v1.types.PollAirflowCommandRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePoll Airflow Command request.
- environment¶
The resource name of the environment in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.PollAirflowCommandResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to PollAirflowCommandRequest.
- output¶
Output from the command execution. It may not contain the full output and the caller may need to poll for more lines.
- Type
MutableSequence[google.cloud.orchestration.airflow.service_v1.types.PollAirflowCommandResponse.Line]
- exit_info¶
The result exit status of the command.
- class ExitInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation about how a command ended.
- class google.cloud.orchestration.airflow.service_v1.types.PrivateClusterConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration options for the private GKE cluster in a Cloud Composer environment.
- enable_private_endpoint¶
Optional. If
true, access to the public endpoint of the GKE cluster is denied.- Type
- 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.
- Type
- 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 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.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.PrivateEnvironmentConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration information for configuring a Private IP Cloud Composer environment.
- enable_private_environment¶
Optional. If
true, a Private IP Cloud Composer environment is created. If this field is set to true,IPAllocationPolicy.use_ip_aliasesmust be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.- Type
- enable_private_builds_only¶
Optional. If
true, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if eitherNodeConfig.networkandNodeConfig.subnetworkfields orNodeConfig.composer_network_attachmentfield are specified). Iffalse, the builds also have access to the internet.This field is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
- Type
- 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_blockandcloud_sql_ipv4_cidr_block.This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Type
- 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.- Type
- 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-..*.
- Type
- 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.
- Type
- 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.
- Type
- enable_privately_used_public_ips¶
Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for
IPAllocationPolicy.cluster_ipv4_cidr_blockandIPAllocationPolicy.service_ipv4_cidr_block.- Type
- 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.
- Type
- networking_config¶
Optional. Configuration for the network connections configuration in the environment.
- class google.cloud.orchestration.airflow.service_v1.types.RecoveryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Recovery settings of an environment.
- scheduled_snapshots_config¶
Optional. The configuration for scheduled snapshot creation mechanism.
- class google.cloud.orchestration.airflow.service_v1.types.SaveSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to create a snapshot of a Cloud Composer environment.
- environment¶
The resource name of the source environment in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.SaveSnapshotResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to SaveSnapshotRequest.
- class google.cloud.orchestration.airflow.service_v1.types.ScheduledSnapshotsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration for scheduled snapshot creation mechanism.
- snapshot_location¶
Optional. The Cloud Storage location for storing automatically created snapshots.
- Type
- 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.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.SoftwareConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies the selection and configuration of software inside the environment.
- 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
composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?). When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version.The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or
latest. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias.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.
- Type
- 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
[a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expressionAIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names:AIRFLOW_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
- 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.
- Type
- scheduler_count¶
Optional. The number of schedulers for Airflow.
This field is supported for Cloud Composer environments in versions composer-1..-airflow-2.*.*.
- Type
- 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
PLUGINS_ENABLED.This field is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
- class AirflowConfigOverridesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class EnvVariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class PypiPackagesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class WebServerPluginsMode(value)[source]¶
Bases:
proto.enums.EnumWeb server plugins mode of the Cloud Composer environment.
- Values:
- WEB_SERVER_PLUGINS_MODE_UNSPECIFIED (0):
Default mode.
- PLUGINS_DISABLED (1):
Web server plugins are not supported.
- PLUGINS_ENABLED (2):
Web server plugins are supported.
- class google.cloud.orchestration.airflow.service_v1.types.StopAirflowCommandRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStop Airflow Command request.
- environment¶
The resource name of the environment in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.StopAirflowCommandResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to StopAirflowCommandRequest.
- class google.cloud.orchestration.airflow.service_v1.types.StorageConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration for data storage in the environment.
- class google.cloud.orchestration.airflow.service_v1.types.TaskLogsRetentionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration setting for Task Logs.
- storage_mode¶
Optional. The mode of storage for Airflow workers task logs.
- class TaskLogsStorageMode(value)[source]¶
Bases:
proto.enums.EnumThe definition of task_logs_storage_mode.
- Values:
- TASK_LOGS_STORAGE_MODE_UNSPECIFIED (0):
This configuration is not specified by the user.
- CLOUD_LOGGING_AND_CLOUD_STORAGE (1):
Store task logs in Cloud Logging and in the environment’s Cloud Storage bucket.
- CLOUD_LOGGING_ONLY (2):
Store task logs in Cloud Logging only.
- class google.cloud.orchestration.airflow.service_v1.types.UpdateEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdate an environment.
- name¶
The relative resource name of the environment to update, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}”.
- Type
- environment¶
A patch environment. Fields specified by the
updateMaskwill be copied from the patch environment into the environment under update.
- update_mask¶
Required. A comma-separated list of paths, relative to
Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, theupdateMaskparameter would include the following twopathsvalues: “config.softwareConfig.pypiPackages.scikit-learn” and “config.softwareConfig.pypiPackages.numpy”. The included patch environment would specify the scikit-learn version as follows:{ "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } }
Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected.
Only one update type may be included in a single request’s
updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels “label1” and “label2” while clearing “label3” (assuming it already exists), one can provide the paths “labels.label1”, “labels.label2”, and “labels.label3” and populate the patch environment as follows:{ "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } }
Note that in the above example, any existing labels that are not included in the
updateMaskwill be unaffected.It is also possible to replace an entire map field by providing the map field’s path in the
updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, theupdateMaskwould contain the path “config.softwareConfig.pypiPackages”, and the patch environment would be the following:{ "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } }
Note: Only the following fields can be updated:
config.softwareConfig.pypiPackagesReplace all custom custom PyPI packages. If a replacement package map is not included in
environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
config.softwareConfig.pypiPackages.packagenameUpdate the custom PyPI package packagename, preserving other packages. To delete the package, include it in
updateMask, and omit the mapping for it inenvironment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and theconfig.softwareConfig.pypiPackagesmask.
labelsReplace all environment labels. If a replacement labels map is not included in
environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
labels.labelNameSet the label named labelName, while preserving other labels. To delete the label, include it in
updateMaskand omit its mapping inenvironment.labels. It is an error to provide both a mask of this form and thelabelsmask.
config.nodeCountHorizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the
config.nodeCountfield. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
config.webServerNetworkAccessControlReplace the environment’s current
WebServerNetworkAccessControl.
config.softwareConfig.airflowConfigOverridesReplace all Apache Airflow config overrides. If a replacement config overrides map is not included in
environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
config.softwareConfig.airflowConfigOverrides.section-nameOverride the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in
updateMaskand omit its mapping inenvironment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and theconfig.softwareConfig.airflowConfigOverridesmask.
config.softwareConfig.envVariablesReplace all environment variables. If a replacement environment variable map is not included in
environment, all custom environment variables are cleared.
config.softwareConfig.schedulerCountHorizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the
config.softwareConfig.schedulerCountfield. Supported for Cloud Composer environments in versions composer-1..-airflow-2.*.*.
config.databaseConfig.machineTypeCloud 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. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
config.webServerConfig.machineTypeMachine 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. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- class google.cloud.orchestration.airflow.service_v1.types.UpdateUserWorkloadsConfigMapRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdate user workloads ConfigMap request.
- user_workloads_config_map¶
Optional. User workloads ConfigMap to override.
- class google.cloud.orchestration.airflow.service_v1.types.UpdateUserWorkloadsSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdate user workloads Secret request.
- user_workloads_secret¶
Optional. User workloads Secret to override.
- class google.cloud.orchestration.airflow.service_v1.types.UserWorkloadsConfigMap(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUser workloads ConfigMap used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.
- name¶
Identifier. The resource name of the ConfigMap, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}”.
- Type
- data¶
Optional. The “data” field of Kubernetes ConfigMap, organized in key-value pairs. For details see:
https://kubernetes.io/docs/concepts/configuration/configmap/
- class DataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.orchestration.airflow.service_v1.types.UserWorkloadsSecret(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUser workloads Secret used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.
- name¶
Identifier. The resource name of the Secret, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}”.
- Type
- 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/
- class DataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.orchestration.airflow.service_v1.types.WebServerConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1..-airflow-..*
- 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.
- Type
- class google.cloud.orchestration.airflow.service_v1.types.WebServerNetworkAccessControl(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNetwork-level access control policy for the Airflow web server.
- allowed_ip_ranges¶
A collection of allowed IP ranges with descriptions.
- class AllowedIpRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAllowed IP range with user-provided description.
- value¶
IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples:
192.168.1.1or192.168.0.0/16or2001:db8::/32or2001:0db8:0000:0042:0000:8a2e:0370:7334.IP range prefixes should be properly truncated. For example,
1.2.3.4/24should be truncated to1.2.3.0/24. Similarly, for IPv6,2001:db8::1/32should be truncated to2001:db8::/32.- Type
- class google.cloud.orchestration.airflow.service_v1.types.WorkloadsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- 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.
- class DagProcessorResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for resources used by Airflow DAG processors.
This field is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
- memory_gb¶
Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.
- Type
- storage_gb¶
Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.
- Type
- class SchedulerResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for resources used by Airflow schedulers.
- memory_gb¶
Optional. Memory (GB) request and limit for a single Airflow scheduler replica.
- Type
- storage_gb¶
Optional. Storage (GB) request and limit for a single Airflow scheduler replica.
- Type
- class TriggererResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for resources used by Airflow triggerers.
- class WebServerResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for resources used by Airflow web server.
- class WorkerResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for resources used by Airflow workers.
- storage_gb¶
Optional. Storage (GB) request and limit for a single Airflow worker replica.
- Type
