Interface ConnectSettingsOrBuilder (0.1.0)

public interface ConnectSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBackendType()

public abstract SqlBackendType getBackendType()

SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

.google.cloud.sql.v1beta4.SqlBackendType backend_type = 32;

Returns
Type	Description
SqlBackendType	The backendType.

getBackendTypeValue()

public abstract int getBackendTypeValue()

SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

.google.cloud.sql.v1beta4.SqlBackendType backend_type = 32;

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

getConnectionName()

public abstract String getConnectionName()

Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance.

string connection_name = 40 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The connectionName.

getConnectionNameBytes()

public abstract ByteString getConnectionNameBytes()

Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance.

string connection_name = 40 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for connectionName.

getCustomSubjectAlternativeNames(int index)

public abstract String getCustomSubjectAlternativeNames(int index)

Custom subject alternative names for the server certificate.

repeated string custom_subject_alternative_names = 37;

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)

Custom subject alternative names for the server certificate.

repeated string custom_subject_alternative_names = 37;

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

Custom subject alternative names for the server certificate.

repeated string custom_subject_alternative_names = 37;

Returns
Type	Description
int	The count of customSubjectAlternativeNames.

getCustomSubjectAlternativeNamesList()

public abstract List<String> getCustomSubjectAlternativeNamesList()

Custom subject alternative names for the server certificate.

repeated string custom_subject_alternative_names = 37;

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

getDatabaseVersion()

public abstract SqlDatabaseVersion getDatabaseVersion()

The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12 (default), POSTGRES_13, or POSTGRES_14. SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB.

.google.cloud.sql.v1beta4.SqlDatabaseVersion database_version = 31;

Returns
Type	Description
SqlDatabaseVersion	The databaseVersion.

getDatabaseVersionValue()

public abstract int getDatabaseVersionValue()

The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12 (default), POSTGRES_13, or POSTGRES_14. SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB.

.google.cloud.sql.v1beta4.SqlDatabaseVersion database_version = 31;

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

getDnsName()

public abstract String getDnsName()

The dns name of the instance.

string dns_name = 34;

Returns
Type	Description
String	The dnsName.

getDnsNameBytes()

public abstract ByteString getDnsNameBytes()

The dns name of the instance.

string dns_name = 34;

Returns
Type	Description
ByteString	The bytes for dnsName.

getDnsNames(int index)

public abstract DnsNameMapping getDnsNames(int index)

Output only. The list of DNS names used by this instance.

repeated .google.cloud.sql.v1beta4.DnsNameMapping dns_names = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
DnsNameMapping

getDnsNamesCount()

public abstract int getDnsNamesCount()

Output only. The list of DNS names used by this instance.

repeated .google.cloud.sql.v1beta4.DnsNameMapping dns_names = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getDnsNamesList()

public abstract List<DnsNameMapping> getDnsNamesList()

Output only. The list of DNS names used by this instance.

repeated .google.cloud.sql.v1beta4.DnsNameMapping dns_names = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<DnsNameMapping>

getDnsNamesOrBuilder(int index)

public abstract DnsNameMappingOrBuilder getDnsNamesOrBuilder(int index)

Output only. The list of DNS names used by this instance.

repeated .google.cloud.sql.v1beta4.DnsNameMapping dns_names = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
DnsNameMappingOrBuilder

getDnsNamesOrBuilderList()

public abstract List<? extends DnsNameMappingOrBuilder> getDnsNamesOrBuilderList()

Output only. The list of DNS names used by this instance.

repeated .google.cloud.sql.v1beta4.DnsNameMapping dns_names = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getIpAddresses(int index)

public abstract IpMapping getIpAddresses(int index)

The assigned IP addresses for the instance.

repeated .google.cloud.sql.v1beta4.IpMapping ip_addresses = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
IpMapping

getIpAddressesCount()

public abstract int getIpAddressesCount()

The assigned IP addresses for the instance.

repeated .google.cloud.sql.v1beta4.IpMapping ip_addresses = 3;

Returns
Type	Description
int

getIpAddressesList()

public abstract List<IpMapping> getIpAddressesList()

The assigned IP addresses for the instance.

repeated .google.cloud.sql.v1beta4.IpMapping ip_addresses = 3;

Returns
Type	Description
List<IpMapping>

getIpAddressesOrBuilder(int index)

public abstract IpMappingOrBuilder getIpAddressesOrBuilder(int index)

The assigned IP addresses for the instance.

repeated .google.cloud.sql.v1beta4.IpMapping ip_addresses = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
IpMappingOrBuilder

getIpAddressesOrBuilderList()

public abstract List<? extends IpMappingOrBuilder> getIpAddressesOrBuilderList()

The assigned IP addresses for the instance.

repeated .google.cloud.sql.v1beta4.IpMapping ip_addresses = 3;

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

getKind()

public abstract String getKind()

This is always sql#connectSettings.

string kind = 1;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

This is always sql#connectSettings.

string kind = 1;

Returns
Type	Description
ByteString	The bytes for kind.

getMdxProtocolSupport(int index)

public abstract ConnectSettings.MdxProtocolSupport getMdxProtocolSupport(int index)

Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty.

repeated .google.cloud.sql.v1beta4.ConnectSettings.MdxProtocolSupport mdx_protocol_support = 39 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
ConnectSettings.MdxProtocolSupport	The mdxProtocolSupport at the given index.

getMdxProtocolSupportCount()

public abstract int getMdxProtocolSupportCount()

Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty.

repeated .google.cloud.sql.v1beta4.ConnectSettings.MdxProtocolSupport mdx_protocol_support = 39 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of mdxProtocolSupport.

getMdxProtocolSupportList()

public abstract List<ConnectSettings.MdxProtocolSupport> getMdxProtocolSupportList()

Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty.

repeated .google.cloud.sql.v1beta4.ConnectSettings.MdxProtocolSupport mdx_protocol_support = 39 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<MdxProtocolSupport>	A list containing the mdxProtocolSupport.

getMdxProtocolSupportValue(int index)

public abstract int getMdxProtocolSupportValue(int index)

Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty.

repeated .google.cloud.sql.v1beta4.ConnectSettings.MdxProtocolSupport mdx_protocol_support = 39 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
int	The enum numeric value on the wire of mdxProtocolSupport at the given index.

getMdxProtocolSupportValueList()

public abstract List<Integer> getMdxProtocolSupportValueList()

Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty.

repeated .google.cloud.sql.v1beta4.ConnectSettings.MdxProtocolSupport mdx_protocol_support = 39 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for mdxProtocolSupport.

getNodeCount()

public abstract int getNodeCount()

The number of read pool nodes in a read pool.

optional int32 node_count = 63;

Returns
Type	Description
int	The nodeCount.

getNodes(int index)

public abstract ConnectSettings.ConnectPoolNodeConfig getNodes(int index)

Output only. Entries containing information about each read pool node of the read pool.

repeated .google.cloud.sql.v1beta4.ConnectSettings.ConnectPoolNodeConfig nodes = 64 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
ConnectSettings.ConnectPoolNodeConfig

getNodesCount()

public abstract int getNodesCount()

Output only. Entries containing information about each read pool node of the read pool.

repeated .google.cloud.sql.v1beta4.ConnectSettings.ConnectPoolNodeConfig nodes = 64 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getNodesList()

public abstract List<ConnectSettings.ConnectPoolNodeConfig> getNodesList()

Output only. Entries containing information about each read pool node of the read pool.

repeated .google.cloud.sql.v1beta4.ConnectSettings.ConnectPoolNodeConfig nodes = 64 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<ConnectPoolNodeConfig>

getNodesOrBuilder(int index)

public abstract ConnectSettings.ConnectPoolNodeConfigOrBuilder getNodesOrBuilder(int index)

Output only. Entries containing information about each read pool node of the read pool.

repeated .google.cloud.sql.v1beta4.ConnectSettings.ConnectPoolNodeConfig nodes = 64 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
ConnectSettings.ConnectPoolNodeConfigOrBuilder

getNodesOrBuilderList()

public abstract List<? extends ConnectSettings.ConnectPoolNodeConfigOrBuilder> getNodesOrBuilderList()

Output only. Entries containing information about each read pool node of the read pool.

repeated .google.cloud.sql.v1beta4.ConnectSettings.ConnectPoolNodeConfig nodes = 64 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.sql.v1beta4.ConnectSettings.ConnectPoolNodeConfigOrBuilder>

getPscEnabled()

public abstract boolean getPscEnabled()

Whether PSC connectivity is enabled for this instance.

bool psc_enabled = 33;

Returns
Type	Description
boolean	The pscEnabled.

getRegion()

public abstract String getRegion()

The cloud region for the instance. e.g. us-central1, europe-west1. The region cannot be changed after instance creation.

string region = 4;

Returns
Type	Description
String	The region.

getRegionBytes()

public abstract ByteString getRegionBytes()

The cloud region for the instance. e.g. us-central1, europe-west1. The region cannot be changed after instance creation.

string region = 4;

Returns
Type	Description
ByteString	The bytes for region.

getServerCaCert()

public abstract SslCert getServerCaCert()

SSL configuration.

.google.cloud.sql.v1beta4.SslCert server_ca_cert = 2;

Returns
Type	Description
SslCert	The serverCaCert.

getServerCaCertOrBuilder()

public abstract SslCertOrBuilder getServerCaCertOrBuilder()

SSL configuration.

.google.cloud.sql.v1beta4.SslCert server_ca_cert = 2;

Returns
Type	Description
SslCertOrBuilder

getServerCaMode()

public abstract ConnectSettings.CaMode getServerCaMode()

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

.google.cloud.sql.v1beta4.ConnectSettings.CaMode server_ca_mode = 35;

Returns
Type	Description
ConnectSettings.CaMode	The serverCaMode.

getServerCaModeValue()

public abstract int getServerCaModeValue()

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

.google.cloud.sql.v1beta4.ConnectSettings.CaMode server_ca_mode = 35;

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

hasNodeCount()

public abstract boolean hasNodeCount()

The number of read pool nodes in a read pool.

optional int32 node_count = 63;

Returns
Type	Description
boolean	Whether the nodeCount field is set.

hasServerCaCert()

public abstract boolean hasServerCaCert()

SSL configuration.

.google.cloud.sql.v1beta4.SslCert server_ca_cert = 2;

Returns
Type	Description
boolean	Whether the serverCaCert field is set.