public final class EnvironmentConfig extends GeneratedMessageV3 implements EnvironmentConfigOrBuilder
Configuration information for an environment.
Protobuf type google.cloud.orchestration.airflow.service.v1beta1.EnvironmentConfig
Static Fields
AIRFLOW_URI_FIELD_NUMBER
public static final int AIRFLOW_URI_FIELD_NUMBER
Field Value
DAG_GCS_PREFIX_FIELD_NUMBER
public static final int DAG_GCS_PREFIX_FIELD_NUMBER
Field Value
DATABASE_CONFIG_FIELD_NUMBER
public static final int DATABASE_CONFIG_FIELD_NUMBER
Field Value
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
ENVIRONMENT_SIZE_FIELD_NUMBER
public static final int ENVIRONMENT_SIZE_FIELD_NUMBER
Field Value
GKE_CLUSTER_FIELD_NUMBER
public static final int GKE_CLUSTER_FIELD_NUMBER
Field Value
MAINTENANCE_WINDOW_FIELD_NUMBER
public static final int MAINTENANCE_WINDOW_FIELD_NUMBER
Field Value
NODE_CONFIG_FIELD_NUMBER
public static final int NODE_CONFIG_FIELD_NUMBER
Field Value
NODE_COUNT_FIELD_NUMBER
public static final int NODE_COUNT_FIELD_NUMBER
Field Value
PRIVATE_ENVIRONMENT_CONFIG_FIELD_NUMBER
public static final int PRIVATE_ENVIRONMENT_CONFIG_FIELD_NUMBER
Field Value
SOFTWARE_CONFIG_FIELD_NUMBER
public static final int SOFTWARE_CONFIG_FIELD_NUMBER
Field Value
WEB_SERVER_CONFIG_FIELD_NUMBER
public static final int WEB_SERVER_CONFIG_FIELD_NUMBER
Field Value
WEB_SERVER_NETWORK_ACCESS_CONTROL_FIELD_NUMBER
public static final int WEB_SERVER_NETWORK_ACCESS_CONTROL_FIELD_NUMBER
Field Value
WORKLOADS_CONFIG_FIELD_NUMBER
public static final int WORKLOADS_CONFIG_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static EnvironmentConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static EnvironmentConfig.Builder newBuilder()
Returns
newBuilder(EnvironmentConfig prototype)
public static EnvironmentConfig.Builder newBuilder(EnvironmentConfig prototype)
Parameter
Returns
public static EnvironmentConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static EnvironmentConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static EnvironmentConfig parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static EnvironmentConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EnvironmentConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static EnvironmentConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EnvironmentConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static EnvironmentConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static EnvironmentConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EnvironmentConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<EnvironmentConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type |
Description |
ByteString |
The bytes for dagGcsPrefix.
|
getDatabaseConfig()
public 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
getDatabaseConfigOrBuilder()
public DatabaseConfigOrBuilder getDatabaseConfigOrBuilder()
Optional. The configuration settings for Cloud SQL instance used internally by Apache
Airflow software.
.google.cloud.orchestration.airflow.service.v1beta1.DatabaseConfig database_config = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns
getDefaultInstanceForType()
public EnvironmentConfig getDefaultInstanceForType()
Returns
getEncryptionConfig()
public 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
getEncryptionConfigOrBuilder()
public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
Optional. The encryption options for the Cloud Composer environment and its
dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1beta1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.v1beta1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.v1beta1.EnvironmentConfig.EnvironmentSize environment_size = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
int |
The enum numeric value on the wire for environmentSize.
|
getGkeCluster()
public String getGkeCluster()
Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type |
Description |
String |
The gkeCluster.
|
getGkeClusterBytes()
public ByteString getGkeClusterBytes()
Output only. The Kubernetes Engine cluster used to run this environment.
string gke_cluster = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type |
Description |
ByteString |
The bytes for gkeCluster.
|
getMaintenanceWindow()
public MaintenanceWindow getMaintenanceWindow()
Optional. The maintenance window is the period when Cloud Composer components may
undergo maintenance. It is defined so that maintenance is not executed
during peak hours or critical time periods.
The system will not be under maintenance for every occurrence of this
window, but when maintenance is planned, it will be scheduled
during the window.
The maintenance window period must encompass at least 12 hours per week.
This may be split into multiple chunks, each with a size of
at least 4 hours.
If this value is omitted, Cloud Composer components may be subject to
maintenance at any time.
.google.cloud.orchestration.airflow.service.v1beta1.MaintenanceWindow maintenance_window = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns
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, Cloud Composer components may be subject to
maintenance at any time.
.google.cloud.orchestration.airflow.service.v1beta1.MaintenanceWindow maintenance_window = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns
getNodeConfig()
public NodeConfig getNodeConfig()
The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5;
Returns
getNodeConfigOrBuilder()
public NodeConfigOrBuilder getNodeConfigOrBuilder()
The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5;
Returns
getNodeCount()
public int getNodeCount()
The number of nodes in the Kubernetes Engine cluster that will be
used to run this environment.
int32 node_count = 3;
Returns
Type |
Description |
int |
The nodeCount.
|
getParserForType()
public Parser<EnvironmentConfig> getParserForType()
Returns
Overrides
getPrivateEnvironmentConfig()
public PrivateEnvironmentConfig getPrivateEnvironmentConfig()
The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7;
Returns
getPrivateEnvironmentConfigOrBuilder()
public PrivateEnvironmentConfigOrBuilder getPrivateEnvironmentConfigOrBuilder()
The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSoftwareConfig()
public SoftwareConfig getSoftwareConfig()
The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4;
Returns
getSoftwareConfigOrBuilder()
public SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()
The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getWebServerConfig()
public WebServerConfig getWebServerConfig()
Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1beta1.WebServerConfig web_server_config = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns
getWebServerConfigOrBuilder()
public WebServerConfigOrBuilder getWebServerConfigOrBuilder()
Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1beta1.WebServerConfig web_server_config = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.v1beta1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.v1beta1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
Returns
hasDatabaseConfig()
public boolean hasDatabaseConfig()
Optional. The configuration settings for Cloud SQL instance used internally by Apache
Airflow software.
.google.cloud.orchestration.airflow.service.v1beta1.DatabaseConfig database_config = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
boolean |
Whether the databaseConfig field is set.
|
hasEncryptionConfig()
public boolean hasEncryptionConfig()
Optional. The encryption options for the Cloud Composer environment and its
dependencies. Cannot be updated.
.google.cloud.orchestration.airflow.service.v1beta1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
boolean |
Whether the encryptionConfig field is set.
|
hasMaintenanceWindow()
public boolean hasMaintenanceWindow()
Optional. The maintenance window is the period when Cloud Composer components may
undergo maintenance. It is defined so that maintenance is not executed
during peak hours or critical time periods.
The system will not be under maintenance for every occurrence of this
window, but when maintenance is planned, it will be scheduled
during the window.
The maintenance window period must encompass at least 12 hours per week.
This may be split into multiple chunks, each with a size of
at least 4 hours.
If this value is omitted, Cloud Composer components may be subject to
maintenance at any time.
.google.cloud.orchestration.airflow.service.v1beta1.MaintenanceWindow maintenance_window = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
boolean |
Whether the maintenanceWindow field is set.
|
hasNodeConfig()
public boolean hasNodeConfig()
The configuration used for the Kubernetes Engine cluster.
.google.cloud.orchestration.airflow.service.v1beta1.NodeConfig node_config = 5;
Returns
Type |
Description |
boolean |
Whether the nodeConfig field is set.
|
hasPrivateEnvironmentConfig()
public boolean hasPrivateEnvironmentConfig()
The configuration used for the Private IP Cloud Composer environment.
.google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig private_environment_config = 7;
Returns
Type |
Description |
boolean |
Whether the privateEnvironmentConfig field is set.
|
hasSoftwareConfig()
public boolean hasSoftwareConfig()
The configuration settings for software inside the environment.
.google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig software_config = 4;
Returns
Type |
Description |
boolean |
Whether the softwareConfig field is set.
|
hasWebServerConfig()
public boolean hasWebServerConfig()
Optional. The configuration settings for the Airflow web server App Engine instance.
.google.cloud.orchestration.airflow.service.v1beta1.WebServerConfig web_server_config = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
boolean |
Whether the webServerConfig field is set.
|
hasWebServerNetworkAccessControl()
public boolean hasWebServerNetworkAccessControl()
Optional. The network-level access control policy for the Airflow web server. If
unspecified, no network-level access restrictions will be applied.
.google.cloud.orchestration.airflow.service.v1beta1.WebServerNetworkAccessControl web_server_network_access_control = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
boolean |
Whether the webServerNetworkAccessControl field is set.
|
hasWorkloadsConfig()
public boolean hasWorkloadsConfig()
Optional. The workloads configuration settings for the GKE cluster associated with
the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web
server and workers workloads.
This field is supported for Cloud Composer environments in versions
composer-2..-airflow-..* and newer.
.google.cloud.orchestration.airflow.service.v1beta1.WorkloadsConfig workloads_config = 15 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type |
Description |
boolean |
Whether the workloadsConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public EnvironmentConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EnvironmentConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public EnvironmentConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions