Interface IpConfigurationOrBuilder (0.1.0)

public interface IpConfigurationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllocatedIpRange()

public abstract String getAllocatedIpRange()

The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.

string allocated_ip_range = 6;

Returns
Type	Description
`String`	The allocatedIpRange.

getAllocatedIpRangeBytes()

public abstract ByteString getAllocatedIpRangeBytes()

The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.

string allocated_ip_range = 6;

Returns
Type	Description
`ByteString`	The bytes for allocatedIpRange.

getAuthorizedNetworks(int index)

public abstract AclEntry getAuthorizedNetworks(int index)

The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: 157.197.200.0/24).

repeated .google.cloud.sql.v1beta4.AclEntry authorized_networks = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AclEntry`

getAuthorizedNetworksCount()

public abstract int getAuthorizedNetworksCount()

The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: 157.197.200.0/24).

repeated .google.cloud.sql.v1beta4.AclEntry authorized_networks = 4;

Returns
Type	Description
`int`

getAuthorizedNetworksList()

public abstract List<AclEntry> getAuthorizedNetworksList()

The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: 157.197.200.0/24).

repeated .google.cloud.sql.v1beta4.AclEntry authorized_networks = 4;

Returns
Type	Description
`List<AclEntry>`

getAuthorizedNetworksOrBuilder(int index)

public abstract AclEntryOrBuilder getAuthorizedNetworksOrBuilder(int index)

The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: 157.197.200.0/24).

repeated .google.cloud.sql.v1beta4.AclEntry authorized_networks = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AclEntryOrBuilder`

getAuthorizedNetworksOrBuilderList()

public abstract List<? extends AclEntryOrBuilder> getAuthorizedNetworksOrBuilderList()

The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: 157.197.200.0/24).

repeated .google.cloud.sql.v1beta4.AclEntry authorized_networks = 4;

Returns
Type	Description
`List<? extends com.google.cloud.sql.v1beta4.AclEntryOrBuilder>`

getCustomSubjectAlternativeNames(int index)

public abstract String getCustomSubjectAlternativeNames(int index)

Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.

repeated string custom_subject_alternative_names = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The customSubjectAlternativeNames at the given index.

getCustomSubjectAlternativeNamesBytes(int index)

public abstract ByteString getCustomSubjectAlternativeNamesBytes(int index)

Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.

repeated string custom_subject_alternative_names = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the customSubjectAlternativeNames at the given index.

getCustomSubjectAlternativeNamesCount()

public abstract int getCustomSubjectAlternativeNamesCount()

Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.

repeated string custom_subject_alternative_names = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of customSubjectAlternativeNames.

getCustomSubjectAlternativeNamesList()

public abstract List<String> getCustomSubjectAlternativeNamesList()

Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.

repeated string custom_subject_alternative_names = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<String>`	A list containing the customSubjectAlternativeNames.

getEnablePrivatePathForGoogleCloudServices()

public abstract BoolValue getEnablePrivatePathForGoogleCloudServices()

Controls connectivity to private IP instances from Google services, such as BigQuery.

.google.protobuf.BoolValue enable_private_path_for_google_cloud_services = 7;

Returns
Type	Description
`BoolValue`	The enablePrivatePathForGoogleCloudServices.

getEnablePrivatePathForGoogleCloudServicesOrBuilder()

public abstract BoolValueOrBuilder getEnablePrivatePathForGoogleCloudServicesOrBuilder()

Controls connectivity to private IP instances from Google services, such as BigQuery.

.google.protobuf.BoolValue enable_private_path_for_google_cloud_services = 7;

Returns
Type	Description
`BoolValueOrBuilder`

getIpv4Enabled()

public abstract BoolValue getIpv4Enabled()

Whether the instance is assigned a public IP address or not.

.google.protobuf.BoolValue ipv4_enabled = 1;

Returns
Type	Description
`BoolValue`	The ipv4Enabled.

getIpv4EnabledOrBuilder()

public abstract BoolValueOrBuilder getIpv4EnabledOrBuilder()

Whether the instance is assigned a public IP address or not.

.google.protobuf.BoolValue ipv4_enabled = 1;

Returns
Type	Description
`BoolValueOrBuilder`

getPrivateNetwork()

public abstract String getPrivateNetwork()

The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.

string private_network = 2;

Returns
Type	Description
`String`	The privateNetwork.

getPrivateNetworkBytes()

public abstract ByteString getPrivateNetworkBytes()

The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.

string private_network = 2;

Returns
Type	Description
`ByteString`	The bytes for privateNetwork.

getPscConfig()

public abstract PscConfig getPscConfig()

PSC settings for this instance.

optional .google.cloud.sql.v1beta4.PscConfig psc_config = 9;

Returns
Type	Description
`PscConfig`	The pscConfig.

getPscConfigOrBuilder()

public abstract PscConfigOrBuilder getPscConfigOrBuilder()

PSC settings for this instance.

optional .google.cloud.sql.v1beta4.PscConfig psc_config = 9;

Returns
Type	Description
`PscConfigOrBuilder`

getRequireSsl()

public abstract BoolValue getRequireSsl()

Use ssl_mode instead.

Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the legacy require_ssl flag.

.google.protobuf.BoolValue require_ssl = 3;

Returns
Type	Description
`BoolValue`	The requireSsl.

getRequireSslOrBuilder()

public abstract BoolValueOrBuilder getRequireSslOrBuilder()

Use ssl_mode instead.

Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the legacy require_ssl flag.

.google.protobuf.BoolValue require_ssl = 3;

Returns
Type	Description
`BoolValueOrBuilder`

getServerCaMode()

public abstract IpConfiguration.CaMode getServerCaMode()

Specify what type of CA is used for the server certificate.

optional .google.cloud.sql.v1beta4.IpConfiguration.CaMode server_ca_mode = 10;

Returns
Type	Description
`IpConfiguration.CaMode`	The serverCaMode.

getServerCaModeValue()

public abstract int getServerCaModeValue()

Specify what type of CA is used for the server certificate.

optional .google.cloud.sql.v1beta4.IpConfiguration.CaMode server_ca_mode = 10;

Returns
Type	Description
`int`	The enum numeric value on the wire for serverCaMode.

getServerCaPool()

public abstract String getServerCaPool()

Optional. The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}

optional string server_ca_pool = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The serverCaPool.

getServerCaPoolBytes()

public abstract ByteString getServerCaPoolBytes()

Optional. The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}

optional string server_ca_pool = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for serverCaPool.

getServerCertificateRotationMode()

public abstract IpConfiguration.ServerCertificateRotationMode getServerCertificateRotationMode()

Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.

optional .google.cloud.sql.v1beta4.IpConfiguration.ServerCertificateRotationMode server_certificate_rotation_mode = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`IpConfiguration.ServerCertificateRotationMode`	The serverCertificateRotationMode.

getServerCertificateRotationModeValue()

public abstract int getServerCertificateRotationModeValue()

Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.

optional .google.cloud.sql.v1beta4.IpConfiguration.ServerCertificateRotationMode server_certificate_rotation_mode = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for serverCertificateRotationMode.

getSslMode()

public abstract IpConfiguration.SslMode getSslMode()

Specify how SSL/TLS is enforced in database connections. If you must use the require_ssl flag for backward compatibility, then only the following value pairs are valid:

For PostgreSQL and MySQL:

ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
ssl_mode=ENCRYPTED_ONLY and require_ssl=false
ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED and require_ssl=true

For SQL Server:
ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
ssl_mode=ENCRYPTED_ONLY and require_ssl=true

The value of ssl_mode has priority over the value of require_ssl.

For example, for the pair ssl_mode=ENCRYPTED_ONLY and require_ssl=false, ssl_mode=ENCRYPTED_ONLY means accept only SSL connections, while require_ssl=false means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect ssl_mode and accepts only SSL connections.

.google.cloud.sql.v1beta4.IpConfiguration.SslMode ssl_mode = 8;

Returns
Type	Description
`IpConfiguration.SslMode`	The sslMode.

getSslModeValue()

public abstract int getSslModeValue()

Specify how SSL/TLS is enforced in database connections. If you must use the require_ssl flag for backward compatibility, then only the following value pairs are valid:

For PostgreSQL and MySQL:

ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
ssl_mode=ENCRYPTED_ONLY and require_ssl=false
ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED and require_ssl=true

For SQL Server:
ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false
ssl_mode=ENCRYPTED_ONLY and require_ssl=true

The value of ssl_mode has priority over the value of require_ssl.

For example, for the pair ssl_mode=ENCRYPTED_ONLY and require_ssl=false, ssl_mode=ENCRYPTED_ONLY means accept only SSL connections, while require_ssl=false means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect ssl_mode and accepts only SSL connections.

.google.cloud.sql.v1beta4.IpConfiguration.SslMode ssl_mode = 8;

Returns
Type	Description
`int`	The enum numeric value on the wire for sslMode.

hasEnablePrivatePathForGoogleCloudServices()

public abstract boolean hasEnablePrivatePathForGoogleCloudServices()

Controls connectivity to private IP instances from Google services, such as BigQuery.

.google.protobuf.BoolValue enable_private_path_for_google_cloud_services = 7;

Returns
Type	Description
`boolean`	Whether the enablePrivatePathForGoogleCloudServices field is set.

hasIpv4Enabled()

public abstract boolean hasIpv4Enabled()

Whether the instance is assigned a public IP address or not.

.google.protobuf.BoolValue ipv4_enabled = 1;

Returns
Type	Description
`boolean`	Whether the ipv4Enabled field is set.

hasPscConfig()

public abstract boolean hasPscConfig()

PSC settings for this instance.

optional .google.cloud.sql.v1beta4.PscConfig psc_config = 9;

Returns
Type	Description
`boolean`	Whether the pscConfig field is set.

hasRequireSsl()

public abstract boolean hasRequireSsl()

Use ssl_mode instead.

Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the ssl_mode flag instead of the legacy require_ssl flag.

.google.protobuf.BoolValue require_ssl = 3;

Returns
Type	Description
`boolean`	Whether the requireSsl field is set.

hasServerCaMode()

public abstract boolean hasServerCaMode()

Specify what type of CA is used for the server certificate.

optional .google.cloud.sql.v1beta4.IpConfiguration.CaMode server_ca_mode = 10;

Returns
Type	Description
`boolean`	Whether the serverCaMode field is set.

hasServerCaPool()

public abstract boolean hasServerCaPool()

Optional. The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}

optional string server_ca_pool = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the serverCaPool field is set.

hasServerCertificateRotationMode()

public abstract boolean hasServerCertificateRotationMode()

Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.

optional .google.cloud.sql.v1beta4.IpConfiguration.ServerCertificateRotationMode server_certificate_rotation_mode = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the serverCertificateRotationMode field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-08-05 UTC.