Class DatabaseInstance (0.1.0)

public final class DatabaseInstance extends GeneratedMessage implements DatabaseInstanceOrBuilder

A Cloud SQL instance resource.

Protobuf type google.cloud.sql.v1.DatabaseInstance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DatabaseInstance

Implements

DatabaseInstanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AVAILABLE_MAINTENANCE_VERSIONS_FIELD_NUMBER

public static final int AVAILABLE_MAINTENANCE_VERSIONS_FIELD_NUMBER

Field Value
Type	Description
int

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

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

CURRENT_DISK_SIZE_FIELD_NUMBER

public static final int CURRENT_DISK_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

DATABASE_CENTER_INTEGRATION_ENABLED_FIELD_NUMBER

public static final int DATABASE_CENTER_INTEGRATION_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

DATABASE_INSTALLED_VERSION_FIELD_NUMBER

public static final int DATABASE_INSTALLED_VERSION_FIELD_NUMBER

Field Value
Type	Description
int

DATABASE_VERSION_FIELD_NUMBER

public static final int DATABASE_VERSION_FIELD_NUMBER

Field Value
Type	Description
int

DISK_ENCRYPTION_CONFIGURATION_FIELD_NUMBER

public static final int DISK_ENCRYPTION_CONFIGURATION_FIELD_NUMBER

Field Value
Type	Description
int

DISK_ENCRYPTION_STATUS_FIELD_NUMBER

public static final int DISK_ENCRYPTION_STATUS_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

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

Field Value
Type	Description
int

FAILOVER_REPLICA_FIELD_NUMBER

public static final int FAILOVER_REPLICA_FIELD_NUMBER

Field Value
Type	Description
int

GCE_ZONE_FIELD_NUMBER

public static final int GCE_ZONE_FIELD_NUMBER

Field Value
Type	Description
int

GEMINI_CONFIG_FIELD_NUMBER

public static final int GEMINI_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

INCLUDE_REPLICAS_FOR_MAJOR_VERSION_UPGRADE_FIELD_NUMBER

public static final int INCLUDE_REPLICAS_FOR_MAJOR_VERSION_UPGRADE_FIELD_NUMBER

Field Value
Type	Description
int

INSTANCE_TYPE_FIELD_NUMBER

public static final int INSTANCE_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

IPV6_ADDRESS_FIELD_NUMBER

public static final int IPV6_ADDRESS_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

MAINTENANCE_VERSION_FIELD_NUMBER

public static final int MAINTENANCE_VERSION_FIELD_NUMBER

Field Value
Type	Description
int

MASTER_INSTANCE_NAME_FIELD_NUMBER

public static final int MASTER_INSTANCE_NAME_FIELD_NUMBER

Field Value
Type	Description
int

MAX_DISK_SIZE_FIELD_NUMBER

public static final int MAX_DISK_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_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

ON_PREMISES_CONFIGURATION_FIELD_NUMBER

public static final int ON_PREMISES_CONFIGURATION_FIELD_NUMBER

Field Value
Type	Description
int

OUT_OF_DISK_REPORT_FIELD_NUMBER

public static final int OUT_OF_DISK_REPORT_FIELD_NUMBER

Field Value
Type	Description
int

PRIMARY_DNS_NAME_FIELD_NUMBER

public static final int PRIMARY_DNS_NAME_FIELD_NUMBER

Field Value
Type	Description
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER

Field Value
Type	Description
int

PSC_SERVICE_ATTACHMENT_LINK_FIELD_NUMBER

public static final int PSC_SERVICE_ATTACHMENT_LINK_FIELD_NUMBER

Field Value
Type	Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER

Field Value
Type	Description
int

REPLICATION_CLUSTER_FIELD_NUMBER

public static final int REPLICATION_CLUSTER_FIELD_NUMBER

Field Value
Type	Description
int

REPLICA_CONFIGURATION_FIELD_NUMBER

public static final int REPLICA_CONFIGURATION_FIELD_NUMBER

Field Value
Type	Description
int

REPLICA_NAMES_FIELD_NUMBER

public static final int REPLICA_NAMES_FIELD_NUMBER

Field Value
Type	Description
int

ROOT_PASSWORD_FIELD_NUMBER

public static final int ROOT_PASSWORD_FIELD_NUMBER

Field Value
Type	Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER

Field Value
Type	Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER

Field Value
Type	Description
int

SCHEDULED_MAINTENANCE_FIELD_NUMBER

public static final int SCHEDULED_MAINTENANCE_FIELD_NUMBER

Field Value
Type	Description
int

SECONDARY_GCE_ZONE_FIELD_NUMBER

public static final int SECONDARY_GCE_ZONE_FIELD_NUMBER

Field Value
Type	Description
int

SELF_LINK_FIELD_NUMBER

public static final int SELF_LINK_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

SERVICE_ACCOUNT_EMAIL_ADDRESS_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_ADDRESS_FIELD_NUMBER

Field Value
Type	Description
int

SETTINGS_FIELD_NUMBER

public static final int SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

SQL_NETWORK_ARCHITECTURE_FIELD_NUMBER

public static final int SQL_NETWORK_ARCHITECTURE_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

SUSPENSION_REASON_FIELD_NUMBER

public static final int SUSPENSION_REASON_FIELD_NUMBER

Field Value
Type	Description
int

SWITCH_TRANSACTION_LOGS_TO_CLOUD_STORAGE_ENABLED_FIELD_NUMBER

public static final int SWITCH_TRANSACTION_LOGS_TO_CLOUD_STORAGE_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER

Field Value
Type	Description
int

UPGRADABLE_DATABASE_VERSIONS_FIELD_NUMBER

public static final int UPGRADABLE_DATABASE_VERSIONS_FIELD_NUMBER

Field Value
Type	Description
int

WRITE_ENDPOINT_FIELD_NUMBER

public static final int WRITE_ENDPOINT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DatabaseInstance getDefaultInstance()

Returns
Type	Description
DatabaseInstance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DatabaseInstance.Builder newBuilder()

Returns
Type	Description
DatabaseInstance.Builder

newBuilder(DatabaseInstance prototype)

public static DatabaseInstance.Builder newBuilder(DatabaseInstance prototype)

Parameter
Name	Description
prototype	DatabaseInstance

Returns
Type	Description
DatabaseInstance.Builder

parseDelimitedFrom(InputStream input)

public static DatabaseInstance parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DatabaseInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DatabaseInstance parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DatabaseInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DatabaseInstance parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DatabaseInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DatabaseInstance parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DatabaseInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DatabaseInstance parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DatabaseInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DatabaseInstance parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DatabaseInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DatabaseInstance

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DatabaseInstance> parser()

Returns
Type	Description
Parser<DatabaseInstance>

Methods

containsTags(String key)

public boolean containsTags(String key)

Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

For example, a single resource can have the following tags: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code>

For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.

map<string, string> tags = 60 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAvailableMaintenanceVersions(int index)

public String getAvailableMaintenanceVersions(int index)

Output only. List all maintenance versions applicable on the instance

repeated string available_maintenance_versions = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type	Description
String	The availableMaintenanceVersions at the given index.

getAvailableMaintenanceVersionsBytes(int index)

public ByteString getAvailableMaintenanceVersionsBytes(int index)

Output only. List all maintenance versions applicable on the instance

repeated string available_maintenance_versions = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

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

getAvailableMaintenanceVersionsCount()

public int getAvailableMaintenanceVersionsCount()

Output only. List all maintenance versions applicable on the instance

repeated string available_maintenance_versions = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The count of availableMaintenanceVersions.

getAvailableMaintenanceVersionsList()

public ProtocolStringList getAvailableMaintenanceVersionsList()

Output only. List all maintenance versions applicable on the instance

repeated string available_maintenance_versions = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ProtocolStringList	A list containing the availableMaintenanceVersions.

getBackendType()

public SqlBackendType getBackendType()

The backend type. 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 = 19;

Returns
Type	Description
SqlBackendType	The backendType.

getBackendTypeValue()

public int getBackendTypeValue()

The backend type. 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 = 19;

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

getConnectionName()

public String getConnectionName()

Connection name of the Cloud SQL instance used in connection strings.

string connection_name = 22;

Returns
Type	Description
String	The connectionName.

getConnectionNameBytes()

public ByteString getConnectionNameBytes()

Connection name of the Cloud SQL instance used in connection strings.

string connection_name = 22;

Returns
Type	Description
ByteString	The bytes for connectionName.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp create_time = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp create_time = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCurrentDiskSize() (deprecated)

public Int64Value getCurrentDiskSize()

Deprecated. google.cloud.sql.v1.DatabaseInstance.current_disk_size is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1590

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

.google.protobuf.Int64Value current_disk_size = 10 [deprecated = true];

Returns
Type	Description
Int64Value	The currentDiskSize.

getCurrentDiskSizeOrBuilder() (deprecated)

public Int64ValueOrBuilder getCurrentDiskSizeOrBuilder()

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

.google.protobuf.Int64Value current_disk_size = 10 [deprecated = true];

Returns
Type	Description
Int64ValueOrBuilder

getDatabaseCenterIntegrationEnabled()

public BoolValue getDatabaseCenterIntegrationEnabled()

Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center.

.google.protobuf.BoolValue database_center_integration_enabled = 72 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoolValue	The databaseCenterIntegrationEnabled.

getDatabaseCenterIntegrationEnabledOrBuilder()

public BoolValueOrBuilder getDatabaseCenterIntegrationEnabledOrBuilder()

Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center.

.google.protobuf.BoolValue database_center_integration_enabled = 72 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoolValueOrBuilder

getDatabaseInstalledVersion()

public String getDatabaseInstalledVersion()

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

string database_installed_version = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The databaseInstalledVersion.

getDatabaseInstalledVersionBytes()

public ByteString getDatabaseInstalledVersionBytes()

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

string database_installed_version = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for databaseInstalledVersion.

getDatabaseVersion()

public SqlDatabaseVersion getDatabaseVersion()

The database engine type and version. The databaseVersion field cannot be changed after instance creation.

.google.cloud.sql.v1.SqlDatabaseVersion database_version = 3;

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.

.google.cloud.sql.v1.SqlDatabaseVersion database_version = 3;

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

getDefaultInstanceForType()

public DatabaseInstance getDefaultInstanceForType()

Returns
Type	Description
DatabaseInstance

getDiskEncryptionConfiguration()

public DiskEncryptionConfiguration getDiskEncryptionConfiguration()

Disk encryption configuration specific to an instance.

.google.cloud.sql.v1.DiskEncryptionConfiguration disk_encryption_configuration = 26;

Returns
Type	Description
DiskEncryptionConfiguration	The diskEncryptionConfiguration.

getDiskEncryptionConfigurationOrBuilder()

public DiskEncryptionConfigurationOrBuilder getDiskEncryptionConfigurationOrBuilder()

Disk encryption configuration specific to an instance.

.google.cloud.sql.v1.DiskEncryptionConfiguration disk_encryption_configuration = 26;

Returns
Type	Description
DiskEncryptionConfigurationOrBuilder

getDiskEncryptionStatus()

public DiskEncryptionStatus getDiskEncryptionStatus()

Disk encryption status specific to an instance.

.google.cloud.sql.v1.DiskEncryptionStatus disk_encryption_status = 27;

Returns
Type	Description
DiskEncryptionStatus	The diskEncryptionStatus.

getDiskEncryptionStatusOrBuilder()

public DiskEncryptionStatusOrBuilder getDiskEncryptionStatusOrBuilder()

Disk encryption status specific to an instance.

.google.cloud.sql.v1.DiskEncryptionStatus disk_encryption_status = 27;

Returns
Type	Description
DiskEncryptionStatusOrBuilder

getDnsName()

public String getDnsName()

Output only. The dns name of the instance.

optional string dns_name = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The dnsName.

getDnsNameBytes()

public ByteString getDnsNameBytes()

Output only. The dns name of the instance.

optional string dns_name = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 = 67 [(.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 = 67 [(.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 = 67 [(.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 = 67 [(.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 = 67 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getEtag()

public String getEtag()

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

string etag = 5;

Returns
Type	Description
String	The etag.

getEtagBytes()

public ByteString getEtagBytes()

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

string etag = 5;

Returns
Type	Description
ByteString	The bytes for etag.

getFailoverReplica()

public DatabaseInstance.SqlFailoverReplica getFailoverReplica()

The name and status of the failover replica.

.google.cloud.sql.v1.DatabaseInstance.SqlFailoverReplica failover_replica = 6;

Returns
Type	Description
DatabaseInstance.SqlFailoverReplica	The failoverReplica.

getFailoverReplicaOrBuilder()

public DatabaseInstance.SqlFailoverReplicaOrBuilder getFailoverReplicaOrBuilder()

The name and status of the failover replica.

.google.cloud.sql.v1.DatabaseInstance.SqlFailoverReplica failover_replica = 6;

Returns
Type	Description
DatabaseInstance.SqlFailoverReplicaOrBuilder

getGceZone()

public String getGceZone()

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.

string gce_zone = 25;

Returns
Type	Description
String	The gceZone.

getGceZoneBytes()

public ByteString getGceZoneBytes()

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.

string gce_zone = 25;

Returns
Type	Description
ByteString	The bytes for gceZone.

getGeminiConfig()

public GeminiInstanceConfig getGeminiConfig()

Gemini instance configuration.

optional .google.cloud.sql.v1.GeminiInstanceConfig gemini_config = 55;

Returns
Type	Description
GeminiInstanceConfig	The geminiConfig.

getGeminiConfigOrBuilder()

public GeminiInstanceConfigOrBuilder getGeminiConfigOrBuilder()

Gemini instance configuration.

optional .google.cloud.sql.v1.GeminiInstanceConfig gemini_config = 55;

Returns
Type	Description
GeminiInstanceConfigOrBuilder

getIncludeReplicasForMajorVersionUpgrade()

public BoolValue getIncludeReplicasForMajorVersionUpgrade()

Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.

optional .google.protobuf.BoolValue include_replicas_for_major_version_upgrade = 59 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
BoolValue	The includeReplicasForMajorVersionUpgrade.

getIncludeReplicasForMajorVersionUpgradeOrBuilder()

public BoolValueOrBuilder getIncludeReplicasForMajorVersionUpgradeOrBuilder()

Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.

optional .google.protobuf.BoolValue include_replicas_for_major_version_upgrade = 59 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
BoolValueOrBuilder

getInstanceType()

public SqlInstanceType getInstanceType()

The instance type.

.google.cloud.sql.v1.SqlInstanceType instance_type = 13;

Returns
Type	Description
SqlInstanceType	The instanceType.

getInstanceTypeValue()

public int getInstanceTypeValue()

The instance type.

.google.cloud.sql.v1.SqlInstanceType instance_type = 13;

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

getIpAddresses(int index)

public IpMapping getIpAddresses(int index)

The assigned IP addresses for the instance.

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

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 = 11;

Returns
Type	Description
int

getIpAddressesList()

public List<IpMapping> getIpAddressesList()

The assigned IP addresses for the instance.

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

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 = 11;

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 = 11;

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

getIpv6Address() (deprecated)

public String getIpv6Address()

Deprecated. google.cloud.sql.v1.DatabaseInstance.ipv6_address is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1608

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

string ipv6_address = 15 [deprecated = true];

Returns
Type	Description
String	The ipv6Address.

getIpv6AddressBytes() (deprecated)

public ByteString getIpv6AddressBytes()

Deprecated. google.cloud.sql.v1.DatabaseInstance.ipv6_address is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1608

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

string ipv6_address = 15 [deprecated = true];

Returns
Type	Description
ByteString	The bytes for ipv6Address.

getKind()

public String getKind()

This is always sql#instance.

string kind = 1;

Returns
Type	Description
String	The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#instance.

string kind = 1;

Returns
Type	Description
ByteString	The bytes for kind.

getMaintenanceVersion()

public String getMaintenanceVersion()

The current software version on the instance.

string maintenance_version = 42;

Returns
Type	Description
String	The maintenanceVersion.

getMaintenanceVersionBytes()

public ByteString getMaintenanceVersionBytes()

The current software version on the instance.

string maintenance_version = 42;

Returns
Type	Description
ByteString	The bytes for maintenanceVersion.

getMasterInstanceName()

public String getMasterInstanceName()

The name of the instance which will act as primary in the replication setup.

string master_instance_name = 7;

Returns
Type	Description
String	The masterInstanceName.

getMasterInstanceNameBytes()

public ByteString getMasterInstanceNameBytes()

The name of the instance which will act as primary in the replication setup.

string master_instance_name = 7;

Returns
Type	Description
ByteString	The bytes for masterInstanceName.

getMaxDiskSize() (deprecated)

public Int64Value getMaxDiskSize()

Deprecated. google.cloud.sql.v1.DatabaseInstance.max_disk_size is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1582

The maximum disk size of the instance in bytes.

.google.protobuf.Int64Value max_disk_size = 9 [deprecated = true];

Returns
Type	Description
Int64Value	The maxDiskSize.

getMaxDiskSizeOrBuilder() (deprecated)

public Int64ValueOrBuilder getMaxDiskSizeOrBuilder()

The maximum disk size of the instance in bytes.

.google.protobuf.Int64Value max_disk_size = 9 [deprecated = true];

Returns
Type	Description
Int64ValueOrBuilder

getName()

public String getName()

Name of the Cloud SQL instance. This does not include the project ID.

string name = 23;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Name of the Cloud SQL instance. This does not include the project ID.

string name = 23;

Returns
Type	Description
ByteString	The bytes for name.

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 DatabaseInstance.PoolNodeConfig getNodes(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
DatabaseInstance.PoolNodeConfig

getNodesCount()

public int getNodesCount()

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

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

Returns
Type	Description
int

getNodesList()

public List<DatabaseInstance.PoolNodeConfig> getNodesList()

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

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

Returns
Type	Description
List<PoolNodeConfig>

getNodesOrBuilder(int index)

public DatabaseInstance.PoolNodeConfigOrBuilder getNodesOrBuilder(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
DatabaseInstance.PoolNodeConfigOrBuilder

getNodesOrBuilderList()

public List<? extends DatabaseInstance.PoolNodeConfigOrBuilder> getNodesOrBuilderList()

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

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

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

getOnPremisesConfiguration()

public OnPremisesConfiguration getOnPremisesConfiguration()

Configuration specific to on-premises instances.

.google.cloud.sql.v1.OnPremisesConfiguration on_premises_configuration = 17;

Returns
Type	Description
OnPremisesConfiguration	The onPremisesConfiguration.

getOnPremisesConfigurationOrBuilder()

public OnPremisesConfigurationOrBuilder getOnPremisesConfigurationOrBuilder()

Configuration specific to on-premises instances.

.google.cloud.sql.v1.OnPremisesConfiguration on_premises_configuration = 17;

Returns
Type	Description
OnPremisesConfigurationOrBuilder

getOutOfDiskReport()

public DatabaseInstance.SqlOutOfDiskReport getOutOfDiskReport()

This field represents the report generated by the proactive database wellness job for OutOfDisk issues.

• Writers:
• the proactive database wellness job for OOD.
• Readers:
• the proactive database wellness job

optional .google.cloud.sql.v1.DatabaseInstance.SqlOutOfDiskReport out_of_disk_report = 38;

Returns
Type	Description
DatabaseInstance.SqlOutOfDiskReport	The outOfDiskReport.

getOutOfDiskReportOrBuilder()

public DatabaseInstance.SqlOutOfDiskReportOrBuilder getOutOfDiskReportOrBuilder()

This field represents the report generated by the proactive database wellness job for OutOfDisk issues.

• Writers:
• the proactive database wellness job for OOD.
• Readers:
• the proactive database wellness job

optional .google.cloud.sql.v1.DatabaseInstance.SqlOutOfDiskReport out_of_disk_report = 38;

Returns
Type	Description
DatabaseInstance.SqlOutOfDiskReportOrBuilder

getParserForType()

public Parser<DatabaseInstance> getParserForType()

Returns
Type	Description
Parser<DatabaseInstance>

Overrides

GeneratedMessage.getParserForType()

getPrimaryDnsName() (deprecated)

public String getPrimaryDnsName()

Deprecated. google.cloud.sql.v1.DatabaseInstance.primary_dns_name is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1720

Output only. DEPRECATED: please use write_endpoint instead.

optional string primary_dns_name = 51 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The primaryDnsName.

getPrimaryDnsNameBytes() (deprecated)

public ByteString getPrimaryDnsNameBytes()

Deprecated. google.cloud.sql.v1.DatabaseInstance.primary_dns_name is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1720

Output only. DEPRECATED: please use write_endpoint instead.

optional string primary_dns_name = 51 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for primaryDnsName.

getProject()

public String getProject()

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

string project = 14;

Returns
Type	Description
String	The project.

getProjectBytes()

public ByteString getProjectBytes()

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

string project = 14;

Returns
Type	Description
ByteString	The bytes for project.

getPscServiceAttachmentLink()

public String getPscServiceAttachmentLink()

Output only. The link to service attachment of PSC instance.

optional string psc_service_attachment_link = 48 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The pscServiceAttachmentLink.

getPscServiceAttachmentLinkBytes()

public ByteString getPscServiceAttachmentLinkBytes()

Output only. The link to service attachment of PSC instance.

optional string psc_service_attachment_link = 48 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for pscServiceAttachmentLink.

getRegion()

public String getRegion()

The geographical region of the Cloud SQL instance.

It can be one of the regions where Cloud SQL operates:

For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.

string region = 24;

Returns
Type	Description
String	The region.

getRegionBytes()

public ByteString getRegionBytes()

The geographical region of the Cloud SQL instance.

It can be one of the regions where Cloud SQL operates:

For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.

string region = 24;

Returns
Type	Description
ByteString	The bytes for region.

getReplicaConfiguration()

public ReplicaConfiguration getReplicaConfiguration()

Configuration specific to failover replicas and read replicas.

.google.cloud.sql.v1.ReplicaConfiguration replica_configuration = 18;

Returns
Type	Description
ReplicaConfiguration	The replicaConfiguration.

getReplicaConfigurationOrBuilder()

public ReplicaConfigurationOrBuilder getReplicaConfigurationOrBuilder()

Configuration specific to failover replicas and read replicas.

.google.cloud.sql.v1.ReplicaConfiguration replica_configuration = 18;

Returns
Type	Description
ReplicaConfigurationOrBuilder

getReplicaNames(int index)

public String getReplicaNames(int index)

The replicas of the instance.

repeated string replica_names = 8;

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

Returns
Type	Description
String	The replicaNames at the given index.

getReplicaNamesBytes(int index)

public ByteString getReplicaNamesBytes(int index)

The replicas of the instance.

repeated string replica_names = 8;

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

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

getReplicaNamesCount()

public int getReplicaNamesCount()

The replicas of the instance.

repeated string replica_names = 8;

Returns
Type	Description
int	The count of replicaNames.

getReplicaNamesList()

public ProtocolStringList getReplicaNamesList()

The replicas of the instance.

repeated string replica_names = 8;

Returns
Type	Description
ProtocolStringList	A list containing the replicaNames.

getReplicationCluster()

public ReplicationCluster getReplicationCluster()

Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.

.google.cloud.sql.v1.ReplicationCluster replication_cluster = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReplicationCluster	The replicationCluster.

getReplicationClusterOrBuilder()

public ReplicationClusterOrBuilder getReplicationClusterOrBuilder()

Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.

.google.cloud.sql.v1.ReplicationCluster replication_cluster = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReplicationClusterOrBuilder

getRootPassword()

public String getRootPassword()

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

string root_password = 29;

Returns
Type	Description
String	The rootPassword.

getRootPasswordBytes()

public ByteString getRootPasswordBytes()

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

string root_password = 29;

Returns
Type	Description
ByteString	The bytes for rootPassword.

getSatisfiesPzi()

public BoolValue getSatisfiesPzi()

Output only. This status indicates whether the instance satisfies PZI.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzi = 56 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BoolValue	The satisfiesPzi.

getSatisfiesPziOrBuilder()

public BoolValueOrBuilder getSatisfiesPziOrBuilder()

Output only. This status indicates whether the instance satisfies PZI.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzi = 56 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BoolValueOrBuilder

getSatisfiesPzs()

public BoolValue getSatisfiesPzs()

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Returns
Type	Description
BoolValue	The satisfiesPzs.

getSatisfiesPzsOrBuilder()

public BoolValueOrBuilder getSatisfiesPzsOrBuilder()

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Returns
Type	Description
BoolValueOrBuilder

getScheduledMaintenance()

public DatabaseInstance.SqlScheduledMaintenance getScheduledMaintenance()

The start time of any upcoming scheduled maintenance for this instance.

.google.cloud.sql.v1.DatabaseInstance.SqlScheduledMaintenance scheduled_maintenance = 30;

Returns
Type	Description
DatabaseInstance.SqlScheduledMaintenance	The scheduledMaintenance.

getScheduledMaintenanceOrBuilder()

public DatabaseInstance.SqlScheduledMaintenanceOrBuilder getScheduledMaintenanceOrBuilder()

The start time of any upcoming scheduled maintenance for this instance.

.google.cloud.sql.v1.DatabaseInstance.SqlScheduledMaintenance scheduled_maintenance = 30;

Returns
Type	Description
DatabaseInstance.SqlScheduledMaintenanceOrBuilder

getSecondaryGceZone()

public String getSecondaryGceZone()

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.

string secondary_gce_zone = 34;

Returns
Type	Description
String	The secondaryGceZone.

getSecondaryGceZoneBytes()

public ByteString getSecondaryGceZoneBytes()

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.

string secondary_gce_zone = 34;

Returns
Type	Description
ByteString	The bytes for secondaryGceZone.

getSelfLink()

public String getSelfLink()

The URI of this resource.

string self_link = 20;

Returns
Type	Description
String	The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

The URI of this resource.

string self_link = 20;

Returns
Type	Description
ByteString	The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getServerCaCert()

public SslCert getServerCaCert()

SSL configuration.

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

Returns
Type	Description
SslCert	The serverCaCert.

getServerCaCertOrBuilder()

public SslCertOrBuilder getServerCaCertOrBuilder()

SSL configuration.

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

Returns
Type	Description
SslCertOrBuilder

getServiceAccountEmailAddress()

public String getServiceAccountEmailAddress()

The service account email address assigned to the instance.\This property is read-only.

string service_account_email_address = 16;

Returns
Type	Description
String	The serviceAccountEmailAddress.

getServiceAccountEmailAddressBytes()

public ByteString getServiceAccountEmailAddressBytes()

The service account email address assigned to the instance.\This property is read-only.

string service_account_email_address = 16;

Returns
Type	Description
ByteString	The bytes for serviceAccountEmailAddress.

getSettings()

public Settings getSettings()

The user settings.

.google.cloud.sql.v1.Settings settings = 4;

Returns
Type	Description
Settings	The settings.

getSettingsOrBuilder()

public SettingsOrBuilder getSettingsOrBuilder()

The user settings.

.google.cloud.sql.v1.Settings settings = 4;

Returns
Type	Description
SettingsOrBuilder

getSqlNetworkArchitecture()

public DatabaseInstance.SqlNetworkArchitecture getSqlNetworkArchitecture()

optional .google.cloud.sql.v1.DatabaseInstance.SqlNetworkArchitecture sql_network_architecture = 47;

Returns
Type	Description
DatabaseInstance.SqlNetworkArchitecture	The sqlNetworkArchitecture.

getSqlNetworkArchitectureValue()

public int getSqlNetworkArchitectureValue()

optional .google.cloud.sql.v1.DatabaseInstance.SqlNetworkArchitecture sql_network_architecture = 47;

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

getState()

public DatabaseInstance.SqlInstanceState getState()

The current serving state of the Cloud SQL instance.

.google.cloud.sql.v1.DatabaseInstance.SqlInstanceState state = 2;

Returns
Type	Description
DatabaseInstance.SqlInstanceState	The state.

getStateValue()

public int getStateValue()

The current serving state of the Cloud SQL instance.

.google.cloud.sql.v1.DatabaseInstance.SqlInstanceState state = 2;

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

getSuspensionReason(int index)

public SqlSuspensionReason getSuspensionReason(int index)

If the instance state is SUSPENDED, the reason for the suspension.

repeated .google.cloud.sql.v1.SqlSuspensionReason suspension_reason = 21;

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

Returns
Type	Description
SqlSuspensionReason	The suspensionReason at the given index.

getSuspensionReasonCount()

public int getSuspensionReasonCount()

If the instance state is SUSPENDED, the reason for the suspension.

repeated .google.cloud.sql.v1.SqlSuspensionReason suspension_reason = 21;

Returns
Type	Description
int	The count of suspensionReason.

getSuspensionReasonList()

public List<SqlSuspensionReason> getSuspensionReasonList()

If the instance state is SUSPENDED, the reason for the suspension.

repeated .google.cloud.sql.v1.SqlSuspensionReason suspension_reason = 21;

Returns
Type	Description
List<SqlSuspensionReason>	A list containing the suspensionReason.

getSuspensionReasonValue(int index)

public int getSuspensionReasonValue(int index)

If the instance state is SUSPENDED, the reason for the suspension.

repeated .google.cloud.sql.v1.SqlSuspensionReason suspension_reason = 21;

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

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

getSuspensionReasonValueList()

public List<Integer> getSuspensionReasonValueList()

If the instance state is SUSPENDED, the reason for the suspension.

repeated .google.cloud.sql.v1.SqlSuspensionReason suspension_reason = 21;

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

getSwitchTransactionLogsToCloudStorageEnabled()

public BoolValue getSwitchTransactionLogsToCloudStorageEnabled()

Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.

optional .google.protobuf.BoolValue switch_transaction_logs_to_cloud_storage_enabled = 57 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
BoolValue	The switchTransactionLogsToCloudStorageEnabled.

getSwitchTransactionLogsToCloudStorageEnabledOrBuilder()

public BoolValueOrBuilder getSwitchTransactionLogsToCloudStorageEnabledOrBuilder()

Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.

optional .google.protobuf.BoolValue switch_transaction_logs_to_cloud_storage_enabled = 57 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
BoolValueOrBuilder

getTags() (deprecated)

public Map<String,String> getTags()

Use #getTagsMap() instead.

Returns
Type	Description
Map<String,String>

getTagsCount()

public int getTagsCount()

Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

For example, a single resource can have the following tags: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code>

For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.

map<string, string> tags = 60 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getTagsMap()

public Map<String,String> getTagsMap()

Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

For example, a single resource can have the following tags: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code>

For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.

map<string, string> tags = 60 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getTagsOrDefault(String key, String defaultValue)

public String getTagsOrDefault(String key, String defaultValue)

Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

For example, a single resource can have the following tags: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code>

For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.

map<string, string> tags = 60 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getTagsOrThrow(String key)

public String getTagsOrThrow(String key)

Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

For example, a single resource can have the following tags: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code>

For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.

map<string, string> tags = 60 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getUpgradableDatabaseVersions(int index)

public AvailableDatabaseVersion getUpgradableDatabaseVersions(int index)

Output only. All database versions that are available for upgrade.

repeated .google.cloud.sql.v1.AvailableDatabaseVersion upgradable_database_versions = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
AvailableDatabaseVersion

getUpgradableDatabaseVersionsCount()

public int getUpgradableDatabaseVersionsCount()

Output only. All database versions that are available for upgrade.

repeated .google.cloud.sql.v1.AvailableDatabaseVersion upgradable_database_versions = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getUpgradableDatabaseVersionsList()

public List<AvailableDatabaseVersion> getUpgradableDatabaseVersionsList()

Output only. All database versions that are available for upgrade.

repeated .google.cloud.sql.v1.AvailableDatabaseVersion upgradable_database_versions = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<AvailableDatabaseVersion>

getUpgradableDatabaseVersionsOrBuilder(int index)

public AvailableDatabaseVersionOrBuilder getUpgradableDatabaseVersionsOrBuilder(int index)

Output only. All database versions that are available for upgrade.

repeated .google.cloud.sql.v1.AvailableDatabaseVersion upgradable_database_versions = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
AvailableDatabaseVersionOrBuilder

getUpgradableDatabaseVersionsOrBuilderList()

public List<? extends AvailableDatabaseVersionOrBuilder> getUpgradableDatabaseVersionsOrBuilderList()

Output only. All database versions that are available for upgrade.

repeated .google.cloud.sql.v1.AvailableDatabaseVersion upgradable_database_versions = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getWriteEndpoint()

public String getWriteEndpoint()

Output only. The dns name of the primary instance in a replication group.

optional string write_endpoint = 52 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The writeEndpoint.

getWriteEndpointBytes()

public ByteString getWriteEndpointBytes()

Output only. The dns name of the primary instance in a replication group.

optional string write_endpoint = 52 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for writeEndpoint.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp create_time = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCurrentDiskSize() (deprecated)

public boolean hasCurrentDiskSize()

Deprecated. google.cloud.sql.v1.DatabaseInstance.current_disk_size is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1590

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

.google.protobuf.Int64Value current_disk_size = 10 [deprecated = true];

Returns
Type	Description
boolean	Whether the currentDiskSize field is set.

hasDatabaseCenterIntegrationEnabled()

public boolean hasDatabaseCenterIntegrationEnabled()

Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center.

.google.protobuf.BoolValue database_center_integration_enabled = 72 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the databaseCenterIntegrationEnabled field is set.

hasDiskEncryptionConfiguration()

public boolean hasDiskEncryptionConfiguration()

Disk encryption configuration specific to an instance.

.google.cloud.sql.v1.DiskEncryptionConfiguration disk_encryption_configuration = 26;

Returns
Type	Description
boolean	Whether the diskEncryptionConfiguration field is set.

hasDiskEncryptionStatus()

public boolean hasDiskEncryptionStatus()

Disk encryption status specific to an instance.

.google.cloud.sql.v1.DiskEncryptionStatus disk_encryption_status = 27;

Returns
Type	Description
boolean	Whether the diskEncryptionStatus field is set.

hasDnsName()

public boolean hasDnsName()

Output only. The dns name of the instance.

optional string dns_name = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the dnsName field is set.

hasFailoverReplica()

public boolean hasFailoverReplica()

The name and status of the failover replica.

.google.cloud.sql.v1.DatabaseInstance.SqlFailoverReplica failover_replica = 6;

Returns
Type	Description
boolean	Whether the failoverReplica field is set.

hasGeminiConfig()

public boolean hasGeminiConfig()

Gemini instance configuration.

optional .google.cloud.sql.v1.GeminiInstanceConfig gemini_config = 55;

Returns
Type	Description
boolean	Whether the geminiConfig field is set.

hasIncludeReplicasForMajorVersionUpgrade()

public boolean hasIncludeReplicasForMajorVersionUpgrade()

Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.

optional .google.protobuf.BoolValue include_replicas_for_major_version_upgrade = 59 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
boolean	Whether the includeReplicasForMajorVersionUpgrade field is set.

hasMaxDiskSize() (deprecated)

public boolean hasMaxDiskSize()

Deprecated. google.cloud.sql.v1.DatabaseInstance.max_disk_size is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1582

The maximum disk size of the instance in bytes.

.google.protobuf.Int64Value max_disk_size = 9 [deprecated = true];

Returns
Type	Description
boolean	Whether the maxDiskSize field is set.

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.

hasOnPremisesConfiguration()

public boolean hasOnPremisesConfiguration()

Configuration specific to on-premises instances.

.google.cloud.sql.v1.OnPremisesConfiguration on_premises_configuration = 17;

Returns
Type	Description
boolean	Whether the onPremisesConfiguration field is set.

hasOutOfDiskReport()

public boolean hasOutOfDiskReport()

This field represents the report generated by the proactive database wellness job for OutOfDisk issues.

• Writers:
• the proactive database wellness job for OOD.
• Readers:
• the proactive database wellness job

optional .google.cloud.sql.v1.DatabaseInstance.SqlOutOfDiskReport out_of_disk_report = 38;

Returns
Type	Description
boolean	Whether the outOfDiskReport field is set.

hasPrimaryDnsName() (deprecated)

public boolean hasPrimaryDnsName()

Deprecated. google.cloud.sql.v1.DatabaseInstance.primary_dns_name is deprecated. See google/cloud/sql/v1/cloud_sql_instances.proto;l=1720

Output only. DEPRECATED: please use write_endpoint instead.

optional string primary_dns_name = 51 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the primaryDnsName field is set.

hasPscServiceAttachmentLink()

public boolean hasPscServiceAttachmentLink()

Output only. The link to service attachment of PSC instance.

optional string psc_service_attachment_link = 48 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the pscServiceAttachmentLink field is set.

hasReplicaConfiguration()

public boolean hasReplicaConfiguration()

Configuration specific to failover replicas and read replicas.

.google.cloud.sql.v1.ReplicaConfiguration replica_configuration = 18;

Returns
Type	Description
boolean	Whether the replicaConfiguration field is set.

hasReplicationCluster()

public boolean hasReplicationCluster()

Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.

.google.cloud.sql.v1.ReplicationCluster replication_cluster = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the replicationCluster field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. This status indicates whether the instance satisfies PZI.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzi = 56 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Returns
Type	Description
boolean	Whether the satisfiesPzs field is set.

hasScheduledMaintenance()

public boolean hasScheduledMaintenance()

The start time of any upcoming scheduled maintenance for this instance.

.google.cloud.sql.v1.DatabaseInstance.SqlScheduledMaintenance scheduled_maintenance = 30;

Returns
Type	Description
boolean	Whether the scheduledMaintenance field is set.

hasServerCaCert()

public boolean hasServerCaCert()

SSL configuration.

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

Returns
Type	Description
boolean	Whether the serverCaCert field is set.

hasSettings()

public boolean hasSettings()

The user settings.

.google.cloud.sql.v1.Settings settings = 4;

Returns
Type	Description
boolean	Whether the settings field is set.

hasSqlNetworkArchitecture()

public boolean hasSqlNetworkArchitecture()

optional .google.cloud.sql.v1.DatabaseInstance.SqlNetworkArchitecture sql_network_architecture = 47;

Returns
Type	Description
boolean	Whether the sqlNetworkArchitecture field is set.

hasSwitchTransactionLogsToCloudStorageEnabled()

public boolean hasSwitchTransactionLogsToCloudStorageEnabled()

Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.

optional .google.protobuf.BoolValue switch_transaction_logs_to_cloud_storage_enabled = 57 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
boolean	Whether the switchTransactionLogsToCloudStorageEnabled field is set.

hasWriteEndpoint()

public boolean hasWriteEndpoint()

Output only. The dns name of the primary instance in a replication group.

optional string write_endpoint = 52 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the writeEndpoint field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public DatabaseInstance.Builder newBuilderForType()

Returns
Type	Description
DatabaseInstance.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DatabaseInstance.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DatabaseInstance.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public DatabaseInstance.Builder toBuilder()

Returns
Type	Description
DatabaseInstance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException