public static final class ConnectSettings.Builder extends GeneratedMessage.Builder<ConnectSettings.Builder> implements ConnectSettingsOrBuilderConnect settings retrieval response.
Protobuf type google.cloud.sql.v1.ConnectSettings
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ConnectSettings.BuilderImplements
ConnectSettingsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCustomSubjectAlternativeNames(Iterable<String> values)
public ConnectSettings.Builder addAllCustomSubjectAlternativeNames(Iterable<String> values)Custom subject alternative names for the server certificate.
repeated string custom_subject_alternative_names = 37;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The customSubjectAlternativeNames to add. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
addAllDnsNames(Iterable<? extends DnsNameMapping> values)
public ConnectSettings.Builder addAllDnsNames(Iterable<? extends DnsNameMapping> values)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 |
values |
Iterable<? extends com.google.cloud.sql.v1.DnsNameMapping> |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addAllIpAddresses(Iterable<? extends IpMapping> values)
public ConnectSettings.Builder addAllIpAddresses(Iterable<? extends IpMapping> values)The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.sql.v1.IpMapping> |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addAllMdxProtocolSupport(Iterable<? extends ConnectSettings.MdxProtocolSupport> values)
public ConnectSettings.Builder addAllMdxProtocolSupport(Iterable<? extends ConnectSettings.MdxProtocolSupport> values)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 |
values |
Iterable<? extends com.google.cloud.sql.v1.ConnectSettings.MdxProtocolSupport>The mdxProtocolSupport to add. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
addAllMdxProtocolSupportValue(Iterable<Integer> values)
public ConnectSettings.Builder addAllMdxProtocolSupportValue(Iterable<Integer> values)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 |
values |
Iterable<Integer>The enum numeric values on the wire for mdxProtocolSupport to add. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
addAllNodes(Iterable<? extends ConnectSettings.ConnectPoolNodeConfig> values)
public ConnectSettings.Builder addAllNodes(Iterable<? extends ConnectSettings.ConnectPoolNodeConfig> values)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 |
values |
Iterable<? extends com.google.cloud.sql.v1.ConnectSettings.ConnectPoolNodeConfig> |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addCustomSubjectAlternativeNames(String value)
public ConnectSettings.Builder addCustomSubjectAlternativeNames(String value)Custom subject alternative names for the server certificate.
repeated string custom_subject_alternative_names = 37;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customSubjectAlternativeNames to add. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
addCustomSubjectAlternativeNamesBytes(ByteString value)
public ConnectSettings.Builder addCustomSubjectAlternativeNamesBytes(ByteString value)Custom subject alternative names for the server certificate.
repeated string custom_subject_alternative_names = 37;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the customSubjectAlternativeNames to add. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
addDnsNames(DnsNameMapping value)
public ConnectSettings.Builder addDnsNames(DnsNameMapping value)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 |
value |
DnsNameMapping |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addDnsNames(DnsNameMapping.Builder builderForValue)
public ConnectSettings.Builder addDnsNames(DnsNameMapping.Builder builderForValue)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 |
builderForValue |
DnsNameMapping.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addDnsNames(int index, DnsNameMapping value)
public ConnectSettings.Builder addDnsNames(int index, DnsNameMapping value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DnsNameMapping |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addDnsNames(int index, DnsNameMapping.Builder builderForValue)
public ConnectSettings.Builder addDnsNames(int index, DnsNameMapping.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DnsNameMapping.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addDnsNamesBuilder()
public DnsNameMapping.Builder addDnsNamesBuilder()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 |
DnsNameMapping.Builder |
|
addDnsNamesBuilder(int index)
public DnsNameMapping.Builder addDnsNamesBuilder(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.Builder |
|
addIpAddresses(IpMapping value)
public ConnectSettings.Builder addIpAddresses(IpMapping value)The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
IpMapping |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addIpAddresses(IpMapping.Builder builderForValue)
public ConnectSettings.Builder addIpAddresses(IpMapping.Builder builderForValue)The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
IpMapping.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addIpAddresses(int index, IpMapping value)
public ConnectSettings.Builder addIpAddresses(int index, IpMapping value)The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
IpMapping |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addIpAddresses(int index, IpMapping.Builder builderForValue)
public ConnectSettings.Builder addIpAddresses(int index, IpMapping.Builder builderForValue)The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
IpMapping.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addIpAddressesBuilder()
public IpMapping.Builder addIpAddressesBuilder()The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Returns | |
|---|---|
| Type | Description |
IpMapping.Builder |
|
addIpAddressesBuilder(int index)
public IpMapping.Builder addIpAddressesBuilder(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.Builder |
|
addMdxProtocolSupport(ConnectSettings.MdxProtocolSupport value)
public ConnectSettings.Builder addMdxProtocolSupport(ConnectSettings.MdxProtocolSupport value)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 |
value |
ConnectSettings.MdxProtocolSupportThe mdxProtocolSupport to add. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
addMdxProtocolSupportValue(int value)
public ConnectSettings.Builder addMdxProtocolSupportValue(int value)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 |
value |
intThe enum numeric value on the wire for mdxProtocolSupport to add. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
addNodes(ConnectSettings.ConnectPoolNodeConfig value)
public ConnectSettings.Builder addNodes(ConnectSettings.ConnectPoolNodeConfig value)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 |
value |
ConnectSettings.ConnectPoolNodeConfig |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addNodes(ConnectSettings.ConnectPoolNodeConfig.Builder builderForValue)
public ConnectSettings.Builder addNodes(ConnectSettings.ConnectPoolNodeConfig.Builder builderForValue)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 |
builderForValue |
ConnectSettings.ConnectPoolNodeConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addNodes(int index, ConnectSettings.ConnectPoolNodeConfig value)
public ConnectSettings.Builder addNodes(int index, ConnectSettings.ConnectPoolNodeConfig value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ConnectSettings.ConnectPoolNodeConfig |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addNodes(int index, ConnectSettings.ConnectPoolNodeConfig.Builder builderForValue)
public ConnectSettings.Builder addNodes(int index, ConnectSettings.ConnectPoolNodeConfig.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ConnectSettings.ConnectPoolNodeConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
addNodesBuilder()
public ConnectSettings.ConnectPoolNodeConfig.Builder addNodesBuilder()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 |
ConnectSettings.ConnectPoolNodeConfig.Builder |
|
addNodesBuilder(int index)
public ConnectSettings.ConnectPoolNodeConfig.Builder addNodesBuilder(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.Builder |
|
build()
public ConnectSettings build()| Returns | |
|---|---|
| Type | Description |
ConnectSettings |
|
buildPartial()
public ConnectSettings buildPartial()| Returns | |
|---|---|
| Type | Description |
ConnectSettings |
|
clear()
public ConnectSettings.Builder clear()| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
clearBackendType()
public ConnectSettings.Builder clearBackendType() 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 |
ConnectSettings.Builder |
This builder for chaining. |
clearConnectionName()
public ConnectSettings.Builder clearConnectionName()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 |
ConnectSettings.Builder |
This builder for chaining. |
clearCustomSubjectAlternativeNames()
public ConnectSettings.Builder clearCustomSubjectAlternativeNames()Custom subject alternative names for the server certificate.
repeated string custom_subject_alternative_names = 37;
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
clearDatabaseVersion()
public ConnectSettings.Builder clearDatabaseVersion() 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 |
ConnectSettings.Builder |
This builder for chaining. |
clearDnsName()
public ConnectSettings.Builder clearDnsName()The dns name of the instance.
string dns_name = 34;
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
clearDnsNames()
public ConnectSettings.Builder clearDnsNames()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 |
ConnectSettings.Builder |
|
clearIpAddresses()
public ConnectSettings.Builder clearIpAddresses()The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
clearKind()
public ConnectSettings.Builder clearKind() This is always sql#connectSettings.
string kind = 1;
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
clearMdxProtocolSupport()
public ConnectSettings.Builder clearMdxProtocolSupport()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 |
ConnectSettings.Builder |
This builder for chaining. |
clearNodeCount()
public ConnectSettings.Builder clearNodeCount()The number of read pool nodes in a read pool.
optional int32 node_count = 63;
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
clearNodes()
public ConnectSettings.Builder clearNodes()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 |
ConnectSettings.Builder |
|
clearPscEnabled()
public ConnectSettings.Builder clearPscEnabled()Whether PSC connectivity is enabled for this instance.
bool psc_enabled = 33;
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
clearRegion()
public ConnectSettings.Builder clearRegion() 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 |
ConnectSettings.Builder |
This builder for chaining. |
clearServerCaCert()
public ConnectSettings.Builder clearServerCaCert()SSL configuration.
.google.cloud.sql.v1.SslCert server_ca_cert = 2;
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
clearServerCaMode()
public ConnectSettings.Builder clearServerCaMode()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.Builder |
This builder for chaining. |
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 |
intThe 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 |
intThe 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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
|
getDnsNamesBuilder(int index)
public DnsNameMapping.Builder getDnsNamesBuilder(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.Builder |
|
getDnsNamesBuilderList()
public List<DnsNameMapping.Builder> getDnsNamesBuilderList()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<Builder> |
|
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 |
|
getIpAddressesBuilder(int index)
public IpMapping.Builder getIpAddressesBuilder(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.Builder |
|
getIpAddressesBuilderList()
public List<IpMapping.Builder> getIpAddressesBuilderList()The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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 |
intThe 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 |
intThe 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 |
|
getNodesBuilder(int index)
public ConnectSettings.ConnectPoolNodeConfig.Builder getNodesBuilder(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.Builder |
|
getNodesBuilderList()
public List<ConnectSettings.ConnectPoolNodeConfig.Builder> getNodesBuilderList()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<Builder> |
|
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> |
|
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. |
getServerCaCert()
public SslCert getServerCaCert()SSL configuration.
.google.cloud.sql.v1.SslCert server_ca_cert = 2;
| Returns | |
|---|---|
| Type | Description |
SslCert |
The serverCaCert. |
getServerCaCertBuilder()
public SslCert.Builder getServerCaCertBuilder()SSL configuration.
.google.cloud.sql.v1.SslCert server_ca_cert = 2;
| Returns | |
|---|---|
| Type | Description |
SslCert.Builder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ConnectSettings other)
public ConnectSettings.Builder mergeFrom(ConnectSettings other)| Parameter | |
|---|---|
| Name | Description |
other |
ConnectSettings |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ConnectSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ConnectSettings.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
mergeServerCaCert(SslCert value)
public ConnectSettings.Builder mergeServerCaCert(SslCert value)SSL configuration.
.google.cloud.sql.v1.SslCert server_ca_cert = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
SslCert |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
removeDnsNames(int index)
public ConnectSettings.Builder removeDnsNames(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 |
ConnectSettings.Builder |
|
removeIpAddresses(int index)
public ConnectSettings.Builder removeIpAddresses(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 |
ConnectSettings.Builder |
|
removeNodes(int index)
public ConnectSettings.Builder removeNodes(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.Builder |
|
setBackendType(SqlBackendType value)
public ConnectSettings.Builder setBackendType(SqlBackendType value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
SqlBackendTypeThe backendType to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setBackendTypeValue(int value)
public ConnectSettings.Builder setBackendTypeValue(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for backendType to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setConnectionName(String value)
public ConnectSettings.Builder setConnectionName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe connectionName to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setConnectionNameBytes(ByteString value)
public ConnectSettings.Builder setConnectionNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for connectionName to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setCustomSubjectAlternativeNames(int index, String value)
public ConnectSettings.Builder setCustomSubjectAlternativeNames(int index, String value)Custom subject alternative names for the server certificate.
repeated string custom_subject_alternative_names = 37;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe customSubjectAlternativeNames to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setDatabaseVersion(SqlDatabaseVersion value)
public ConnectSettings.Builder setDatabaseVersion(SqlDatabaseVersion value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
SqlDatabaseVersionThe databaseVersion to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setDatabaseVersionValue(int value)
public ConnectSettings.Builder setDatabaseVersionValue(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for databaseVersion to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setDnsName(String value)
public ConnectSettings.Builder setDnsName(String value)The dns name of the instance.
string dns_name = 34;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe dnsName to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setDnsNameBytes(ByteString value)
public ConnectSettings.Builder setDnsNameBytes(ByteString value)The dns name of the instance.
string dns_name = 34;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for dnsName to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setDnsNames(int index, DnsNameMapping value)
public ConnectSettings.Builder setDnsNames(int index, DnsNameMapping value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DnsNameMapping |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setDnsNames(int index, DnsNameMapping.Builder builderForValue)
public ConnectSettings.Builder setDnsNames(int index, DnsNameMapping.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DnsNameMapping.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setIpAddresses(int index, IpMapping value)
public ConnectSettings.Builder setIpAddresses(int index, IpMapping value)The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
IpMapping |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setIpAddresses(int index, IpMapping.Builder builderForValue)
public ConnectSettings.Builder setIpAddresses(int index, IpMapping.Builder builderForValue)The assigned IP addresses for the instance.
repeated .google.cloud.sql.v1.IpMapping ip_addresses = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
IpMapping.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setKind(String value)
public ConnectSettings.Builder setKind(String value) This is always sql#connectSettings.
string kind = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe kind to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setKindBytes(ByteString value)
public ConnectSettings.Builder setKindBytes(ByteString value) This is always sql#connectSettings.
string kind = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for kind to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setMdxProtocolSupport(int index, ConnectSettings.MdxProtocolSupport value)
public ConnectSettings.Builder setMdxProtocolSupport(int index, ConnectSettings.MdxProtocolSupport value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
ConnectSettings.MdxProtocolSupportThe mdxProtocolSupport to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setMdxProtocolSupportValue(int index, int value)
public ConnectSettings.Builder setMdxProtocolSupportValue(int index, int value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for mdxProtocolSupport to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setNodeCount(int value)
public ConnectSettings.Builder setNodeCount(int value)The number of read pool nodes in a read pool.
optional int32 node_count = 63;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe nodeCount to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setNodes(int index, ConnectSettings.ConnectPoolNodeConfig value)
public ConnectSettings.Builder setNodes(int index, ConnectSettings.ConnectPoolNodeConfig value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ConnectSettings.ConnectPoolNodeConfig |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setNodes(int index, ConnectSettings.ConnectPoolNodeConfig.Builder builderForValue)
public ConnectSettings.Builder setNodes(int index, ConnectSettings.ConnectPoolNodeConfig.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ConnectSettings.ConnectPoolNodeConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setPscEnabled(boolean value)
public ConnectSettings.Builder setPscEnabled(boolean value)Whether PSC connectivity is enabled for this instance.
bool psc_enabled = 33;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe pscEnabled to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setRegion(String value)
public ConnectSettings.Builder setRegion(String value) The cloud region for the instance. For example, us-central1,
europe-west1. The region cannot be changed after instance creation.
string region = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe region to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setRegionBytes(ByteString value)
public ConnectSettings.Builder setRegionBytes(ByteString value) The cloud region for the instance. For example, us-central1,
europe-west1. The region cannot be changed after instance creation.
string region = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for region to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setServerCaCert(SslCert value)
public ConnectSettings.Builder setServerCaCert(SslCert value)SSL configuration.
.google.cloud.sql.v1.SslCert server_ca_cert = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
SslCert |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setServerCaCert(SslCert.Builder builderForValue)
public ConnectSettings.Builder setServerCaCert(SslCert.Builder builderForValue)SSL configuration.
.google.cloud.sql.v1.SslCert server_ca_cert = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SslCert.Builder |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
|
setServerCaMode(ConnectSettings.CaMode value)
public ConnectSettings.Builder setServerCaMode(ConnectSettings.CaMode value)Specify what type of CA is used for the server certificate.
.google.cloud.sql.v1.ConnectSettings.CaMode server_ca_mode = 35;
| Parameter | |
|---|---|
| Name | Description |
value |
ConnectSettings.CaModeThe serverCaMode to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |
setServerCaModeValue(int value)
public ConnectSettings.Builder setServerCaModeValue(int value)Specify what type of CA is used for the server certificate.
.google.cloud.sql.v1.ConnectSettings.CaMode server_ca_mode = 35;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for serverCaMode to set. |
| Returns | |
|---|---|
| Type | Description |
ConnectSettings.Builder |
This builder for chaining. |