- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
public static final class EnvironmentConfig.Builder extends GeneratedMessageV3.Builder<EnvironmentConfig.Builder> implements EnvironmentConfigOrBuilderConfiguration information for an environment.
Protobuf type google.cloud.orchestration.airflow.service.v1.EnvironmentConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EnvironmentConfig.BuilderImplements
EnvironmentConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public EnvironmentConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
build()
public EnvironmentConfig build()| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig |
|
buildPartial()
public EnvironmentConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig |
|
clear()
public EnvironmentConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearAirflowByoidUri()
public EnvironmentConfig.Builder clearAirflowByoidUri()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).
string airflow_byoid_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
clearAirflowUri()
public EnvironmentConfig.Builder clearAirflowUri()Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
string airflow_uri = 6;
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
clearDagGcsPrefix()
public EnvironmentConfig.Builder clearDagGcsPrefix()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.
string dag_gcs_prefix = 2;
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
clearDataRetentionConfig()
public EnvironmentConfig.Builder clearDataRetentionConfig()Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearDatabaseConfig()
public EnvironmentConfig.Builder clearDatabaseConfig()Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearEncryptionConfig()
public EnvironmentConfig.Builder clearEncryptionConfig()Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearEnvironmentSize()
public EnvironmentConfig.Builder clearEnvironmentSize()Optional. The size of the Cloud Composer environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public EnvironmentConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearGkeCluster()
public EnvironmentConfig.Builder clearGkeCluster()Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1;
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
clearMaintenanceWindow()
public EnvironmentConfig.Builder clearMaintenanceWindow()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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearMasterAuthorizedNetworksConfig()
public EnvironmentConfig.Builder clearMasterAuthorizedNetworksConfig()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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearNodeConfig()
public EnvironmentConfig.Builder clearNodeConfig()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearNodeCount()
public EnvironmentConfig.Builder clearNodeCount()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-..*.
int32 node_count = 3;
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public EnvironmentConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearPrivateEnvironmentConfig()
public EnvironmentConfig.Builder clearPrivateEnvironmentConfig()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearRecoveryConfig()
public EnvironmentConfig.Builder clearRecoveryConfig()Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearResilienceMode()
public EnvironmentConfig.Builder clearResilienceMode()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.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.ResilienceMode resilience_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
clearSoftwareConfig()
public EnvironmentConfig.Builder clearSoftwareConfig()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearWebServerConfig()
public EnvironmentConfig.Builder clearWebServerConfig()Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearWebServerNetworkAccessControl()
public EnvironmentConfig.Builder clearWebServerNetworkAccessControl()Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clearWorkloadsConfig()
public EnvironmentConfig.Builder clearWorkloadsConfig()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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
clone()
public EnvironmentConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
getAirflowByoidUri()
public String getAirflowByoidUri()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).
string airflow_byoid_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The airflowByoidUri. |
getAirflowByoidUriBytes()
public ByteString getAirflowByoidUriBytes()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).
string airflow_byoid_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for airflowByoidUri. |
getAirflowUri()
public String getAirflowUri()Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
string airflow_uri = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The airflowUri. |
getAirflowUriBytes()
public ByteString getAirflowUriBytes()Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
string airflow_uri = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for airflowUri. |
getDagGcsPrefix()
public String getDagGcsPrefix()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.
string dag_gcs_prefix = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The dagGcsPrefix. |
getDagGcsPrefixBytes()
public ByteString getDagGcsPrefixBytes()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.
string dag_gcs_prefix = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dagGcsPrefix. |
getDataRetentionConfig()
public DataRetentionConfig getDataRetentionConfig()Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataRetentionConfig |
The dataRetentionConfig. |
getDataRetentionConfigBuilder()
public DataRetentionConfig.Builder getDataRetentionConfigBuilder()Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataRetentionConfig.Builder |
|
getDataRetentionConfigOrBuilder()
public DataRetentionConfigOrBuilder getDataRetentionConfigOrBuilder()Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataRetentionConfigOrBuilder |
|
getDatabaseConfig()
public DatabaseConfig getDatabaseConfig()Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DatabaseConfig |
The databaseConfig. |
getDatabaseConfigBuilder()
public DatabaseConfig.Builder getDatabaseConfigBuilder()Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DatabaseConfig.Builder |
|
getDatabaseConfigOrBuilder()
public DatabaseConfigOrBuilder getDatabaseConfigOrBuilder()Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DatabaseConfigOrBuilder |
|
getDefaultInstanceForType()
public EnvironmentConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEncryptionConfig()
public EncryptionConfig getEncryptionConfig()Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig |
The encryptionConfig. |
getEncryptionConfigBuilder()
public EncryptionConfig.Builder getEncryptionConfigBuilder()Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig.Builder |
|
getEncryptionConfigOrBuilder()
public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EncryptionConfigOrBuilder |
|
getEnvironmentSize()
public EnvironmentConfig.EnvironmentSize getEnvironmentSize()Optional. The size of the Cloud Composer environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.EnvironmentSize |
The environmentSize. |
getEnvironmentSizeValue()
public int getEnvironmentSizeValue()Optional. The size of the Cloud Composer environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for environmentSize. |
getGkeCluster()
public String getGkeCluster()Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The gkeCluster. |
getGkeClusterBytes()
public ByteString getGkeClusterBytes()Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for gkeCluster. |
getMaintenanceWindow()
public MaintenanceWindow getMaintenanceWindow()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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MaintenanceWindow |
The maintenanceWindow. |
getMaintenanceWindowBuilder()
public MaintenanceWindow.Builder getMaintenanceWindowBuilder()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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MaintenanceWindow.Builder |
|
getMaintenanceWindowOrBuilder()
public MaintenanceWindowOrBuilder getMaintenanceWindowOrBuilder()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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MaintenanceWindowOrBuilder |
|
getMasterAuthorizedNetworksConfig()
public MasterAuthorizedNetworksConfig getMasterAuthorizedNetworksConfig()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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MasterAuthorizedNetworksConfig |
The masterAuthorizedNetworksConfig. |
getMasterAuthorizedNetworksConfigBuilder()
public MasterAuthorizedNetworksConfig.Builder getMasterAuthorizedNetworksConfigBuilder()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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MasterAuthorizedNetworksConfig.Builder |
|
getMasterAuthorizedNetworksConfigOrBuilder()
public MasterAuthorizedNetworksConfigOrBuilder getMasterAuthorizedNetworksConfigOrBuilder()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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MasterAuthorizedNetworksConfigOrBuilder |
|
getNodeConfig()
public NodeConfig getNodeConfig()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Returns | |
|---|---|
| Type | Description |
NodeConfig |
The nodeConfig. |
getNodeConfigBuilder()
public NodeConfig.Builder getNodeConfigBuilder()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Returns | |
|---|---|
| Type | Description |
NodeConfig.Builder |
|
getNodeConfigOrBuilder()
public NodeConfigOrBuilder getNodeConfigOrBuilder()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Returns | |
|---|---|
| Type | Description |
NodeConfigOrBuilder |
|
getNodeCount()
public int getNodeCount()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-..*.
int32 node_count = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The nodeCount. |
getPrivateEnvironmentConfig()
public PrivateEnvironmentConfig getPrivateEnvironmentConfig()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Returns | |
|---|---|
| Type | Description |
PrivateEnvironmentConfig |
The privateEnvironmentConfig. |
getPrivateEnvironmentConfigBuilder()
public PrivateEnvironmentConfig.Builder getPrivateEnvironmentConfigBuilder()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Returns | |
|---|---|
| Type | Description |
PrivateEnvironmentConfig.Builder |
|
getPrivateEnvironmentConfigOrBuilder()
public PrivateEnvironmentConfigOrBuilder getPrivateEnvironmentConfigOrBuilder()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Returns | |
|---|---|
| Type | Description |
PrivateEnvironmentConfigOrBuilder |
|
getRecoveryConfig()
public RecoveryConfig getRecoveryConfig()Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RecoveryConfig |
The recoveryConfig. |
getRecoveryConfigBuilder()
public RecoveryConfig.Builder getRecoveryConfigBuilder()Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RecoveryConfig.Builder |
|
getRecoveryConfigOrBuilder()
public RecoveryConfigOrBuilder getRecoveryConfigOrBuilder()Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RecoveryConfigOrBuilder |
|
getResilienceMode()
public EnvironmentConfig.ResilienceMode getResilienceMode()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.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.ResilienceMode resilience_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.ResilienceMode |
The resilienceMode. |
getResilienceModeValue()
public int getResilienceModeValue()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.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.ResilienceMode resilience_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for resilienceMode. |
getSoftwareConfig()
public SoftwareConfig getSoftwareConfig()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig |
The softwareConfig. |
getSoftwareConfigBuilder()
public SoftwareConfig.Builder getSoftwareConfigBuilder()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.Builder |
|
getSoftwareConfigOrBuilder()
public SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Returns | |
|---|---|
| Type | Description |
SoftwareConfigOrBuilder |
|
getWebServerConfig()
public WebServerConfig getWebServerConfig()Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WebServerConfig |
The webServerConfig. |
getWebServerConfigBuilder()
public WebServerConfig.Builder getWebServerConfigBuilder()Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WebServerConfig.Builder |
|
getWebServerConfigOrBuilder()
public WebServerConfigOrBuilder getWebServerConfigOrBuilder()Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WebServerConfigOrBuilder |
|
getWebServerNetworkAccessControl()
public WebServerNetworkAccessControl getWebServerNetworkAccessControl()Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WebServerNetworkAccessControl |
The webServerNetworkAccessControl. |
getWebServerNetworkAccessControlBuilder()
public WebServerNetworkAccessControl.Builder getWebServerNetworkAccessControlBuilder()Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WebServerNetworkAccessControl.Builder |
|
getWebServerNetworkAccessControlOrBuilder()
public WebServerNetworkAccessControlOrBuilder getWebServerNetworkAccessControlOrBuilder()Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WebServerNetworkAccessControlOrBuilder |
|
getWorkloadsConfig()
public WorkloadsConfig getWorkloadsConfig()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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkloadsConfig |
The workloadsConfig. |
getWorkloadsConfigBuilder()
public WorkloadsConfig.Builder getWorkloadsConfigBuilder()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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkloadsConfig.Builder |
|
getWorkloadsConfigOrBuilder()
public WorkloadsConfigOrBuilder getWorkloadsConfigOrBuilder()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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkloadsConfigOrBuilder |
|
hasDataRetentionConfig()
public boolean hasDataRetentionConfig()Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dataRetentionConfig field is set. |
hasDatabaseConfig()
public boolean hasDatabaseConfig()Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the databaseConfig field is set. |
hasEncryptionConfig()
public boolean hasEncryptionConfig()Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionConfig field is set. |
hasMaintenanceWindow()
public boolean hasMaintenanceWindow()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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maintenanceWindow field is set. |
hasMasterAuthorizedNetworksConfig()
public boolean hasMasterAuthorizedNetworksConfig()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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the masterAuthorizedNetworksConfig field is set. |
hasNodeConfig()
public boolean hasNodeConfig()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the nodeConfig field is set. |
hasPrivateEnvironmentConfig()
public boolean hasPrivateEnvironmentConfig()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the privateEnvironmentConfig field is set. |
hasRecoveryConfig()
public boolean hasRecoveryConfig()Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the recoveryConfig field is set. |
hasSoftwareConfig()
public boolean hasSoftwareConfig()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the softwareConfig field is set. |
hasWebServerConfig()
public boolean hasWebServerConfig()Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the webServerConfig field is set. |
hasWebServerNetworkAccessControl()
public boolean hasWebServerNetworkAccessControl()Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the webServerNetworkAccessControl field is set. |
hasWorkloadsConfig()
public boolean hasWorkloadsConfig()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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the workloadsConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDataRetentionConfig(DataRetentionConfig value)
public EnvironmentConfig.Builder mergeDataRetentionConfig(DataRetentionConfig value)Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DataRetentionConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeDatabaseConfig(DatabaseConfig value)
public EnvironmentConfig.Builder mergeDatabaseConfig(DatabaseConfig value)Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeEncryptionConfig(EncryptionConfig value)
public EnvironmentConfig.Builder mergeEncryptionConfig(EncryptionConfig value)Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeFrom(EnvironmentConfig other)
public EnvironmentConfig.Builder mergeFrom(EnvironmentConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
EnvironmentConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public EnvironmentConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public EnvironmentConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeMaintenanceWindow(MaintenanceWindow value)
public EnvironmentConfig.Builder mergeMaintenanceWindow(MaintenanceWindow value)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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
MaintenanceWindow |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)
public EnvironmentConfig.Builder mergeMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
MasterAuthorizedNetworksConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeNodeConfig(NodeConfig value)
public EnvironmentConfig.Builder mergeNodeConfig(NodeConfig value)The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
NodeConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergePrivateEnvironmentConfig(PrivateEnvironmentConfig value)
public EnvironmentConfig.Builder mergePrivateEnvironmentConfig(PrivateEnvironmentConfig value)The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
PrivateEnvironmentConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeRecoveryConfig(RecoveryConfig value)
public EnvironmentConfig.Builder mergeRecoveryConfig(RecoveryConfig value)Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
RecoveryConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeSoftwareConfig(SoftwareConfig value)
public EnvironmentConfig.Builder mergeSoftwareConfig(SoftwareConfig value)The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
SoftwareConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final EnvironmentConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeWebServerConfig(WebServerConfig value)
public EnvironmentConfig.Builder mergeWebServerConfig(WebServerConfig value)Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WebServerConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeWebServerNetworkAccessControl(WebServerNetworkAccessControl value)
public EnvironmentConfig.Builder mergeWebServerNetworkAccessControl(WebServerNetworkAccessControl value)Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WebServerNetworkAccessControl |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
mergeWorkloadsConfig(WorkloadsConfig value)
public EnvironmentConfig.Builder mergeWorkloadsConfig(WorkloadsConfig value)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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkloadsConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setAirflowByoidUri(String value)
public EnvironmentConfig.Builder setAirflowByoidUri(String value)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).
string airflow_byoid_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe airflowByoidUri to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setAirflowByoidUriBytes(ByteString value)
public EnvironmentConfig.Builder setAirflowByoidUriBytes(ByteString value)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).
string airflow_byoid_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for airflowByoidUri to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setAirflowUri(String value)
public EnvironmentConfig.Builder setAirflowUri(String value)Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
string airflow_uri = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe airflowUri to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setAirflowUriBytes(ByteString value)
public EnvironmentConfig.Builder setAirflowUriBytes(ByteString value)Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
string airflow_uri = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for airflowUri to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setDagGcsPrefix(String value)
public EnvironmentConfig.Builder setDagGcsPrefix(String value)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.
string dag_gcs_prefix = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe dagGcsPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setDagGcsPrefixBytes(ByteString value)
public EnvironmentConfig.Builder setDagGcsPrefixBytes(ByteString value)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.
string dag_gcs_prefix = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for dagGcsPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setDataRetentionConfig(DataRetentionConfig value)
public EnvironmentConfig.Builder setDataRetentionConfig(DataRetentionConfig value)Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DataRetentionConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setDataRetentionConfig(DataRetentionConfig.Builder builderForValue)
public EnvironmentConfig.Builder setDataRetentionConfig(DataRetentionConfig.Builder builderForValue)Optional. The configuration setting for Airflow database data retention mechanism.
.google.cloud.orchestration.airflow.service.v1.DataRetentionConfig data_retention_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DataRetentionConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setDatabaseConfig(DatabaseConfig value)
public EnvironmentConfig.Builder setDatabaseConfig(DatabaseConfig value)Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setDatabaseConfig(DatabaseConfig.Builder builderForValue)
public EnvironmentConfig.Builder setDatabaseConfig(DatabaseConfig.Builder builderForValue)Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
.google.cloud.orchestration.airflow.service.v1.DatabaseConfig database_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DatabaseConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setEncryptionConfig(EncryptionConfig value)
public EnvironmentConfig.Builder setEncryptionConfig(EncryptionConfig value)Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setEncryptionConfig(EncryptionConfig.Builder builderForValue)
public EnvironmentConfig.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1.EncryptionConfig encryption_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EncryptionConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setEnvironmentSize(EnvironmentConfig.EnvironmentSize value)
public EnvironmentConfig.Builder setEnvironmentSize(EnvironmentConfig.EnvironmentSize value)Optional. The size of the Cloud Composer environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
EnvironmentConfig.EnvironmentSizeThe environmentSize to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setEnvironmentSizeValue(int value)
public EnvironmentConfig.Builder setEnvironmentSizeValue(int value)Optional. The size of the Cloud Composer environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for environmentSize to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public EnvironmentConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setGkeCluster(String value)
public EnvironmentConfig.Builder setGkeCluster(String value)Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe gkeCluster to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setGkeClusterBytes(ByteString value)
public EnvironmentConfig.Builder setGkeClusterBytes(ByteString value)Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for gkeCluster to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setMaintenanceWindow(MaintenanceWindow value)
public EnvironmentConfig.Builder setMaintenanceWindow(MaintenanceWindow value)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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
MaintenanceWindow |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setMaintenanceWindow(MaintenanceWindow.Builder builderForValue)
public EnvironmentConfig.Builder setMaintenanceWindow(MaintenanceWindow.Builder builderForValue)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.
.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow maintenance_window = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
MaintenanceWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)
public EnvironmentConfig.Builder setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
MasterAuthorizedNetworksConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig.Builder builderForValue)
public EnvironmentConfig.Builder setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig.Builder builderForValue)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.
.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
MasterAuthorizedNetworksConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setNodeConfig(NodeConfig value)
public EnvironmentConfig.Builder setNodeConfig(NodeConfig value)The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
NodeConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setNodeConfig(NodeConfig.Builder builderForValue)
public EnvironmentConfig.Builder setNodeConfig(NodeConfig.Builder builderForValue)The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
NodeConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setNodeCount(int value)
public EnvironmentConfig.Builder setNodeCount(int value)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-..*.
int32 node_count = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe nodeCount to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setPrivateEnvironmentConfig(PrivateEnvironmentConfig value)
public EnvironmentConfig.Builder setPrivateEnvironmentConfig(PrivateEnvironmentConfig value)The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
PrivateEnvironmentConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setPrivateEnvironmentConfig(PrivateEnvironmentConfig.Builder builderForValue)
public EnvironmentConfig.Builder setPrivateEnvironmentConfig(PrivateEnvironmentConfig.Builder builderForValue)The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PrivateEnvironmentConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setRecoveryConfig(RecoveryConfig value)
public EnvironmentConfig.Builder setRecoveryConfig(RecoveryConfig value)Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
RecoveryConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setRecoveryConfig(RecoveryConfig.Builder builderForValue)
public EnvironmentConfig.Builder setRecoveryConfig(RecoveryConfig.Builder builderForValue)Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RecoveryConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public EnvironmentConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setResilienceMode(EnvironmentConfig.ResilienceMode value)
public EnvironmentConfig.Builder setResilienceMode(EnvironmentConfig.ResilienceMode value)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.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.ResilienceMode resilience_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
EnvironmentConfig.ResilienceModeThe resilienceMode to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setResilienceModeValue(int value)
public EnvironmentConfig.Builder setResilienceModeValue(int value)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.
.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.ResilienceMode resilience_mode = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for resilienceMode to set. |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
This builder for chaining. |
setSoftwareConfig(SoftwareConfig value)
public EnvironmentConfig.Builder setSoftwareConfig(SoftwareConfig value)The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
SoftwareConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setSoftwareConfig(SoftwareConfig.Builder builderForValue)
public EnvironmentConfig.Builder setSoftwareConfig(SoftwareConfig.Builder builderForValue)The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SoftwareConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final EnvironmentConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setWebServerConfig(WebServerConfig value)
public EnvironmentConfig.Builder setWebServerConfig(WebServerConfig value)Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WebServerConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setWebServerConfig(WebServerConfig.Builder builderForValue)
public EnvironmentConfig.Builder setWebServerConfig(WebServerConfig.Builder builderForValue)Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1.WebServerConfig web_server_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WebServerConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setWebServerNetworkAccessControl(WebServerNetworkAccessControl value)
public EnvironmentConfig.Builder setWebServerNetworkAccessControl(WebServerNetworkAccessControl value)Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WebServerNetworkAccessControl |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setWebServerNetworkAccessControl(WebServerNetworkAccessControl.Builder builderForValue)
public EnvironmentConfig.Builder setWebServerNetworkAccessControl(WebServerNetworkAccessControl.Builder builderForValue)Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl web_server_network_access_control = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WebServerNetworkAccessControl.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setWorkloadsConfig(WorkloadsConfig value)
public EnvironmentConfig.Builder setWorkloadsConfig(WorkloadsConfig value)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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkloadsConfig |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|
setWorkloadsConfig(WorkloadsConfig.Builder builderForValue)
public EnvironmentConfig.Builder setWorkloadsConfig(WorkloadsConfig.Builder builderForValue)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.
.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkloadsConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
EnvironmentConfig.Builder |
|