Interface EnvironmentConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EnvironmentConfig, EnvironmentConfig.Builder

@Generated public interface EnvironmentConfigOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getGkeCluster

      String getGkeCluster()
       Output only. The Kubernetes Engine cluster used to run this environment.
       
      string gke_cluster = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The gkeCluster.
    • getGkeClusterBytes

      com.google.protobuf.ByteString getGkeClusterBytes()
       Output only. The Kubernetes Engine cluster used to run this environment.
       
      string gke_cluster = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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()
       Optional. The configuration settings for software inside the environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the softwareConfig field is set.
    • getSoftwareConfig

      SoftwareConfig getSoftwareConfig()
       Optional. The configuration settings for software inside the environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The softwareConfig.
    • getSoftwareConfigOrBuilder

      SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()
       Optional. The configuration settings for software inside the environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4 [(.google.api.field_behavior) = OPTIONAL];
    • hasNodeConfig

      boolean hasNodeConfig()
       Optional. The configuration used for the Kubernetes Engine cluster.
       
      .google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the nodeConfig field is set.
    • getNodeConfig

      NodeConfig getNodeConfig()
       Optional. The configuration used for the Kubernetes Engine cluster.
       
      .google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The nodeConfig.
    • getNodeConfigOrBuilder

      NodeConfigOrBuilder getNodeConfigOrBuilder()
       Optional. The configuration used for the Kubernetes Engine cluster.
       
      .google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5 [(.google.api.field_behavior) = OPTIONAL];
    • hasPrivateEnvironmentConfig

      boolean hasPrivateEnvironmentConfig()
       Optional. The configuration used for the Private IP Cloud Composer
       environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the privateEnvironmentConfig field is set.
    • getPrivateEnvironmentConfig

      PrivateEnvironmentConfig getPrivateEnvironmentConfig()
       Optional. The configuration used for the Private IP Cloud Composer
       environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The privateEnvironmentConfig.
    • getPrivateEnvironmentConfigOrBuilder

      PrivateEnvironmentConfigOrBuilder getPrivateEnvironmentConfigOrBuilder()
       Optional. The configuration used for the Private IP Cloud Composer
       environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7 [(.google.api.field_behavior) = OPTIONAL];
    • 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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.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.v1beta1.DatabaseConfig database_config = 10 [(.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.v1beta1.DatabaseConfig database_config = 10 [(.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.v1beta1.DatabaseConfig database_config = 10 [(.google.api.field_behavior) = OPTIONAL];
    • hasWebServerConfig

      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:
      Whether the webServerConfig field is set.
    • getWebServerConfig

      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:
      The webServerConfig.
    • getWebServerConfigOrBuilder

      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];
    • 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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 = 21 [(.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 = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for airflowByoidUri.
    • hasEncryptionConfig

      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:
      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.v1beta1.EncryptionConfig encryption_config = 12 [(.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.v1beta1.EncryptionConfig encryption_config = 12 [(.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 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.v1beta1.MaintenanceWindow maintenance_window = 13 [(.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 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.v1beta1.MaintenanceWindow maintenance_window = 13 [(.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 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.v1beta1.MaintenanceWindow maintenance_window = 13 [(.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The environmentSize.
    • 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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.RecoveryConfig recovery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
    • hasDataRetentionConfig

      boolean hasDataRetentionConfig()
       Optional. The configuration setting for Airflow database data retention
       mechanism.
       
      .google.cloud.orchestration.airflow.service.v1beta1.DataRetentionConfig data_retention_config = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the dataRetentionConfig field is set.
    • getDataRetentionConfig

      DataRetentionConfig getDataRetentionConfig()
       Optional. The configuration setting for Airflow database data retention
       mechanism.
       
      .google.cloud.orchestration.airflow.service.v1beta1.DataRetentionConfig data_retention_config = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The dataRetentionConfig.
    • getDataRetentionConfigOrBuilder

      DataRetentionConfigOrBuilder getDataRetentionConfigOrBuilder()
       Optional. The configuration setting for Airflow database data retention
       mechanism.
       
      .google.cloud.orchestration.airflow.service.v1beta1.DataRetentionConfig data_retention_config = 19 [(.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.v1beta1.EnvironmentConfig.ResilienceMode resilience_mode = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for 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:
      The resilienceMode.