Class EnvironmentConfig (1.7.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.78.0 (latest)
- 1.76.0
- 1.75.0
- 1.74.0
- 1.73.0
- 1.72.0
- 1.70.0
- 1.68.0
- 1.67.0
- 1.64.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 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
publicfinalclass EnvironmentConfigextendsGeneratedMessageV3implementsEnvironmentConfigOrBuilderConfiguration information for an environment.
Protobuf type google.cloud.orchestration.airflow.service.v1.EnvironmentConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EnvironmentConfigImplements
EnvironmentConfigOrBuilderInherited Members
Static Fields
AIRFLOW_URI_FIELD_NUMBER
publicstaticfinalintAIRFLOW_URI_FIELD_NUMBERDAG_GCS_PREFIX_FIELD_NUMBER
publicstaticfinalintDAG_GCS_PREFIX_FIELD_NUMBERDATABASE_CONFIG_FIELD_NUMBER
publicstaticfinalintDATABASE_CONFIG_FIELD_NUMBERENCRYPTION_CONFIG_FIELD_NUMBER
publicstaticfinalintENCRYPTION_CONFIG_FIELD_NUMBERENVIRONMENT_SIZE_FIELD_NUMBER
publicstaticfinalintENVIRONMENT_SIZE_FIELD_NUMBERGKE_CLUSTER_FIELD_NUMBER
publicstaticfinalintGKE_CLUSTER_FIELD_NUMBERMAINTENANCE_WINDOW_FIELD_NUMBER
publicstaticfinalintMAINTENANCE_WINDOW_FIELD_NUMBERMASTER_AUTHORIZED_NETWORKS_CONFIG_FIELD_NUMBER
publicstaticfinalintMASTER_AUTHORIZED_NETWORKS_CONFIG_FIELD_NUMBERNODE_CONFIG_FIELD_NUMBER
publicstaticfinalintNODE_CONFIG_FIELD_NUMBERNODE_COUNT_FIELD_NUMBER
publicstaticfinalintNODE_COUNT_FIELD_NUMBERPRIVATE_ENVIRONMENT_CONFIG_FIELD_NUMBER
publicstaticfinalintPRIVATE_ENVIRONMENT_CONFIG_FIELD_NUMBERRECOVERY_CONFIG_FIELD_NUMBER
publicstaticfinalintRECOVERY_CONFIG_FIELD_NUMBERSOFTWARE_CONFIG_FIELD_NUMBER
publicstaticfinalintSOFTWARE_CONFIG_FIELD_NUMBERWEB_SERVER_CONFIG_FIELD_NUMBER
publicstaticfinalintWEB_SERVER_CONFIG_FIELD_NUMBERWEB_SERVER_NETWORK_ACCESS_CONTROL_FIELD_NUMBER
publicstaticfinalintWEB_SERVER_NETWORK_ACCESS_CONTROL_FIELD_NUMBERWORKLOADS_CONFIG_FIELD_NUMBER
publicstaticfinalintWORKLOADS_CONFIG_FIELD_NUMBERStatic Methods
getDefaultInstance()
publicstaticEnvironmentConfiggetDefaultInstance()getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()newBuilder()
publicstaticEnvironmentConfig.BuildernewBuilder()newBuilder(EnvironmentConfig prototype)
publicstaticEnvironmentConfig.BuildernewBuilder(EnvironmentConfigprototype)parseDelimitedFrom(InputStream input)
publicstaticEnvironmentConfigparseDelimitedFrom(InputStreaminput)parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticEnvironmentConfigparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(byte[] data)
publicstaticEnvironmentConfigparseFrom(byte[]data)byte[]parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticEnvironmentConfigparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)byte[]parseFrom(ByteString data)
publicstaticEnvironmentConfigparseFrom(ByteStringdata)parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticEnvironmentConfigparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)parseFrom(CodedInputStream input)
publicstaticEnvironmentConfigparseFrom(CodedInputStreaminput)parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticEnvironmentConfigparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(InputStream input)
publicstaticEnvironmentConfigparseFrom(InputStreaminput)parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticEnvironmentConfigparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(ByteBuffer data)
publicstaticEnvironmentConfigparseFrom(ByteBufferdata)parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticEnvironmentConfigparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)parser()
publicstaticParser<EnvironmentConfig>parser()Methods
equals(Object obj)
publicbooleanequals(Objectobj)getAirflowUri()
publicStringgetAirflowUri()Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
string airflow_uri = 6;
The airflowUri.
getAirflowUriBytes()
publicByteStringgetAirflowUriBytes()Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
string airflow_uri = 6;
The bytes for airflowUri.
getDagGcsPrefix()
publicStringgetDagGcsPrefix()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;
The dagGcsPrefix.
getDagGcsPrefixBytes()
publicByteStringgetDagGcsPrefixBytes()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;
The bytes for dagGcsPrefix.
getDatabaseConfig()
publicDatabaseConfiggetDatabaseConfig()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];
The databaseConfig.
getDatabaseConfigOrBuilder()
publicDatabaseConfigOrBuildergetDatabaseConfigOrBuilder()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];
getDefaultInstanceForType()
publicEnvironmentConfiggetDefaultInstanceForType()getEncryptionConfig()
publicEncryptionConfiggetEncryptionConfig()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];
The encryptionConfig.
getEncryptionConfigOrBuilder()
publicEncryptionConfigOrBuildergetEncryptionConfigOrBuilder()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];
getEnvironmentSize()
publicEnvironmentConfig.EnvironmentSizegetEnvironmentSize()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];
The environmentSize.
getEnvironmentSizeValue()
publicintgetEnvironmentSizeValue()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];
The enum numeric value on the wire for environmentSize.
getGkeCluster()
publicStringgetGkeCluster()Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1;
The gkeCluster.
getGkeClusterBytes()
publicByteStringgetGkeClusterBytes()Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1;
The bytes for gkeCluster.
getMaintenanceWindow()
publicMaintenanceWindowgetMaintenanceWindow()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];
The maintenanceWindow.
getMaintenanceWindowOrBuilder()
publicMaintenanceWindowOrBuildergetMaintenanceWindowOrBuilder()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];
getMasterAuthorizedNetworksConfig()
publicMasterAuthorizedNetworksConfiggetMasterAuthorizedNetworksConfig()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];
The masterAuthorizedNetworksConfig.
getMasterAuthorizedNetworksConfigOrBuilder()
publicMasterAuthorizedNetworksConfigOrBuildergetMasterAuthorizedNetworksConfigOrBuilder()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];
getNodeConfig()
publicNodeConfiggetNodeConfig()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
The nodeConfig.
getNodeConfigOrBuilder()
publicNodeConfigOrBuildergetNodeConfigOrBuilder()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
getNodeCount()
publicintgetNodeCount()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;
The nodeCount.
getParserForType()
publicParser<EnvironmentConfig>getParserForType()getPrivateEnvironmentConfig()
publicPrivateEnvironmentConfiggetPrivateEnvironmentConfig()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
The privateEnvironmentConfig.
getPrivateEnvironmentConfigOrBuilder()
publicPrivateEnvironmentConfigOrBuildergetPrivateEnvironmentConfigOrBuilder()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
getRecoveryConfig()
publicRecoveryConfiggetRecoveryConfig()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];
The recoveryConfig.
getRecoveryConfigOrBuilder()
publicRecoveryConfigOrBuildergetRecoveryConfigOrBuilder()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];
getSerializedSize()
publicintgetSerializedSize()getSoftwareConfig()
publicSoftwareConfiggetSoftwareConfig()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
The softwareConfig.
getSoftwareConfigOrBuilder()
publicSoftwareConfigOrBuildergetSoftwareConfigOrBuilder()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()getWebServerConfig()
publicWebServerConfiggetWebServerConfig()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];
The webServerConfig.
getWebServerConfigOrBuilder()
publicWebServerConfigOrBuildergetWebServerConfigOrBuilder()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];
getWebServerNetworkAccessControl()
publicWebServerNetworkAccessControlgetWebServerNetworkAccessControl()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];
The webServerNetworkAccessControl.
getWebServerNetworkAccessControlOrBuilder()
publicWebServerNetworkAccessControlOrBuildergetWebServerNetworkAccessControlOrBuilder()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];
getWorkloadsConfig()
publicWorkloadsConfiggetWorkloadsConfig()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];
The workloadsConfig.
getWorkloadsConfigOrBuilder()
publicWorkloadsConfigOrBuildergetWorkloadsConfigOrBuilder()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];
hasDatabaseConfig()
publicbooleanhasDatabaseConfig()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];
Whether the databaseConfig field is set.
hasEncryptionConfig()
publicbooleanhasEncryptionConfig()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];
Whether the encryptionConfig field is set.
hasMaintenanceWindow()
publicbooleanhasMaintenanceWindow()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];
Whether the maintenanceWindow field is set.
hasMasterAuthorizedNetworksConfig()
publicbooleanhasMasterAuthorizedNetworksConfig()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];
Whether the masterAuthorizedNetworksConfig field is set.
hasNodeConfig()
publicbooleanhasNodeConfig()The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1.NodeConfig node_config = 5;
Whether the nodeConfig field is set.
hasPrivateEnvironmentConfig()
publicbooleanhasPrivateEnvironmentConfig()The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig private_environment_config = 7;
Whether the privateEnvironmentConfig field is set.
hasRecoveryConfig()
publicbooleanhasRecoveryConfig()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];
Whether the recoveryConfig field is set.
hasSoftwareConfig()
publicbooleanhasSoftwareConfig()The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig software_config = 4;
Whether the softwareConfig field is set.
hasWebServerConfig()
publicbooleanhasWebServerConfig()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];
Whether the webServerConfig field is set.
hasWebServerNetworkAccessControl()
publicbooleanhasWebServerNetworkAccessControl()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];
Whether the webServerNetworkAccessControl field is set.
hasWorkloadsConfig()
publicbooleanhasWorkloadsConfig()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];
Whether the workloadsConfig field is set.
hashCode()
publicinthashCode()internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()isInitialized()
publicfinalbooleanisInitialized()newBuilderForType()
publicEnvironmentConfig.BuildernewBuilderForType()newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedEnvironmentConfig.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)toBuilder()
publicEnvironmentConfig.BuildertoBuilder()writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)