- 1.52.0 (latest)
- 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 final class EnvironmentConfig extends GeneratedMessageV3 implements EnvironmentConfigOrBuilder
Configuration information for an environment.
Protobuf type google.cloud.orchestration.airflow.service.v1.EnvironmentConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EnvironmentConfigImplements
EnvironmentConfigOrBuilderStatic Fields
AIRFLOW_BYOID_URI_FIELD_NUMBER
public static final int AIRFLOW_BYOID_URI_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
AIRFLOW_URI_FIELD_NUMBER
public static final int AIRFLOW_URI_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DAG_GCS_PREFIX_FIELD_NUMBER
public static final int DAG_GCS_PREFIX_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DATABASE_CONFIG_FIELD_NUMBER
public static final int DATABASE_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DATA_RETENTION_CONFIG_FIELD_NUMBER
public static final int DATA_RETENTION_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ENVIRONMENT_SIZE_FIELD_NUMBER
public static final int ENVIRONMENT_SIZE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
GKE_CLUSTER_FIELD_NUMBER
public static final int GKE_CLUSTER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MAINTENANCE_WINDOW_FIELD_NUMBER
public static final int MAINTENANCE_WINDOW_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MASTER_AUTHORIZED_NETWORKS_CONFIG_FIELD_NUMBER
public static final int MASTER_AUTHORIZED_NETWORKS_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NODE_CONFIG_FIELD_NUMBER
public static final int NODE_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NODE_COUNT_FIELD_NUMBER
public static final int NODE_COUNT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PRIVATE_ENVIRONMENT_CONFIG_FIELD_NUMBER
public static final int PRIVATE_ENVIRONMENT_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RECOVERY_CONFIG_FIELD_NUMBER
public static final int RECOVERY_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RESILIENCE_MODE_FIELD_NUMBER
public static final int RESILIENCE_MODE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SOFTWARE_CONFIG_FIELD_NUMBER
public static final int SOFTWARE_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
WEB_SERVER_CONFIG_FIELD_NUMBER
public static final int WEB_SERVER_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
WEB_SERVER_NETWORK_ACCESS_CONTROL_FIELD_NUMBER
public static final int WEB_SERVER_NETWORK_ACCESS_CONTROL_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
WORKLOADS_CONFIG_FIELD_NUMBER
public static final int WORKLOADS_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static EnvironmentConfig getDefaultInstance()
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static EnvironmentConfig.Builder newBuilder()
Returns | |
---|---|
Type | Description |
EnvironmentConfig.Builder |
newBuilder(EnvironmentConfig prototype)
public static EnvironmentConfig.Builder newBuilder(EnvironmentConfig prototype)
Parameter | |
---|---|
Name | Description |
prototype |
EnvironmentConfig |
Returns | |
---|---|
Type | Description |
EnvironmentConfig.Builder |
parseDelimitedFrom(InputStream input)
public static EnvironmentConfig parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static EnvironmentConfig parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static EnvironmentConfig parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static EnvironmentConfig parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static EnvironmentConfig parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static EnvironmentConfig parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
EnvironmentConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<EnvironmentConfig> parser()
Returns | |
---|---|
Type | Description |
Parser<EnvironmentConfig> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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. |
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. |
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 |
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. |
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. |
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. |
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. |
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. |
getParserForType()
public Parser<EnvironmentConfig> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<EnvironmentConfig> |
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. |
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. |
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. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
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. |
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. |
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. |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public EnvironmentConfig.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
EnvironmentConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EnvironmentConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
EnvironmentConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public EnvironmentConfig.Builder toBuilder()
Returns | |
---|---|
Type | Description |
EnvironmentConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |