Class PrivateEnvironmentConfig (1.12.0) 

public final class PrivateEnvironmentConfig extends GeneratedMessageV3 implements PrivateEnvironmentConfigOrBuilder

The configuration information for configuring a Private IP Cloud Composer environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PrivateEnvironmentConfig

Static Fields

CLOUD_COMPOSER_CONNECTION_SUBNETWORK_FIELD_NUMBER

public static final int CLOUD_COMPOSER_CONNECTION_SUBNETWORK_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_COMPOSER_NETWORK_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int CLOUD_COMPOSER_NETWORK_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_COMPOSER_NETWORK_IPV4_RESERVED_RANGE_FIELD_NUMBER

public static final int CLOUD_COMPOSER_NETWORK_IPV4_RESERVED_RANGE_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_SQL_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int CLOUD_SQL_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PRIVATELY_USED_PUBLIC_IPS_FIELD_NUMBER

public static final int ENABLE_PRIVATELY_USED_PUBLIC_IPS_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PRIVATE_ENVIRONMENT_FIELD_NUMBER

public static final int ENABLE_PRIVATE_ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

NETWORKING_CONFIG_FIELD_NUMBER

public static final int NETWORKING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER

public static final int PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

WEB_SERVER_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int WEB_SERVER_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

WEB_SERVER_IPV4_RESERVED_RANGE_FIELD_NUMBER

public static final int WEB_SERVER_IPV4_RESERVED_RANGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrivateEnvironmentConfig getDefaultInstance()
Returns
Type Description
PrivateEnvironmentConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PrivateEnvironmentConfig.Builder newBuilder()
Returns
Type Description
PrivateEnvironmentConfig.Builder

newBuilder(PrivateEnvironmentConfig prototype)

public static PrivateEnvironmentConfig.Builder newBuilder(PrivateEnvironmentConfig prototype)
Parameter
Name Description
prototype PrivateEnvironmentConfig
Returns
Type Description
PrivateEnvironmentConfig.Builder

parseDelimitedFrom(InputStream input)

public static PrivateEnvironmentConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateEnvironmentConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PrivateEnvironmentConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PrivateEnvironmentConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PrivateEnvironmentConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PrivateEnvironmentConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PrivateEnvironmentConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateEnvironmentConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PrivateEnvironmentConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateEnvironmentConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PrivateEnvironmentConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PrivateEnvironmentConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateEnvironmentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PrivateEnvironmentConfig> parser()
Returns
Type Description
Parser<PrivateEnvironmentConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCloudComposerConnectionSubnetwork()

public String getCloudComposerConnectionSubnetwork()

Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.

string cloud_composer_connection_subnetwork = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cloudComposerConnectionSubnetwork.

getCloudComposerConnectionSubnetworkBytes()

public ByteString getCloudComposerConnectionSubnetworkBytes()

Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.

string cloud_composer_connection_subnetwork = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cloudComposerConnectionSubnetwork.

getCloudComposerNetworkIpv4CidrBlock()

public String getCloudComposerNetworkIpv4CidrBlock()

Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

string cloud_composer_network_ipv4_cidr_block = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cloudComposerNetworkIpv4CidrBlock.

getCloudComposerNetworkIpv4CidrBlockBytes()

public ByteString getCloudComposerNetworkIpv4CidrBlockBytes()

Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

string cloud_composer_network_ipv4_cidr_block = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cloudComposerNetworkIpv4CidrBlock.

getCloudComposerNetworkIpv4ReservedRange()

public String getCloudComposerNetworkIpv4ReservedRange()

Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

string cloud_composer_network_ipv4_reserved_range = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The cloudComposerNetworkIpv4ReservedRange.

getCloudComposerNetworkIpv4ReservedRangeBytes()

public ByteString getCloudComposerNetworkIpv4ReservedRangeBytes()

Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

string cloud_composer_network_ipv4_reserved_range = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for cloudComposerNetworkIpv4ReservedRange.

getCloudSqlIpv4CidrBlock()

public String getCloudSqlIpv4CidrBlock()

Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.

string cloud_sql_ipv4_cidr_block = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cloudSqlIpv4CidrBlock.

getCloudSqlIpv4CidrBlockBytes()

public ByteString getCloudSqlIpv4CidrBlockBytes()

Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.

string cloud_sql_ipv4_cidr_block = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cloudSqlIpv4CidrBlock.

getDefaultInstanceForType()

public PrivateEnvironmentConfig getDefaultInstanceForType()
Returns
Type Description
PrivateEnvironmentConfig

getEnablePrivateEnvironment()

public boolean getEnablePrivateEnvironment()

Optional. If true, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.

bool enable_private_environment = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enablePrivateEnvironment.

getEnablePrivatelyUsedPublicIps()

public boolean getEnablePrivatelyUsedPublicIps()

Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block and IPAllocationPolicy.service_ipv4_cidr_block.

bool enable_privately_used_public_ips = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enablePrivatelyUsedPublicIps.

getNetworkingConfig()

public NetworkingConfig getNetworkingConfig()

Optional. Configuration for the network connections configuration in the environment.

.google.cloud.orchestration.airflow.service.v1.NetworkingConfig networking_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NetworkingConfig

The networkingConfig.

getNetworkingConfigOrBuilder()

public NetworkingConfigOrBuilder getNetworkingConfigOrBuilder()

Optional. Configuration for the network connections configuration in the environment.

.google.cloud.orchestration.airflow.service.v1.NetworkingConfig networking_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NetworkingConfigOrBuilder

getParserForType()

public Parser<PrivateEnvironmentConfig> getParserForType()
Returns
Type Description
Parser<PrivateEnvironmentConfig>
Overrides

getPrivateClusterConfig()

public PrivateClusterConfig getPrivateClusterConfig()

Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

.google.cloud.orchestration.airflow.service.v1.PrivateClusterConfig private_cluster_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateClusterConfig

The privateClusterConfig.

getPrivateClusterConfigOrBuilder()

public PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()

Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

.google.cloud.orchestration.airflow.service.v1.PrivateClusterConfig private_cluster_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivateClusterConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getWebServerIpv4CidrBlock()

public String getWebServerIpv4CidrBlock()

Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

string web_server_ipv4_cidr_block = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The webServerIpv4CidrBlock.

getWebServerIpv4CidrBlockBytes()

public ByteString getWebServerIpv4CidrBlockBytes()

Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

string web_server_ipv4_cidr_block = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for webServerIpv4CidrBlock.

getWebServerIpv4ReservedRange()

public String getWebServerIpv4ReservedRange()

Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

string web_server_ipv4_reserved_range = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The webServerIpv4ReservedRange.

getWebServerIpv4ReservedRangeBytes()

public ByteString getWebServerIpv4ReservedRangeBytes()

Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

string web_server_ipv4_reserved_range = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for webServerIpv4ReservedRange.

hasNetworkingConfig()

public boolean hasNetworkingConfig()

Optional. Configuration for the network connections configuration in the environment.

.google.cloud.orchestration.airflow.service.v1.NetworkingConfig networking_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the networkingConfig field is set.

hasPrivateClusterConfig()

public boolean hasPrivateClusterConfig()

Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

.google.cloud.orchestration.airflow.service.v1.PrivateClusterConfig private_cluster_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the privateClusterConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PrivateEnvironmentConfig.Builder newBuilderForType()
Returns
Type Description
PrivateEnvironmentConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PrivateEnvironmentConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PrivateEnvironmentConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PrivateEnvironmentConfig.Builder toBuilder()
Returns
Type Description
PrivateEnvironmentConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException