com.google.cloud.orchestration.airflow.service.v1

Interface EnvironmentConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

EnvironmentConfig, EnvironmentConfig.Builder

public interface EnvironmentConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAirflowByoidUri() Output only.
com.google.protobuf.ByteString	getAirflowByoidUriBytes() Output only.
String	getAirflowUri() Output only.
com.google.protobuf.ByteString	getAirflowUriBytes() Output only.
String	getDagGcsPrefix() Output only.
com.google.protobuf.ByteString	getDagGcsPrefixBytes() Output only.
DatabaseConfig	getDatabaseConfig() Optional.
DatabaseConfigOrBuilder	getDatabaseConfigOrBuilder() Optional.
EncryptionConfig	getEncryptionConfig() Optional.
EncryptionConfigOrBuilder	getEncryptionConfigOrBuilder() Optional.
EnvironmentConfig.EnvironmentSize	getEnvironmentSize() Optional.
int	getEnvironmentSizeValue() Optional.
String	getGkeCluster() Output only.
com.google.protobuf.ByteString	getGkeClusterBytes() Output only.
MaintenanceWindow	getMaintenanceWindow() Optional.
MaintenanceWindowOrBuilder	getMaintenanceWindowOrBuilder() Optional.
MasterAuthorizedNetworksConfig	getMasterAuthorizedNetworksConfig() Optional.
MasterAuthorizedNetworksConfigOrBuilder	getMasterAuthorizedNetworksConfigOrBuilder() Optional.
NodeConfig	getNodeConfig() The configuration used for the Kubernetes Engine cluster.
NodeConfigOrBuilder	getNodeConfigOrBuilder() The configuration used for the Kubernetes Engine cluster.
int	getNodeCount() The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
PrivateEnvironmentConfig	getPrivateEnvironmentConfig() The configuration used for the Private IP Cloud Composer environment.
PrivateEnvironmentConfigOrBuilder	getPrivateEnvironmentConfigOrBuilder() The configuration used for the Private IP Cloud Composer environment.
RecoveryConfig	getRecoveryConfig() Optional.
RecoveryConfigOrBuilder	getRecoveryConfigOrBuilder() Optional.
EnvironmentConfig.ResilienceMode	getResilienceMode() Optional.
int	getResilienceModeValue() Optional.
SoftwareConfig	getSoftwareConfig() The configuration settings for software inside the environment.
SoftwareConfigOrBuilder	getSoftwareConfigOrBuilder() The configuration settings for software inside the environment.
WebServerConfig	getWebServerConfig() Optional.
WebServerConfigOrBuilder	getWebServerConfigOrBuilder() Optional.
WebServerNetworkAccessControl	getWebServerNetworkAccessControl() Optional.
WebServerNetworkAccessControlOrBuilder	getWebServerNetworkAccessControlOrBuilder() Optional.
WorkloadsConfig	getWorkloadsConfig() Optional.
WorkloadsConfigOrBuilder	getWorkloadsConfigOrBuilder() Optional.
boolean	hasDatabaseConfig() Optional.
boolean	hasEncryptionConfig() Optional.
boolean	hasMaintenanceWindow() Optional.
boolean	hasMasterAuthorizedNetworksConfig() Optional.
boolean	hasNodeConfig() The configuration used for the Kubernetes Engine cluster.
boolean	hasPrivateEnvironmentConfig() The configuration used for the Private IP Cloud Composer environment.
boolean	hasRecoveryConfig() Optional.
boolean	hasSoftwareConfig() The configuration settings for software inside the environment.
boolean	hasWebServerConfig() Optional.
boolean	hasWebServerNetworkAccessControl() Optional.
boolean	hasWorkloadsConfig() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getGkeCluster

String getGkeCluster()

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

string gke_cluster = 1;

Returns:

The gkeCluster.

getGkeClusterBytes

com.google.protobuf.ByteString getGkeClusterBytes()

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

string gke_cluster = 1;

Returns:

The bytes for gkeCluster.

getDagGcsPrefix

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:

The dagGcsPrefix.

getDagGcsPrefixBytes

com.google.protobuf.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:

The bytes for dagGcsPrefix.

getNodeCount

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:

The nodeCount.

hasSoftwareConfig

boolean hasSoftwareConfig()

 The configuration settings for software inside the environment.
 

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

Returns:

Whether the softwareConfig field is set.

getSoftwareConfig

SoftwareConfig getSoftwareConfig()

 The configuration settings for software inside the environment.
 

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

Returns:

The softwareConfig.

getSoftwareConfigOrBuilder

SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()

 The configuration settings for software inside the environment.
 

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

hasNodeConfig

boolean hasNodeConfig()

 The configuration used for the Kubernetes Engine cluster.
 

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

Returns:

Whether the nodeConfig field is set.

getNodeConfig

NodeConfig getNodeConfig()

 The configuration used for the Kubernetes Engine cluster.
 

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

Returns:

The nodeConfig.

getNodeConfigOrBuilder

NodeConfigOrBuilder getNodeConfigOrBuilder()

 The configuration used for the Kubernetes Engine cluster.
 

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

hasPrivateEnvironmentConfig

boolean hasPrivateEnvironmentConfig()

 The configuration used for the Private IP Cloud Composer environment.
 

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

Returns:

Whether the privateEnvironmentConfig field is set.

getPrivateEnvironmentConfig

PrivateEnvironmentConfig getPrivateEnvironmentConfig()

 The configuration used for the Private IP Cloud Composer environment.
 

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

Returns:

The privateEnvironmentConfig.

getPrivateEnvironmentConfigOrBuilder

PrivateEnvironmentConfigOrBuilder getPrivateEnvironmentConfigOrBuilder()

 The configuration used for the Private IP Cloud Composer environment.
 

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

hasWebServerNetworkAccessControl

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:

Whether the webServerNetworkAccessControl field is set.

getWebServerNetworkAccessControl

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:

The webServerNetworkAccessControl.

getWebServerNetworkAccessControlOrBuilder

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];

hasDatabaseConfig

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:

Whether the databaseConfig field is set.

getDatabaseConfig

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:

The databaseConfig.

getDatabaseConfigOrBuilder

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];

hasWebServerConfig

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:

Whether the webServerConfig field is set.

getWebServerConfig

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:

The webServerConfig.

getWebServerConfigOrBuilder

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];

hasEncryptionConfig

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:

Whether the encryptionConfig field is set.

getEncryptionConfig

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:

The encryptionConfig.

getEncryptionConfigOrBuilder

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];

hasMaintenanceWindow

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 will be
 applied. The default value is Saturday and Sunday 00-06 GMT.
 

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

Returns:

Whether the maintenanceWindow field is set.

getMaintenanceWindow

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 will be
 applied. The default value is Saturday and Sunday 00-06 GMT.
 

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

Returns:

The maintenanceWindow.

getMaintenanceWindowOrBuilder

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 will be
 applied. The default value is Saturday and Sunday 00-06 GMT.
 

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

hasWorkloadsConfig

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:

Whether the workloadsConfig field is set.

getWorkloadsConfig

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:

The workloadsConfig.

getWorkloadsConfigOrBuilder

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];

getEnvironmentSizeValue

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:

The enum numeric value on the wire for environmentSize.

getEnvironmentSize

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:

The environmentSize.

getAirflowUri

String getAirflowUri()

 Output only. The URI of the Apache Airflow Web UI hosted within this
 environment (see [Airflow web
 interface](/composer/docs/how-to/accessing/airflow-web-interface)).
 

string airflow_uri = 6;

Returns:

The airflowUri.

getAirflowUriBytes

com.google.protobuf.ByteString getAirflowUriBytes()

 Output only. The URI of the Apache Airflow Web UI hosted within this
 environment (see [Airflow web
 interface](/composer/docs/how-to/accessing/airflow-web-interface)).
 

string airflow_uri = 6;

Returns:

The bytes for airflowUri.

getAirflowByoidUri

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](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).
 

string airflow_byoid_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The airflowByoidUri.

getAirflowByoidUriBytes

com.google.protobuf.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](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).
 

string airflow_byoid_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for airflowByoidUri.

hasMasterAuthorizedNetworksConfig

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:

Whether the masterAuthorizedNetworksConfig field is set.

getMasterAuthorizedNetworksConfig

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:

The masterAuthorizedNetworksConfig.

getMasterAuthorizedNetworksConfigOrBuilder

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];

hasRecoveryConfig

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:

Whether the recoveryConfig field is set.

getRecoveryConfig

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:

The recoveryConfig.

getRecoveryConfigOrBuilder

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];

getResilienceModeValue

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:

The enum numeric value on the wire for resilienceMode.

getResilienceMode

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:

The resilienceMode.