Class DatabaseInstance.Builder (0.1.0) 

public static final class DatabaseInstance.Builder extends GeneratedMessage.Builder<DatabaseInstance.Builder> implements DatabaseInstanceOrBuilder

A Cloud SQL instance resource.

Protobuf type google.cloud.sql.v1.DatabaseInstance

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DatabaseInstance.Builder

Static Methods

getDescriptor()

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

Methods

addAllAvailableMaintenanceVersions(Iterable<String> values)

public DatabaseInstance.Builder addAllAvailableMaintenanceVersions(Iterable<String> values)

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
values Iterable<String>

The availableMaintenanceVersions to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addAllDnsNames(Iterable<? extends DnsNameMapping> values)

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.sql.v1.DnsNameMapping>
Returns
Type Description
DatabaseInstance.Builder

addAllIpAddresses(Iterable<? extends IpMapping> values)

public DatabaseInstance.Builder addAllIpAddresses(Iterable<? extends IpMapping> values)

The assigned IP addresses for the instance.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.sql.v1.IpMapping>
Returns
Type Description
DatabaseInstance.Builder

addAllNodes(Iterable<? extends DatabaseInstance.PoolNodeConfig> values)

public DatabaseInstance.Builder addAllNodes(Iterable<? extends DatabaseInstance.PoolNodeConfig> values)

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
values Iterable<? extends com.google.cloud.sql.v1.DatabaseInstance.PoolNodeConfig>
Returns
Type Description
DatabaseInstance.Builder

addAllReplicaNames(Iterable<String> values)

public DatabaseInstance.Builder addAllReplicaNames(Iterable<String> values)

The replicas of the instance.

repeated string replica_names = 8;

Parameter
Name Description
values Iterable<String>

The replicaNames to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addAllSuspensionReason(Iterable<? extends SqlSuspensionReason> values)

public DatabaseInstance.Builder addAllSuspensionReason(Iterable<? extends SqlSuspensionReason> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.sql.v1.SqlSuspensionReason>

The suspensionReason to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addAllSuspensionReasonValue(Iterable<Integer> values)

public DatabaseInstance.Builder addAllSuspensionReasonValue(Iterable<Integer> values)

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

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

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for suspensionReason to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addAllUpgradableDatabaseVersions(Iterable<? extends AvailableDatabaseVersion> values)

public DatabaseInstance.Builder addAllUpgradableDatabaseVersions(Iterable<? extends AvailableDatabaseVersion> values)

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
values Iterable<? extends com.google.cloud.sql.v1.AvailableDatabaseVersion>
Returns
Type Description
DatabaseInstance.Builder

addAvailableMaintenanceVersions(String value)

public DatabaseInstance.Builder addAvailableMaintenanceVersions(String value)

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
value String

The availableMaintenanceVersions to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addAvailableMaintenanceVersionsBytes(ByteString value)

public DatabaseInstance.Builder addAvailableMaintenanceVersionsBytes(ByteString value)

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
value ByteString

The bytes of the availableMaintenanceVersions to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addDnsNames(DnsNameMapping value)

public DatabaseInstance.Builder addDnsNames(DnsNameMapping value)

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
value DnsNameMapping
Returns
Type Description
DatabaseInstance.Builder

addDnsNames(DnsNameMapping.Builder builderForValue)

public DatabaseInstance.Builder addDnsNames(DnsNameMapping.Builder builderForValue)

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
builderForValue DnsNameMapping.Builder
Returns
Type Description
DatabaseInstance.Builder

addDnsNames(int index, DnsNameMapping value)

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

Parameters
Name Description
index int
value DnsNameMapping
Returns
Type Description
DatabaseInstance.Builder

addDnsNames(int index, DnsNameMapping.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DnsNameMapping.Builder
Returns
Type Description
DatabaseInstance.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 = 67 [(.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 = 67 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DnsNameMapping.Builder

addIpAddresses(IpMapping value)

public DatabaseInstance.Builder addIpAddresses(IpMapping value)

The assigned IP addresses for the instance.

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

Parameter
Name Description
value IpMapping
Returns
Type Description
DatabaseInstance.Builder

addIpAddresses(IpMapping.Builder builderForValue)

public DatabaseInstance.Builder addIpAddresses(IpMapping.Builder builderForValue)

The assigned IP addresses for the instance.

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

Parameter
Name Description
builderForValue IpMapping.Builder
Returns
Type Description
DatabaseInstance.Builder

addIpAddresses(int index, IpMapping value)

public DatabaseInstance.Builder addIpAddresses(int index, IpMapping value)

The assigned IP addresses for the instance.

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

Parameters
Name Description
index int
value IpMapping
Returns
Type Description
DatabaseInstance.Builder

addIpAddresses(int index, IpMapping.Builder builderForValue)

public DatabaseInstance.Builder addIpAddresses(int index, IpMapping.Builder builderForValue)

The assigned IP addresses for the instance.

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

Parameters
Name Description
index int
builderForValue IpMapping.Builder
Returns
Type Description
DatabaseInstance.Builder

addIpAddressesBuilder()

public IpMapping.Builder addIpAddressesBuilder()

The assigned IP addresses for the instance.

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

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

Parameter
Name Description
index int
Returns
Type Description
IpMapping.Builder

addNodes(DatabaseInstance.PoolNodeConfig value)

public DatabaseInstance.Builder addNodes(DatabaseInstance.PoolNodeConfig value)

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
value DatabaseInstance.PoolNodeConfig
Returns
Type Description
DatabaseInstance.Builder

addNodes(DatabaseInstance.PoolNodeConfig.Builder builderForValue)

public DatabaseInstance.Builder addNodes(DatabaseInstance.PoolNodeConfig.Builder builderForValue)

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
builderForValue DatabaseInstance.PoolNodeConfig.Builder
Returns
Type Description
DatabaseInstance.Builder

addNodes(int index, DatabaseInstance.PoolNodeConfig value)

public DatabaseInstance.Builder addNodes(int index, DatabaseInstance.PoolNodeConfig value)

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];

Parameters
Name Description
index int
value DatabaseInstance.PoolNodeConfig
Returns
Type Description
DatabaseInstance.Builder

addNodes(int index, DatabaseInstance.PoolNodeConfig.Builder builderForValue)

public DatabaseInstance.Builder addNodes(int index, DatabaseInstance.PoolNodeConfig.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue DatabaseInstance.PoolNodeConfig.Builder
Returns
Type Description
DatabaseInstance.Builder

addNodesBuilder()

public DatabaseInstance.PoolNodeConfig.Builder addNodesBuilder()

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
DatabaseInstance.PoolNodeConfig.Builder

addNodesBuilder(int index)

public DatabaseInstance.PoolNodeConfig.Builder addNodesBuilder(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.Builder

addReplicaNames(String value)

public DatabaseInstance.Builder addReplicaNames(String value)

The replicas of the instance.

repeated string replica_names = 8;

Parameter
Name Description
value String

The replicaNames to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addReplicaNamesBytes(ByteString value)

public DatabaseInstance.Builder addReplicaNamesBytes(ByteString value)

The replicas of the instance.

repeated string replica_names = 8;

Parameter
Name Description
value ByteString

The bytes of the replicaNames to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addSuspensionReason(SqlSuspensionReason value)

public DatabaseInstance.Builder addSuspensionReason(SqlSuspensionReason value)

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

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

Parameter
Name Description
value SqlSuspensionReason

The suspensionReason to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addSuspensionReasonValue(int value)

public DatabaseInstance.Builder addSuspensionReasonValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for suspensionReason to add.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

addUpgradableDatabaseVersions(AvailableDatabaseVersion value)

public DatabaseInstance.Builder addUpgradableDatabaseVersions(AvailableDatabaseVersion value)

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
value AvailableDatabaseVersion
Returns
Type Description
DatabaseInstance.Builder

addUpgradableDatabaseVersions(AvailableDatabaseVersion.Builder builderForValue)

public DatabaseInstance.Builder addUpgradableDatabaseVersions(AvailableDatabaseVersion.Builder builderForValue)

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
builderForValue AvailableDatabaseVersion.Builder
Returns
Type Description
DatabaseInstance.Builder

addUpgradableDatabaseVersions(int index, AvailableDatabaseVersion value)

public DatabaseInstance.Builder addUpgradableDatabaseVersions(int index, AvailableDatabaseVersion value)

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];

Parameters
Name Description
index int
value AvailableDatabaseVersion
Returns
Type Description
DatabaseInstance.Builder

addUpgradableDatabaseVersions(int index, AvailableDatabaseVersion.Builder builderForValue)

public DatabaseInstance.Builder addUpgradableDatabaseVersions(int index, AvailableDatabaseVersion.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AvailableDatabaseVersion.Builder
Returns
Type Description
DatabaseInstance.Builder

addUpgradableDatabaseVersionsBuilder()

public AvailableDatabaseVersion.Builder addUpgradableDatabaseVersionsBuilder()

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
AvailableDatabaseVersion.Builder

addUpgradableDatabaseVersionsBuilder(int index)

public AvailableDatabaseVersion.Builder addUpgradableDatabaseVersionsBuilder(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.Builder

build()

public DatabaseInstance build()
Returns
Type Description
DatabaseInstance

buildPartial()

public DatabaseInstance buildPartial()
Returns
Type Description
DatabaseInstance

clear()

public DatabaseInstance.Builder clear()
Returns
Type Description
DatabaseInstance.Builder
Overrides

clearAvailableMaintenanceVersions()

public DatabaseInstance.Builder clearAvailableMaintenanceVersions()

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
DatabaseInstance.Builder

This builder for chaining.

clearBackendType()

public DatabaseInstance.Builder clearBackendType()

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
DatabaseInstance.Builder

This builder for chaining.

clearConnectionName()

public DatabaseInstance.Builder clearConnectionName()

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

string connection_name = 22;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearCreateTime()

public DatabaseInstance.Builder clearCreateTime()

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
DatabaseInstance.Builder

clearCurrentDiskSize() (deprecated)

public DatabaseInstance.Builder clearCurrentDiskSize()

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
DatabaseInstance.Builder

clearDatabaseCenterIntegrationEnabled()

public DatabaseInstance.Builder clearDatabaseCenterIntegrationEnabled()

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
DatabaseInstance.Builder

clearDatabaseInstalledVersion()

public DatabaseInstance.Builder clearDatabaseInstalledVersion()

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
DatabaseInstance.Builder

This builder for chaining.

clearDatabaseVersion()

public DatabaseInstance.Builder clearDatabaseVersion()

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
DatabaseInstance.Builder

This builder for chaining.

clearDiskEncryptionConfiguration()

public DatabaseInstance.Builder clearDiskEncryptionConfiguration()

Disk encryption configuration specific to an instance.

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

Returns
Type Description
DatabaseInstance.Builder

clearDiskEncryptionStatus()

public DatabaseInstance.Builder clearDiskEncryptionStatus()

Disk encryption status specific to an instance.

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

Returns
Type Description
DatabaseInstance.Builder

clearDnsName()

public DatabaseInstance.Builder clearDnsName()

Output only. The dns name of the instance.

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

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearDnsNames()

public DatabaseInstance.Builder clearDnsNames()

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
DatabaseInstance.Builder

clearEtag()

public DatabaseInstance.Builder clearEtag()

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
DatabaseInstance.Builder

This builder for chaining.

clearFailoverReplica()

public DatabaseInstance.Builder clearFailoverReplica()

The name and status of the failover replica.

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

Returns
Type Description
DatabaseInstance.Builder

clearGceZone()

public DatabaseInstance.Builder clearGceZone()

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
DatabaseInstance.Builder

This builder for chaining.

clearGeminiConfig()

public DatabaseInstance.Builder clearGeminiConfig()

Gemini instance configuration.

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

Returns
Type Description
DatabaseInstance.Builder

clearIncludeReplicasForMajorVersionUpgrade()

public DatabaseInstance.Builder clearIncludeReplicasForMajorVersionUpgrade()

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
DatabaseInstance.Builder

clearInstanceType()

public DatabaseInstance.Builder clearInstanceType()

The instance type.

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

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearIpAddresses()

public DatabaseInstance.Builder clearIpAddresses()

The assigned IP addresses for the instance.

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

Returns
Type Description
DatabaseInstance.Builder

clearIpv6Address() (deprecated)

public DatabaseInstance.Builder clearIpv6Address()

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
DatabaseInstance.Builder

This builder for chaining.

clearKind()

public DatabaseInstance.Builder clearKind()

This is always sql#instance.

string kind = 1;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearMaintenanceVersion()

public DatabaseInstance.Builder clearMaintenanceVersion()

The current software version on the instance.

string maintenance_version = 42;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearMasterInstanceName()

public DatabaseInstance.Builder clearMasterInstanceName()

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

string master_instance_name = 7;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearMaxDiskSize() (deprecated)

public DatabaseInstance.Builder clearMaxDiskSize()

The maximum disk size of the instance in bytes.

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

Returns
Type Description
DatabaseInstance.Builder

clearName()

public DatabaseInstance.Builder clearName()

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

string name = 23;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearNodeCount()

public DatabaseInstance.Builder clearNodeCount()

The number of read pool nodes in a read pool.

optional int32 node_count = 63;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearNodes()

public DatabaseInstance.Builder clearNodes()

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
DatabaseInstance.Builder

clearOnPremisesConfiguration()

public DatabaseInstance.Builder clearOnPremisesConfiguration()

Configuration specific to on-premises instances.

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

Returns
Type Description
DatabaseInstance.Builder

clearOutOfDiskReport()

public DatabaseInstance.Builder clearOutOfDiskReport()

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.Builder

clearPrimaryDnsName() (deprecated)

public DatabaseInstance.Builder clearPrimaryDnsName()

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
DatabaseInstance.Builder

This builder for chaining.

clearProject()

public DatabaseInstance.Builder clearProject()

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
DatabaseInstance.Builder

This builder for chaining.

clearPscServiceAttachmentLink()

public DatabaseInstance.Builder clearPscServiceAttachmentLink()

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
DatabaseInstance.Builder

This builder for chaining.

clearRegion()

public DatabaseInstance.Builder clearRegion()

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
DatabaseInstance.Builder

This builder for chaining.

clearReplicaConfiguration()

public DatabaseInstance.Builder clearReplicaConfiguration()

Configuration specific to failover replicas and read replicas.

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

Returns
Type Description
DatabaseInstance.Builder

clearReplicaNames()

public DatabaseInstance.Builder clearReplicaNames()

The replicas of the instance.

repeated string replica_names = 8;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearReplicationCluster()

public DatabaseInstance.Builder clearReplicationCluster()

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
DatabaseInstance.Builder

clearRootPassword()

public DatabaseInstance.Builder clearRootPassword()

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
DatabaseInstance.Builder

This builder for chaining.

clearSatisfiesPzi()

public DatabaseInstance.Builder clearSatisfiesPzi()

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
DatabaseInstance.Builder

clearSatisfiesPzs()

public DatabaseInstance.Builder clearSatisfiesPzs()

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Returns
Type Description
DatabaseInstance.Builder

clearScheduledMaintenance()

public DatabaseInstance.Builder clearScheduledMaintenance()

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

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

Returns
Type Description
DatabaseInstance.Builder

clearSecondaryGceZone()

public DatabaseInstance.Builder clearSecondaryGceZone()

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
DatabaseInstance.Builder

This builder for chaining.

clearSelfLink()

public DatabaseInstance.Builder clearSelfLink()

The URI of this resource.

string self_link = 20;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearServerCaCert()

public DatabaseInstance.Builder clearServerCaCert()

SSL configuration.

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

Returns
Type Description
DatabaseInstance.Builder

clearServiceAccountEmailAddress()

public DatabaseInstance.Builder clearServiceAccountEmailAddress()

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

string service_account_email_address = 16;

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearSettings()

public DatabaseInstance.Builder clearSettings()

The user settings.

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

Returns
Type Description
DatabaseInstance.Builder

clearSqlNetworkArchitecture()

public DatabaseInstance.Builder clearSqlNetworkArchitecture()

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

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearState()

public DatabaseInstance.Builder clearState()

The current serving state of the Cloud SQL instance.

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

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearSuspensionReason()

public DatabaseInstance.Builder clearSuspensionReason()

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

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

Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

clearSwitchTransactionLogsToCloudStorageEnabled()

public DatabaseInstance.Builder clearSwitchTransactionLogsToCloudStorageEnabled()

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
DatabaseInstance.Builder

clearTags()

public DatabaseInstance.Builder clearTags()
Returns
Type Description
DatabaseInstance.Builder

clearUpgradableDatabaseVersions()

public DatabaseInstance.Builder clearUpgradableDatabaseVersions()

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
DatabaseInstance.Builder

clearWriteEndpoint()

public DatabaseInstance.Builder clearWriteEndpoint()

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
DatabaseInstance.Builder

This builder for chaining.

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

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getCurrentDiskSizeBuilder() (deprecated)

public Int64Value.Builder getCurrentDiskSizeBuilder()

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
Builder

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.

getDatabaseCenterIntegrationEnabledBuilder()

public BoolValue.Builder getDatabaseCenterIntegrationEnabledBuilder()

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
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDiskEncryptionConfigurationBuilder()

public DiskEncryptionConfiguration.Builder getDiskEncryptionConfigurationBuilder()

Disk encryption configuration specific to an instance.

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

Returns
Type Description
DiskEncryptionConfiguration.Builder

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.

getDiskEncryptionStatusBuilder()

public DiskEncryptionStatus.Builder getDiskEncryptionStatusBuilder()

Disk encryption status specific to an instance.

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

Returns
Type Description
DiskEncryptionStatus.Builder

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

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 = 67 [(.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 = 67 [(.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 = 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.

getFailoverReplicaBuilder()

public DatabaseInstance.SqlFailoverReplica.Builder getFailoverReplicaBuilder()

The name and status of the failover replica.

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

Returns
Type Description
DatabaseInstance.SqlFailoverReplica.Builder

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.

getGeminiConfigBuilder()

public GeminiInstanceConfig.Builder getGeminiConfigBuilder()

Gemini instance configuration.

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

Returns
Type Description
GeminiInstanceConfig.Builder

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.

getIncludeReplicasForMajorVersionUpgradeBuilder()

public BoolValue.Builder getIncludeReplicasForMajorVersionUpgradeBuilder()

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
Builder

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

getIpAddressesBuilder(int index)

public IpMapping.Builder getIpAddressesBuilder(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.Builder

getIpAddressesBuilderList()

public List<IpMapping.Builder> getIpAddressesBuilderList()

The assigned IP addresses for the instance.

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

Returns
Type Description
List<Builder>

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.

getMaxDiskSizeBuilder() (deprecated)

public Int64Value.Builder getMaxDiskSizeBuilder()

The maximum disk size of the instance in bytes.

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

Returns
Type Description
Builder

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

getMutableTags() (deprecated)

public Map<String,String> getMutableTags()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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

getNodesBuilder(int index)

public DatabaseInstance.PoolNodeConfig.Builder getNodesBuilder(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.Builder

getNodesBuilderList()

public List<DatabaseInstance.PoolNodeConfig.Builder> getNodesBuilderList()

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<Builder>

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.

getOnPremisesConfigurationBuilder()

public OnPremisesConfiguration.Builder getOnPremisesConfigurationBuilder()

Configuration specific to on-premises instances.

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

Returns
Type Description
OnPremisesConfiguration.Builder

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.

getOutOfDiskReportBuilder()

public DatabaseInstance.SqlOutOfDiskReport.Builder getOutOfDiskReportBuilder()

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.Builder

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

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.

getReplicaConfigurationBuilder()

public ReplicaConfiguration.Builder getReplicaConfigurationBuilder()

Configuration specific to failover replicas and read replicas.

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

Returns
Type Description
ReplicaConfiguration.Builder

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.

getReplicationClusterBuilder()

public ReplicationCluster.Builder getReplicationClusterBuilder()

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.Builder

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.

getSatisfiesPziBuilder()

public BoolValue.Builder getSatisfiesPziBuilder()

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
Builder

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.

getSatisfiesPzsBuilder()

public BoolValue.Builder getSatisfiesPzsBuilder()

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Returns
Type Description
Builder

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.

getScheduledMaintenanceBuilder()

public DatabaseInstance.SqlScheduledMaintenance.Builder getScheduledMaintenanceBuilder()

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.Builder

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.

getServerCaCert()

public SslCert getServerCaCert()

SSL configuration.

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

Returns
Type Description
SslCert

The serverCaCert.

getServerCaCertBuilder()

public SslCert.Builder getServerCaCertBuilder()

SSL configuration.

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

Returns
Type Description
SslCert.Builder

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.

getSettingsBuilder()

public Settings.Builder getSettingsBuilder()

The user settings.

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

Returns
Type Description
Settings.Builder

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.

getSwitchTransactionLogsToCloudStorageEnabledBuilder()

public BoolValue.Builder getSwitchTransactionLogsToCloudStorageEnabledBuilder()

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
Builder

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

getUpgradableDatabaseVersionsBuilder(int index)

public AvailableDatabaseVersion.Builder getUpgradableDatabaseVersionsBuilder(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.Builder

getUpgradableDatabaseVersionsBuilderList()

public List<AvailableDatabaseVersion.Builder> getUpgradableDatabaseVersionsBuilderList()

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<Builder>

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.

internalGetFieldAccessorTable()

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

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public DatabaseInstance.Builder mergeCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
DatabaseInstance.Builder

mergeCurrentDiskSize(Int64Value value) (deprecated)

public DatabaseInstance.Builder mergeCurrentDiskSize(Int64Value value)

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];

Parameter
Name Description
value Int64Value
Returns
Type Description
DatabaseInstance.Builder

mergeDatabaseCenterIntegrationEnabled(BoolValue value)

public DatabaseInstance.Builder mergeDatabaseCenterIntegrationEnabled(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

mergeDiskEncryptionConfiguration(DiskEncryptionConfiguration value)

public DatabaseInstance.Builder mergeDiskEncryptionConfiguration(DiskEncryptionConfiguration value)

Disk encryption configuration specific to an instance.

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

Parameter
Name Description
value DiskEncryptionConfiguration
Returns
Type Description
DatabaseInstance.Builder

mergeDiskEncryptionStatus(DiskEncryptionStatus value)

public DatabaseInstance.Builder mergeDiskEncryptionStatus(DiskEncryptionStatus value)

Disk encryption status specific to an instance.

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

Parameter
Name Description
value DiskEncryptionStatus
Returns
Type Description
DatabaseInstance.Builder

mergeFailoverReplica(DatabaseInstance.SqlFailoverReplica value)

public DatabaseInstance.Builder mergeFailoverReplica(DatabaseInstance.SqlFailoverReplica value)

The name and status of the failover replica.

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

Parameter
Name Description
value DatabaseInstance.SqlFailoverReplica
Returns
Type Description
DatabaseInstance.Builder

mergeFrom(DatabaseInstance other)

public DatabaseInstance.Builder mergeFrom(DatabaseInstance other)
Parameter
Name Description
other DatabaseInstance
Returns
Type Description
DatabaseInstance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DatabaseInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DatabaseInstance.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DatabaseInstance.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DatabaseInstance.Builder
Overrides

mergeGeminiConfig(GeminiInstanceConfig value)

public DatabaseInstance.Builder mergeGeminiConfig(GeminiInstanceConfig value)

Gemini instance configuration.

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

Parameter
Name Description
value GeminiInstanceConfig
Returns
Type Description
DatabaseInstance.Builder

mergeIncludeReplicasForMajorVersionUpgrade(BoolValue value)

public DatabaseInstance.Builder mergeIncludeReplicasForMajorVersionUpgrade(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

mergeMaxDiskSize(Int64Value value) (deprecated)

public DatabaseInstance.Builder mergeMaxDiskSize(Int64Value value)

The maximum disk size of the instance in bytes.

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

Parameter
Name Description
value Int64Value
Returns
Type Description
DatabaseInstance.Builder

mergeOnPremisesConfiguration(OnPremisesConfiguration value)

public DatabaseInstance.Builder mergeOnPremisesConfiguration(OnPremisesConfiguration value)

Configuration specific to on-premises instances.

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

Parameter
Name Description
value OnPremisesConfiguration
Returns
Type Description
DatabaseInstance.Builder

mergeOutOfDiskReport(DatabaseInstance.SqlOutOfDiskReport value)

public DatabaseInstance.Builder mergeOutOfDiskReport(DatabaseInstance.SqlOutOfDiskReport value)

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;

Parameter
Name Description
value DatabaseInstance.SqlOutOfDiskReport
Returns
Type Description
DatabaseInstance.Builder

mergeReplicaConfiguration(ReplicaConfiguration value)

public DatabaseInstance.Builder mergeReplicaConfiguration(ReplicaConfiguration value)

Configuration specific to failover replicas and read replicas.

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

Parameter
Name Description
value ReplicaConfiguration
Returns
Type Description
DatabaseInstance.Builder

mergeReplicationCluster(ReplicationCluster value)

public DatabaseInstance.Builder mergeReplicationCluster(ReplicationCluster value)

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];

Parameter
Name Description
value ReplicationCluster
Returns
Type Description
DatabaseInstance.Builder

mergeSatisfiesPzi(BoolValue value)

public DatabaseInstance.Builder mergeSatisfiesPzi(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

mergeSatisfiesPzs(BoolValue value)

public DatabaseInstance.Builder mergeSatisfiesPzs(BoolValue value)

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

mergeScheduledMaintenance(DatabaseInstance.SqlScheduledMaintenance value)

public DatabaseInstance.Builder mergeScheduledMaintenance(DatabaseInstance.SqlScheduledMaintenance value)

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

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

Parameter
Name Description
value DatabaseInstance.SqlScheduledMaintenance
Returns
Type Description
DatabaseInstance.Builder

mergeServerCaCert(SslCert value)

public DatabaseInstance.Builder mergeServerCaCert(SslCert value)

SSL configuration.

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

Parameter
Name Description
value SslCert
Returns
Type Description
DatabaseInstance.Builder

mergeSettings(Settings value)

public DatabaseInstance.Builder mergeSettings(Settings value)

The user settings.

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

Parameter
Name Description
value Settings
Returns
Type Description
DatabaseInstance.Builder

mergeSwitchTransactionLogsToCloudStorageEnabled(BoolValue value)

public DatabaseInstance.Builder mergeSwitchTransactionLogsToCloudStorageEnabled(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

putAllTags(Map<String,String> values)

public DatabaseInstance.Builder putAllTags(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
DatabaseInstance.Builder

putTags(String key, String value)

public DatabaseInstance.Builder putTags(String key, String value)

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
value String
Returns
Type Description
DatabaseInstance.Builder

removeDnsNames(int index)

public DatabaseInstance.Builder removeDnsNames(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
DatabaseInstance.Builder

removeIpAddresses(int index)

public DatabaseInstance.Builder removeIpAddresses(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
DatabaseInstance.Builder

removeNodes(int index)

public DatabaseInstance.Builder removeNodes(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.Builder

removeTags(String key)

public DatabaseInstance.Builder removeTags(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
DatabaseInstance.Builder

removeUpgradableDatabaseVersions(int index)

public DatabaseInstance.Builder removeUpgradableDatabaseVersions(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
DatabaseInstance.Builder

setAvailableMaintenanceVersions(int index, String value)

public DatabaseInstance.Builder setAvailableMaintenanceVersions(int index, String value)

Output only. List all maintenance versions applicable on the instance

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

Parameters
Name Description
index int

The index to set the value at.
value String

The availableMaintenanceVersions to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setBackendType(SqlBackendType value)

public DatabaseInstance.Builder setBackendType(SqlBackendType value)

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;

Parameter
Name Description
value SqlBackendType

The backendType to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setBackendTypeValue(int value)

public DatabaseInstance.Builder setBackendTypeValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for backendType to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setConnectionName(String value)

public DatabaseInstance.Builder setConnectionName(String value)

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

string connection_name = 22;

Parameter
Name Description
value String

The connectionName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setConnectionNameBytes(ByteString value)

public DatabaseInstance.Builder setConnectionNameBytes(ByteString value)

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

string connection_name = 22;

Parameter
Name Description
value ByteString

The bytes for connectionName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public DatabaseInstance.Builder setCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
DatabaseInstance.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DatabaseInstance.Builder setCreateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setCurrentDiskSize(Int64Value value) (deprecated)

public DatabaseInstance.Builder setCurrentDiskSize(Int64Value value)

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];

Parameter
Name Description
value Int64Value
Returns
Type Description
DatabaseInstance.Builder

setCurrentDiskSize(Int64Value.Builder builderForValue) (deprecated)

public DatabaseInstance.Builder setCurrentDiskSize(Int64Value.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setDatabaseCenterIntegrationEnabled(BoolValue value)

public DatabaseInstance.Builder setDatabaseCenterIntegrationEnabled(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

setDatabaseCenterIntegrationEnabled(BoolValue.Builder builderForValue)

public DatabaseInstance.Builder setDatabaseCenterIntegrationEnabled(BoolValue.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setDatabaseInstalledVersion(String value)

public DatabaseInstance.Builder setDatabaseInstalledVersion(String value)

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];

Parameter
Name Description
value String

The databaseInstalledVersion to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setDatabaseInstalledVersionBytes(ByteString value)

public DatabaseInstance.Builder setDatabaseInstalledVersionBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for databaseInstalledVersion to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setDatabaseVersion(SqlDatabaseVersion value)

public DatabaseInstance.Builder setDatabaseVersion(SqlDatabaseVersion value)

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

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

Parameter
Name Description
value SqlDatabaseVersion

The databaseVersion to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setDatabaseVersionValue(int value)

public DatabaseInstance.Builder setDatabaseVersionValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for databaseVersion to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setDiskEncryptionConfiguration(DiskEncryptionConfiguration value)

public DatabaseInstance.Builder setDiskEncryptionConfiguration(DiskEncryptionConfiguration value)

Disk encryption configuration specific to an instance.

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

Parameter
Name Description
value DiskEncryptionConfiguration
Returns
Type Description
DatabaseInstance.Builder

setDiskEncryptionConfiguration(DiskEncryptionConfiguration.Builder builderForValue)

public DatabaseInstance.Builder setDiskEncryptionConfiguration(DiskEncryptionConfiguration.Builder builderForValue)

Disk encryption configuration specific to an instance.

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

Parameter
Name Description
builderForValue DiskEncryptionConfiguration.Builder
Returns
Type Description
DatabaseInstance.Builder

setDiskEncryptionStatus(DiskEncryptionStatus value)

public DatabaseInstance.Builder setDiskEncryptionStatus(DiskEncryptionStatus value)

Disk encryption status specific to an instance.

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

Parameter
Name Description
value DiskEncryptionStatus
Returns
Type Description
DatabaseInstance.Builder

setDiskEncryptionStatus(DiskEncryptionStatus.Builder builderForValue)

public DatabaseInstance.Builder setDiskEncryptionStatus(DiskEncryptionStatus.Builder builderForValue)

Disk encryption status specific to an instance.

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

Parameter
Name Description
builderForValue DiskEncryptionStatus.Builder
Returns
Type Description
DatabaseInstance.Builder

setDnsName(String value)

public DatabaseInstance.Builder setDnsName(String value)

Output only. The dns name of the instance.

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

Parameter
Name Description
value String

The dnsName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setDnsNameBytes(ByteString value)

public DatabaseInstance.Builder setDnsNameBytes(ByteString value)

Output only. The dns name of the instance.

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

Parameter
Name Description
value ByteString

The bytes for dnsName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setDnsNames(int index, DnsNameMapping value)

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

Parameters
Name Description
index int
value DnsNameMapping
Returns
Type Description
DatabaseInstance.Builder

setDnsNames(int index, DnsNameMapping.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DnsNameMapping.Builder
Returns
Type Description
DatabaseInstance.Builder

setEtag(String value)

public DatabaseInstance.Builder setEtag(String value)

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

string etag = 5;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public DatabaseInstance.Builder setEtagBytes(ByteString value)

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

string etag = 5;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setFailoverReplica(DatabaseInstance.SqlFailoverReplica value)

public DatabaseInstance.Builder setFailoverReplica(DatabaseInstance.SqlFailoverReplica value)

The name and status of the failover replica.

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

Parameter
Name Description
value DatabaseInstance.SqlFailoverReplica
Returns
Type Description
DatabaseInstance.Builder

setFailoverReplica(DatabaseInstance.SqlFailoverReplica.Builder builderForValue)

public DatabaseInstance.Builder setFailoverReplica(DatabaseInstance.SqlFailoverReplica.Builder builderForValue)

The name and status of the failover replica.

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

Parameter
Name Description
builderForValue DatabaseInstance.SqlFailoverReplica.Builder
Returns
Type Description
DatabaseInstance.Builder

setGceZone(String value)

public DatabaseInstance.Builder setGceZone(String value)

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;

Parameter
Name Description
value String

The gceZone to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setGceZoneBytes(ByteString value)

public DatabaseInstance.Builder setGceZoneBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for gceZone to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setGeminiConfig(GeminiInstanceConfig value)

public DatabaseInstance.Builder setGeminiConfig(GeminiInstanceConfig value)

Gemini instance configuration.

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

Parameter
Name Description
value GeminiInstanceConfig
Returns
Type Description
DatabaseInstance.Builder

setGeminiConfig(GeminiInstanceConfig.Builder builderForValue)

public DatabaseInstance.Builder setGeminiConfig(GeminiInstanceConfig.Builder builderForValue)

Gemini instance configuration.

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

Parameter
Name Description
builderForValue GeminiInstanceConfig.Builder
Returns
Type Description
DatabaseInstance.Builder

setIncludeReplicasForMajorVersionUpgrade(BoolValue value)

public DatabaseInstance.Builder setIncludeReplicasForMajorVersionUpgrade(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

setIncludeReplicasForMajorVersionUpgrade(BoolValue.Builder builderForValue)

public DatabaseInstance.Builder setIncludeReplicasForMajorVersionUpgrade(BoolValue.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setInstanceType(SqlInstanceType value)

public DatabaseInstance.Builder setInstanceType(SqlInstanceType value)

The instance type.

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

Parameter
Name Description
value SqlInstanceType

The instanceType to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setInstanceTypeValue(int value)

public DatabaseInstance.Builder setInstanceTypeValue(int value)

The instance type.

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

Parameter
Name Description
value int

The enum numeric value on the wire for instanceType to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setIpAddresses(int index, IpMapping value)

public DatabaseInstance.Builder setIpAddresses(int index, IpMapping value)

The assigned IP addresses for the instance.

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

Parameters
Name Description
index int
value IpMapping
Returns
Type Description
DatabaseInstance.Builder

setIpAddresses(int index, IpMapping.Builder builderForValue)

public DatabaseInstance.Builder setIpAddresses(int index, IpMapping.Builder builderForValue)

The assigned IP addresses for the instance.

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

Parameters
Name Description
index int
builderForValue IpMapping.Builder
Returns
Type Description
DatabaseInstance.Builder

setIpv6Address(String value) (deprecated)

public DatabaseInstance.Builder setIpv6Address(String value)

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];

Parameter
Name Description
value String

The ipv6Address to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setIpv6AddressBytes(ByteString value) (deprecated)

public DatabaseInstance.Builder setIpv6AddressBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for ipv6Address to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setKind(String value)

public DatabaseInstance.Builder setKind(String value)

This is always sql#instance.

string kind = 1;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setKindBytes(ByteString value)

public DatabaseInstance.Builder setKindBytes(ByteString value)

This is always sql#instance.

string kind = 1;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setMaintenanceVersion(String value)

public DatabaseInstance.Builder setMaintenanceVersion(String value)

The current software version on the instance.

string maintenance_version = 42;

Parameter
Name Description
value String

The maintenanceVersion to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setMaintenanceVersionBytes(ByteString value)

public DatabaseInstance.Builder setMaintenanceVersionBytes(ByteString value)

The current software version on the instance.

string maintenance_version = 42;

Parameter
Name Description
value ByteString

The bytes for maintenanceVersion to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setMasterInstanceName(String value)

public DatabaseInstance.Builder setMasterInstanceName(String value)

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

string master_instance_name = 7;

Parameter
Name Description
value String

The masterInstanceName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setMasterInstanceNameBytes(ByteString value)

public DatabaseInstance.Builder setMasterInstanceNameBytes(ByteString value)

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

string master_instance_name = 7;

Parameter
Name Description
value ByteString

The bytes for masterInstanceName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setMaxDiskSize(Int64Value value) (deprecated)

public DatabaseInstance.Builder setMaxDiskSize(Int64Value value)

The maximum disk size of the instance in bytes.

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

Parameter
Name Description
value Int64Value
Returns
Type Description
DatabaseInstance.Builder

setMaxDiskSize(Int64Value.Builder builderForValue) (deprecated)

public DatabaseInstance.Builder setMaxDiskSize(Int64Value.Builder builderForValue)

The maximum disk size of the instance in bytes.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setName(String value)

public DatabaseInstance.Builder setName(String value)

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

string name = 23;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DatabaseInstance.Builder setNameBytes(ByteString value)

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

string name = 23;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setNodeCount(int value)

public DatabaseInstance.Builder setNodeCount(int value)

The number of read pool nodes in a read pool.

optional int32 node_count = 63;

Parameter
Name Description
value int

The nodeCount to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setNodes(int index, DatabaseInstance.PoolNodeConfig value)

public DatabaseInstance.Builder setNodes(int index, DatabaseInstance.PoolNodeConfig value)

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];

Parameters
Name Description
index int
value DatabaseInstance.PoolNodeConfig
Returns
Type Description
DatabaseInstance.Builder

setNodes(int index, DatabaseInstance.PoolNodeConfig.Builder builderForValue)

public DatabaseInstance.Builder setNodes(int index, DatabaseInstance.PoolNodeConfig.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue DatabaseInstance.PoolNodeConfig.Builder
Returns
Type Description
DatabaseInstance.Builder

setOnPremisesConfiguration(OnPremisesConfiguration value)

public DatabaseInstance.Builder setOnPremisesConfiguration(OnPremisesConfiguration value)

Configuration specific to on-premises instances.

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

Parameter
Name Description
value OnPremisesConfiguration
Returns
Type Description
DatabaseInstance.Builder

setOnPremisesConfiguration(OnPremisesConfiguration.Builder builderForValue)

public DatabaseInstance.Builder setOnPremisesConfiguration(OnPremisesConfiguration.Builder builderForValue)

Configuration specific to on-premises instances.

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

Parameter
Name Description
builderForValue OnPremisesConfiguration.Builder
Returns
Type Description
DatabaseInstance.Builder

setOutOfDiskReport(DatabaseInstance.SqlOutOfDiskReport value)

public DatabaseInstance.Builder setOutOfDiskReport(DatabaseInstance.SqlOutOfDiskReport value)

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;

Parameter
Name Description
value DatabaseInstance.SqlOutOfDiskReport
Returns
Type Description
DatabaseInstance.Builder

setOutOfDiskReport(DatabaseInstance.SqlOutOfDiskReport.Builder builderForValue)

public DatabaseInstance.Builder setOutOfDiskReport(DatabaseInstance.SqlOutOfDiskReport.Builder builderForValue)

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;

Parameter
Name Description
builderForValue DatabaseInstance.SqlOutOfDiskReport.Builder
Returns
Type Description
DatabaseInstance.Builder

setPrimaryDnsName(String value) (deprecated)

public DatabaseInstance.Builder setPrimaryDnsName(String value)

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];

Parameter
Name Description
value String

The primaryDnsName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setPrimaryDnsNameBytes(ByteString value) (deprecated)

public DatabaseInstance.Builder setPrimaryDnsNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for primaryDnsName to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setProject(String value)

public DatabaseInstance.Builder setProject(String value)

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

string project = 14;

Parameter
Name Description
value String

The project to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public DatabaseInstance.Builder setProjectBytes(ByteString value)

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

string project = 14;

Parameter
Name Description
value ByteString

The bytes for project to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setPscServiceAttachmentLink(String value)

public DatabaseInstance.Builder setPscServiceAttachmentLink(String value)

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

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

Parameter
Name Description
value String

The pscServiceAttachmentLink to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setPscServiceAttachmentLinkBytes(ByteString value)

public DatabaseInstance.Builder setPscServiceAttachmentLinkBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for pscServiceAttachmentLink to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setRegion(String value)

public DatabaseInstance.Builder setRegion(String value)

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;

Parameter
Name Description
value String

The region to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public DatabaseInstance.Builder setRegionBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setReplicaConfiguration(ReplicaConfiguration value)

public DatabaseInstance.Builder setReplicaConfiguration(ReplicaConfiguration value)

Configuration specific to failover replicas and read replicas.

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

Parameter
Name Description
value ReplicaConfiguration
Returns
Type Description
DatabaseInstance.Builder

setReplicaConfiguration(ReplicaConfiguration.Builder builderForValue)

public DatabaseInstance.Builder setReplicaConfiguration(ReplicaConfiguration.Builder builderForValue)

Configuration specific to failover replicas and read replicas.

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

Parameter
Name Description
builderForValue ReplicaConfiguration.Builder
Returns
Type Description
DatabaseInstance.Builder

setReplicaNames(int index, String value)

public DatabaseInstance.Builder setReplicaNames(int index, String value)

The replicas of the instance.

repeated string replica_names = 8;

Parameters
Name Description
index int

The index to set the value at.
value String

The replicaNames to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setReplicationCluster(ReplicationCluster value)

public DatabaseInstance.Builder setReplicationCluster(ReplicationCluster value)

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];

Parameter
Name Description
value ReplicationCluster
Returns
Type Description
DatabaseInstance.Builder

setReplicationCluster(ReplicationCluster.Builder builderForValue)

public DatabaseInstance.Builder setReplicationCluster(ReplicationCluster.Builder builderForValue)

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];

Parameter
Name Description
builderForValue ReplicationCluster.Builder
Returns
Type Description
DatabaseInstance.Builder

setRootPassword(String value)

public DatabaseInstance.Builder setRootPassword(String value)

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

string root_password = 29;

Parameter
Name Description
value String

The rootPassword to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setRootPasswordBytes(ByteString value)

public DatabaseInstance.Builder setRootPasswordBytes(ByteString value)

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

string root_password = 29;

Parameter
Name Description
value ByteString

The bytes for rootPassword to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSatisfiesPzi(BoolValue value)

public DatabaseInstance.Builder setSatisfiesPzi(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

setSatisfiesPzi(BoolValue.Builder builderForValue)

public DatabaseInstance.Builder setSatisfiesPzi(BoolValue.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setSatisfiesPzs(BoolValue value)

public DatabaseInstance.Builder setSatisfiesPzs(BoolValue value)

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

setSatisfiesPzs(BoolValue.Builder builderForValue)

public DatabaseInstance.Builder setSatisfiesPzs(BoolValue.Builder builderForValue)

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 35;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setScheduledMaintenance(DatabaseInstance.SqlScheduledMaintenance value)

public DatabaseInstance.Builder setScheduledMaintenance(DatabaseInstance.SqlScheduledMaintenance value)

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

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

Parameter
Name Description
value DatabaseInstance.SqlScheduledMaintenance
Returns
Type Description
DatabaseInstance.Builder

setScheduledMaintenance(DatabaseInstance.SqlScheduledMaintenance.Builder builderForValue)

public DatabaseInstance.Builder setScheduledMaintenance(DatabaseInstance.SqlScheduledMaintenance.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue DatabaseInstance.SqlScheduledMaintenance.Builder
Returns
Type Description
DatabaseInstance.Builder

setSecondaryGceZone(String value)

public DatabaseInstance.Builder setSecondaryGceZone(String value)

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;

Parameter
Name Description
value String

The secondaryGceZone to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSecondaryGceZoneBytes(ByteString value)

public DatabaseInstance.Builder setSecondaryGceZoneBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for secondaryGceZone to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSelfLink(String value)

public DatabaseInstance.Builder setSelfLink(String value)

The URI of this resource.

string self_link = 20;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public DatabaseInstance.Builder setSelfLinkBytes(ByteString value)

The URI of this resource.

string self_link = 20;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setServerCaCert(SslCert value)

public DatabaseInstance.Builder setServerCaCert(SslCert value)

SSL configuration.

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

Parameter
Name Description
value SslCert
Returns
Type Description
DatabaseInstance.Builder

setServerCaCert(SslCert.Builder builderForValue)

public DatabaseInstance.Builder setServerCaCert(SslCert.Builder builderForValue)

SSL configuration.

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

Parameter
Name Description
builderForValue SslCert.Builder
Returns
Type Description
DatabaseInstance.Builder

setServiceAccountEmailAddress(String value)

public DatabaseInstance.Builder setServiceAccountEmailAddress(String value)

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

string service_account_email_address = 16;

Parameter
Name Description
value String

The serviceAccountEmailAddress to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setServiceAccountEmailAddressBytes(ByteString value)

public DatabaseInstance.Builder setServiceAccountEmailAddressBytes(ByteString value)

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

string service_account_email_address = 16;

Parameter
Name Description
value ByteString

The bytes for serviceAccountEmailAddress to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSettings(Settings value)

public DatabaseInstance.Builder setSettings(Settings value)

The user settings.

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

Parameter
Name Description
value Settings
Returns
Type Description
DatabaseInstance.Builder

setSettings(Settings.Builder builderForValue)

public DatabaseInstance.Builder setSettings(Settings.Builder builderForValue)

The user settings.

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

Parameter
Name Description
builderForValue Settings.Builder
Returns
Type Description
DatabaseInstance.Builder

setSqlNetworkArchitecture(DatabaseInstance.SqlNetworkArchitecture value)

public DatabaseInstance.Builder setSqlNetworkArchitecture(DatabaseInstance.SqlNetworkArchitecture value)

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

Parameter
Name Description
value DatabaseInstance.SqlNetworkArchitecture

The sqlNetworkArchitecture to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSqlNetworkArchitectureValue(int value)

public DatabaseInstance.Builder setSqlNetworkArchitectureValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for sqlNetworkArchitecture to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setState(DatabaseInstance.SqlInstanceState value)

public DatabaseInstance.Builder setState(DatabaseInstance.SqlInstanceState value)

The current serving state of the Cloud SQL instance.

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

Parameter
Name Description
value DatabaseInstance.SqlInstanceState

The state to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setStateValue(int value)

public DatabaseInstance.Builder setStateValue(int value)

The current serving state of the Cloud SQL instance.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSuspensionReason(int index, SqlSuspensionReason value)

public DatabaseInstance.Builder setSuspensionReason(int index, SqlSuspensionReason value)

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

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

Parameters
Name Description
index int

The index to set the value at.
value SqlSuspensionReason

The suspensionReason to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSuspensionReasonValue(int index, int value)

public DatabaseInstance.Builder setSuspensionReasonValue(int index, int value)

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

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

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for suspensionReason to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setSwitchTransactionLogsToCloudStorageEnabled(BoolValue value)

public DatabaseInstance.Builder setSwitchTransactionLogsToCloudStorageEnabled(BoolValue value)

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];

Parameter
Name Description
value BoolValue
Returns
Type Description
DatabaseInstance.Builder

setSwitchTransactionLogsToCloudStorageEnabled(BoolValue.Builder builderForValue)

public DatabaseInstance.Builder setSwitchTransactionLogsToCloudStorageEnabled(BoolValue.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatabaseInstance.Builder

setUpgradableDatabaseVersions(int index, AvailableDatabaseVersion value)

public DatabaseInstance.Builder setUpgradableDatabaseVersions(int index, AvailableDatabaseVersion value)

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];

Parameters
Name Description
index int
value AvailableDatabaseVersion
Returns
Type Description
DatabaseInstance.Builder

setUpgradableDatabaseVersions(int index, AvailableDatabaseVersion.Builder builderForValue)

public DatabaseInstance.Builder setUpgradableDatabaseVersions(int index, AvailableDatabaseVersion.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue AvailableDatabaseVersion.Builder
Returns
Type Description
DatabaseInstance.Builder

setWriteEndpoint(String value)

public DatabaseInstance.Builder setWriteEndpoint(String value)

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

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

Parameter
Name Description
value String

The writeEndpoint to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.

setWriteEndpointBytes(ByteString value)

public DatabaseInstance.Builder setWriteEndpointBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for writeEndpoint to set.
Returns
Type Description
DatabaseInstance.Builder

This builder for chaining.