Class EnvironmentConfig (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 > EnvironmentConfig

Implements

EnvironmentConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

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

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER

Field Value

Type	Description
int

GKE_CLUSTER_FIELD_NUMBER

public static final int GKE_CLUSTER_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

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

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

Overrides

AbstractMessage.equals(Object other)

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()

string dag_gcs_prefix = 2;

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.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

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.

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.

int32 node_count = 3;

Returns

Type	Description
int	The nodeCount.

getParserForType()

public Parser<EnvironmentConfig> getParserForType()

Returns

Type	Description
Parser<EnvironmentConfig>

Overrides

GeneratedMessageV3.getParserForType()

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

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

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.

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.

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.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public EnvironmentConfig.Builder toBuilder()

Returns

Type	Description
EnvironmentConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException