Class ConnectSettings (0.1.0)

public final class ConnectSettings extends GeneratedMessage implements ConnectSettingsOrBuilder

Connect settings retrieval response.

Protobuf type google.cloud.sql.v1.ConnectSettings

Static Fields

BACKEND_TYPE_FIELD_NUMBER

public static final int BACKEND_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CONNECTION_NAME_FIELD_NUMBER

public static final int CONNECTION_NAME_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_SUBJECT_ALTERNATIVE_NAMES_FIELD_NUMBER

public static final int CUSTOM_SUBJECT_ALTERNATIVE_NAMES_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_VERSION_FIELD_NUMBER

public static final int DATABASE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

DNS_NAMES_FIELD_NUMBER

public static final int DNS_NAMES_FIELD_NUMBER
Field Value
Type Description
int

DNS_NAME_FIELD_NUMBER

public static final int DNS_NAME_FIELD_NUMBER
Field Value
Type Description
int

IP_ADDRESSES_FIELD_NUMBER

public static final int IP_ADDRESSES_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

MDX_PROTOCOL_SUPPORT_FIELD_NUMBER

public static final int MDX_PROTOCOL_SUPPORT_FIELD_NUMBER
Field Value
Type Description
int

NODES_FIELD_NUMBER

public static final int NODES_FIELD_NUMBER
Field Value
Type Description
int

NODE_COUNT_FIELD_NUMBER

public static final int NODE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PSC_ENABLED_FIELD_NUMBER

public static final int PSC_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int

SERVER_CA_CERT_FIELD_NUMBER

public static final int SERVER_CA_CERT_FIELD_NUMBER
Field Value
Type Description
int

SERVER_CA_MODE_FIELD_NUMBER

public static final int SERVER_CA_MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConnectSettings getDefaultInstance()
Returns
Type Description
ConnectSettings

getDescriptor()

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

newBuilder()

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

newBuilder(ConnectSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBackendType()

public 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.v1.SqlBackendType backend_type = 32;

Returns
Type Description
SqlBackendType

The backendType.

getBackendTypeValue()

public 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.v1.SqlBackendType backend_type = 32;

Returns
Type Description
int

The enum numeric value on the wire for backendType.

getConnectionName()

public 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 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 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 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 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 ProtocolStringList getCustomSubjectAlternativeNamesList()

Custom subject alternative names for the server certificate.

repeated string custom_subject_alternative_names = 37;

Returns
Type Description
ProtocolStringList

A list containing the customSubjectAlternativeNames.

getDatabaseVersion()

public 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, 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.v1.SqlDatabaseVersion database_version = 31;

Returns
Type Description
SqlDatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public 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, 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.v1.SqlDatabaseVersion database_version = 31;

Returns
Type Description
int

The enum numeric value on the wire for databaseVersion.

getDefaultInstanceForType()

public ConnectSettings getDefaultInstanceForType()
Returns
Type Description
ConnectSettings

getDnsName()

public String getDnsName()

The dns name of the instance.

string dns_name = 34;

Returns
Type Description
String

The dnsName.

getDnsNameBytes()

public ByteString getDnsNameBytes()

The dns name of the instance.

string dns_name = 34;

Returns
Type Description
ByteString

The bytes for dnsName.

getDnsNames(int index)

public DnsNameMapping getDnsNames(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
DnsNameMapping

getDnsNamesCount()

public int getDnsNamesCount()

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

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

Returns
Type Description
int

getDnsNamesList()

public List<DnsNameMapping> getDnsNamesList()

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

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

Returns
Type Description
List<DnsNameMapping>

getDnsNamesOrBuilder(int index)

public DnsNameMappingOrBuilder getDnsNamesOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
DnsNameMappingOrBuilder

getDnsNamesOrBuilderList()

public List<? extends DnsNameMappingOrBuilder> getDnsNamesOrBuilderList()

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

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

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

getIpAddresses(int index)

public IpMapping getIpAddresses(int index)

The assigned IP addresses for the instance.

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

Parameter
Name Description
index int
Returns
Type Description
IpMapping

getIpAddressesCount()

public int getIpAddressesCount()

The assigned IP addresses for the instance.

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

Returns
Type Description
int

getIpAddressesList()

public List<IpMapping> getIpAddressesList()

The assigned IP addresses for the instance.

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

Returns
Type Description
List<IpMapping>

getIpAddressesOrBuilder(int index)

public IpMappingOrBuilder getIpAddressesOrBuilder(int index)

The assigned IP addresses for the instance.

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

Parameter
Name Description
index int
Returns
Type Description
IpMappingOrBuilder

getIpAddressesOrBuilderList()

public List<? extends IpMappingOrBuilder> getIpAddressesOrBuilderList()

The assigned IP addresses for the instance.

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

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

getKind()

public String getKind()

This is always sql#connectSettings.

string kind = 1;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#connectSettings.

string kind = 1;

Returns
Type Description
ByteString

The bytes for kind.

getMdxProtocolSupport(int index)

public 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.v1.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 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.v1.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 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.v1.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 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.v1.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 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.v1.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 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 ConnectSettings.ConnectPoolNodeConfig getNodes(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
ConnectSettings.ConnectPoolNodeConfig

getNodesCount()

public int getNodesCount()

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

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

Returns
Type Description
int

getNodesList()

public List<ConnectSettings.ConnectPoolNodeConfig> getNodesList()

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

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

Returns
Type Description
List<ConnectPoolNodeConfig>

getNodesOrBuilder(int index)

public ConnectSettings.ConnectPoolNodeConfigOrBuilder getNodesOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
ConnectSettings.ConnectPoolNodeConfigOrBuilder

getNodesOrBuilderList()

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

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

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

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

getParserForType()

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

getPscEnabled()

public boolean getPscEnabled()

Whether PSC connectivity is enabled for this instance.

bool psc_enabled = 33;

Returns
Type Description
boolean

The pscEnabled.

getRegion()

public String getRegion()

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

string region = 4;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

string region = 4;

Returns
Type Description
ByteString

The bytes for region.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServerCaCert()

public SslCert getServerCaCert()

SSL configuration.

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

Returns
Type Description
SslCert

The serverCaCert.

getServerCaCertOrBuilder()

public SslCertOrBuilder getServerCaCertOrBuilder()

SSL configuration.

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

Returns
Type Description
SslCertOrBuilder

getServerCaMode()

public ConnectSettings.CaMode getServerCaMode()

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

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

Returns
Type Description
ConnectSettings.CaMode

The serverCaMode.

getServerCaModeValue()

public int getServerCaModeValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for serverCaMode.

hasNodeCount()

public 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 boolean hasServerCaCert()

SSL configuration.

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

Returns
Type Description
boolean

Whether the serverCaCert field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ConnectSettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConnectSettings.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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