Interface EnvironmentConfigOrBuilder (1.24.0) 

public interface EnvironmentConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAirflowByoidUri()

public abstract 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 = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The airflowByoidUri.

getAirflowByoidUriBytes()

public abstract 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 = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for airflowByoidUri.

getAirflowUri()

public abstract String getAirflowUri()

Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).

string airflow_uri = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The airflowUri.

getAirflowUriBytes()

public abstract ByteString getAirflowUriBytes()

Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).

string airflow_uri = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for airflowUri.

getDagGcsPrefix()

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dagGcsPrefix.

getDagGcsPrefixBytes()

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dagGcsPrefix.

getDatabaseConfig()

public abstract DatabaseConfig getDatabaseConfig()

Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.

.google.cloud.orchestration.airflow.service.v1beta1.DatabaseConfig database_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DatabaseConfig

The databaseConfig.

getDatabaseConfigOrBuilder()

public abstract DatabaseConfigOrBuilder getDatabaseConfigOrBuilder()

Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.

.google.cloud.orchestration.airflow.service.v1beta1.DatabaseConfig database_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DatabaseConfigOrBuilder

getEncryptionConfig()

public abstract EncryptionConfig getEncryptionConfig()

Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.

.google.cloud.orchestration.airflow.service.v1beta1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfig

The encryptionConfig.

getEncryptionConfigOrBuilder()

public abstract EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.

.google.cloud.orchestration.airflow.service.v1beta1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfigOrBuilder

getEnvironmentSize()

public abstract 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.v1beta1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EnvironmentConfig.EnvironmentSize

The environmentSize.

getEnvironmentSizeValue()

public abstract 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.v1beta1.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 abstract String getGkeCluster()

Output only. The Kubernetes Engine cluster used to run this environment.

string gke_cluster = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The gkeCluster.

getGkeClusterBytes()

public abstract ByteString getGkeClusterBytes()

Output only. The Kubernetes Engine cluster used to run this environment.

string gke_cluster = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for gkeCluster.

getMaintenanceWindow()

public abstract 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, Cloud Composer components may be subject to maintenance at any time.

.google.cloud.orchestration.airflow.service.v1beta1.MaintenanceWindow maintenance_window = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MaintenanceWindow

The maintenanceWindow.

getMaintenanceWindowOrBuilder()

public abstract 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, Cloud Composer components may be subject to maintenance at any time.

.google.cloud.orchestration.airflow.service.v1beta1.MaintenanceWindow maintenance_window = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MaintenanceWindowOrBuilder

getMasterAuthorizedNetworksConfig()

public abstract 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.v1beta1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MasterAuthorizedNetworksConfig

The masterAuthorizedNetworksConfig.

getMasterAuthorizedNetworksConfigOrBuilder()

public abstract 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.v1beta1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MasterAuthorizedNetworksConfigOrBuilder

getNodeConfig()

public abstract NodeConfig getNodeConfig()

The configuration used for the Kubernetes Engine cluster.

.google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5;

Returns
Type Description
NodeConfig

The nodeConfig.

getNodeConfigOrBuilder()

public abstract NodeConfigOrBuilder getNodeConfigOrBuilder()

The configuration used for the Kubernetes Engine cluster.

.google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5;

Returns
Type Description
NodeConfigOrBuilder

getNodeCount()

public abstract 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 abstract PrivateEnvironmentConfig getPrivateEnvironmentConfig()

The configuration used for the Private IP Cloud Composer environment.

.google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7;

Returns
Type Description
PrivateEnvironmentConfig

The privateEnvironmentConfig.

getPrivateEnvironmentConfigOrBuilder()

public abstract PrivateEnvironmentConfigOrBuilder getPrivateEnvironmentConfigOrBuilder()

The configuration used for the Private IP Cloud Composer environment.

.google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7;

Returns
Type Description
PrivateEnvironmentConfigOrBuilder

getRecoveryConfig()

public abstract 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.v1beta1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RecoveryConfig

The recoveryConfig.

getRecoveryConfigOrBuilder()

public abstract 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.v1beta1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RecoveryConfigOrBuilder

getResilienceMode()

public abstract 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.v1beta1.EnvironmentConfig.ResilienceMode resilience_mode = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EnvironmentConfig.ResilienceMode

The resilienceMode.

getResilienceModeValue()

public abstract 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.v1beta1.EnvironmentConfig.ResilienceMode resilience_mode = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for resilienceMode.

getSoftwareConfig()

public abstract SoftwareConfig getSoftwareConfig()

The configuration settings for software inside the environment.

.google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4;

Returns
Type Description
SoftwareConfig

The softwareConfig.

getSoftwareConfigOrBuilder()

public abstract SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()

The configuration settings for software inside the environment.

.google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4;

Returns
Type Description
SoftwareConfigOrBuilder

getWebServerConfig()

public abstract WebServerConfig getWebServerConfig()

Optional. The configuration settings for the Airflow web server App Engine instance.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.cloud.orchestration.airflow.service.v1beta1.WebServerConfig web_server_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebServerConfig

The webServerConfig.

getWebServerConfigOrBuilder()

public abstract WebServerConfigOrBuilder getWebServerConfigOrBuilder()

Optional. The configuration settings for the Airflow web server App Engine instance.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.cloud.orchestration.airflow.service.v1beta1.WebServerConfig web_server_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebServerConfigOrBuilder

getWebServerNetworkAccessControl()

public abstract 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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebServerNetworkAccessControl

The webServerNetworkAccessControl.

getWebServerNetworkAccessControlOrBuilder()

public abstract 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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebServerNetworkAccessControlOrBuilder

getWorkloadsConfig()

public abstract 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.v1beta1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkloadsConfig

The workloadsConfig.

getWorkloadsConfigOrBuilder()

public abstract 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.v1beta1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkloadsConfigOrBuilder

hasDatabaseConfig()

public abstract boolean hasDatabaseConfig()

Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.

.google.cloud.orchestration.airflow.service.v1beta1.DatabaseConfig database_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the databaseConfig field is set.

hasEncryptionConfig()

public abstract boolean hasEncryptionConfig()

Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.

.google.cloud.orchestration.airflow.service.v1beta1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionConfig field is set.

hasMaintenanceWindow()

public abstract 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, Cloud Composer components may be subject to maintenance at any time.

.google.cloud.orchestration.airflow.service.v1beta1.MaintenanceWindow maintenance_window = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maintenanceWindow field is set.

hasMasterAuthorizedNetworksConfig()

public abstract 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.v1beta1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the masterAuthorizedNetworksConfig field is set.

hasNodeConfig()

public abstract boolean hasNodeConfig()

The configuration used for the Kubernetes Engine cluster.

.google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5;

Returns
Type Description
boolean

Whether the nodeConfig field is set.

hasPrivateEnvironmentConfig()

public abstract boolean hasPrivateEnvironmentConfig()

The configuration used for the Private IP Cloud Composer environment.

.google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7;

Returns
Type Description
boolean

Whether the privateEnvironmentConfig field is set.

hasRecoveryConfig()

public abstract 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.v1beta1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the recoveryConfig field is set.

hasSoftwareConfig()

public abstract boolean hasSoftwareConfig()

The configuration settings for software inside the environment.

.google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4;

Returns
Type Description
boolean

Whether the softwareConfig field is set.

hasWebServerConfig()

public abstract boolean hasWebServerConfig()

Optional. The configuration settings for the Airflow web server App Engine instance.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

.google.cloud.orchestration.airflow.service.v1beta1.WebServerConfig web_server_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the webServerConfig field is set.

hasWebServerNetworkAccessControl()

public abstract 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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the webServerNetworkAccessControl field is set.

hasWorkloadsConfig()

public abstract 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.v1beta1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the workloadsConfig field is set.