Class CloudSqlSettings.Builder (2.46.0) 

public static final class CloudSqlSettings.Builder extends GeneratedMessageV3.Builder<CloudSqlSettings.Builder> implements CloudSqlSettingsOrBuilder

Settings for creating a Cloud SQL database instance.

Protobuf type google.cloud.clouddms.v1.CloudSqlSettings

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CloudSqlSettings.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CloudSqlSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CloudSqlSettings.Builder
Overrides

build()

public CloudSqlSettings build()
Returns
Type Description
CloudSqlSettings

buildPartial()

public CloudSqlSettings buildPartial()
Returns
Type Description
CloudSqlSettings

clear()

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

clearActivationPolicy()

public CloudSqlSettings.Builder clearActivationPolicy()

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:

'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy activation_policy = 5;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearAutoStorageIncrease()

public CloudSqlSettings.Builder clearAutoStorageIncrease()

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Returns
Type Description
CloudSqlSettings.Builder

clearAvailabilityType()

public CloudSqlSettings.Builder clearAvailabilityType()

Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.
  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

.google.cloud.clouddms.v1.CloudSqlSettings.SqlAvailabilityType availability_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearCmekKeyName()

public CloudSqlSettings.Builder clearCmekKeyName()

The KMS key name used for the csql instance.

string cmek_key_name = 16;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearCollation()

public CloudSqlSettings.Builder clearCollation()

The Cloud SQL default instance level collation.

string collation = 15;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearDataDiskSizeGb()

public CloudSqlSettings.Builder clearDataDiskSizeGb()

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Returns
Type Description
CloudSqlSettings.Builder

clearDataDiskType()

public CloudSqlSettings.Builder clearDataDiskType()

The type of storage: PD_SSD (default) or PD_HDD.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType data_disk_type = 9;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearDatabaseFlags()

public CloudSqlSettings.Builder clearDatabaseFlags()
Returns
Type Description
CloudSqlSettings.Builder

clearDatabaseVersion()

public CloudSqlSettings.Builder clearDatabaseVersion()

The database engine type and version.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearEdition()

public CloudSqlSettings.Builder clearEdition()

Optional. The edition of the given Cloud SQL instance.

.google.cloud.clouddms.v1.CloudSqlSettings.Edition edition = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CloudSqlSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CloudSqlSettings.Builder
Overrides

clearIpConfig()

public CloudSqlSettings.Builder clearIpConfig()

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Returns
Type Description
CloudSqlSettings.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public CloudSqlSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CloudSqlSettings.Builder
Overrides

clearRootPassword()

public CloudSqlSettings.Builder clearRootPassword()

Input only. Initial root password.

string root_password = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearRootPasswordSet()

public CloudSqlSettings.Builder clearRootPasswordSet()

Output only. Indicates If this connection profile root password is stored.

bool root_password_set = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearSecondaryZone()

public CloudSqlSettings.Builder clearSecondaryZone()

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

string secondary_zone = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearSourceId()

public CloudSqlSettings.Builder clearSourceId()

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

string source_id = 12;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearStorageAutoResizeLimit()

public CloudSqlSettings.Builder clearStorageAutoResizeLimit()

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Returns
Type Description
CloudSqlSettings.Builder

clearTier()

public CloudSqlSettings.Builder clearTier()

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.

string tier = 3;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clearUserLabels()

public CloudSqlSettings.Builder clearUserLabels()
Returns
Type Description
CloudSqlSettings.Builder

clearZone()

public CloudSqlSettings.Builder clearZone()

The Google Cloud Platform zone where your Cloud SQL database instance is located.

string zone = 11;

Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

clone()

public CloudSqlSettings.Builder clone()
Returns
Type Description
CloudSqlSettings.Builder
Overrides

containsDatabaseFlags(String key)

public boolean containsDatabaseFlags(String key)

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsUserLabels(String key)

public boolean containsUserLabels(String key)

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getActivationPolicy()

public CloudSqlSettings.SqlActivationPolicy getActivationPolicy()

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:

'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy activation_policy = 5;

Returns
Type Description
CloudSqlSettings.SqlActivationPolicy

The activationPolicy.

getActivationPolicyValue()

public int getActivationPolicyValue()

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:

'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy activation_policy = 5;

Returns
Type Description
int

The enum numeric value on the wire for activationPolicy.

getAutoStorageIncrease()

public BoolValue getAutoStorageIncrease()

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Returns
Type Description
BoolValue

The autoStorageIncrease.

getAutoStorageIncreaseBuilder()

public BoolValue.Builder getAutoStorageIncreaseBuilder()

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Returns
Type Description
Builder

getAutoStorageIncreaseOrBuilder()

public BoolValueOrBuilder getAutoStorageIncreaseOrBuilder()

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Returns
Type Description
BoolValueOrBuilder

getAvailabilityType()

public CloudSqlSettings.SqlAvailabilityType getAvailabilityType()

Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.
  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

.google.cloud.clouddms.v1.CloudSqlSettings.SqlAvailabilityType availability_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudSqlSettings.SqlAvailabilityType

The availabilityType.

getAvailabilityTypeValue()

public int getAvailabilityTypeValue()

Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.
  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

.google.cloud.clouddms.v1.CloudSqlSettings.SqlAvailabilityType availability_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for availabilityType.

getCmekKeyName()

public String getCmekKeyName()

The KMS key name used for the csql instance.

string cmek_key_name = 16;

Returns
Type Description
String

The cmekKeyName.

getCmekKeyNameBytes()

public ByteString getCmekKeyNameBytes()

The KMS key name used for the csql instance.

string cmek_key_name = 16;

Returns
Type Description
ByteString

The bytes for cmekKeyName.

getCollation()

public String getCollation()

The Cloud SQL default instance level collation.

string collation = 15;

Returns
Type Description
String

The collation.

getCollationBytes()

public ByteString getCollationBytes()

The Cloud SQL default instance level collation.

string collation = 15;

Returns
Type Description
ByteString

The bytes for collation.

getDataDiskSizeGb()

public Int64Value getDataDiskSizeGb()

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Returns
Type Description
Int64Value

The dataDiskSizeGb.

getDataDiskSizeGbBuilder()

public Int64Value.Builder getDataDiskSizeGbBuilder()

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Returns
Type Description
Builder

getDataDiskSizeGbOrBuilder()

public Int64ValueOrBuilder getDataDiskSizeGbOrBuilder()

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Returns
Type Description
Int64ValueOrBuilder

getDataDiskType()

public CloudSqlSettings.SqlDataDiskType getDataDiskType()

The type of storage: PD_SSD (default) or PD_HDD.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType data_disk_type = 9;

Returns
Type Description
CloudSqlSettings.SqlDataDiskType

The dataDiskType.

getDataDiskTypeValue()

public int getDataDiskTypeValue()

The type of storage: PD_SSD (default) or PD_HDD.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType data_disk_type = 9;

Returns
Type Description
int

The enum numeric value on the wire for dataDiskType.

getDatabaseFlags() (deprecated)

public Map<String,String> getDatabaseFlags()

Use #getDatabaseFlagsMap() instead.

Returns
Type Description
Map<String,String>

getDatabaseFlagsCount()

public int getDatabaseFlagsCount()

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Returns
Type Description
int

getDatabaseFlagsMap()

public Map<String,String> getDatabaseFlagsMap()

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Returns
Type Description
Map<String,String>

getDatabaseFlagsOrDefault(String key, String defaultValue)

public String getDatabaseFlagsOrDefault(String key, String defaultValue)

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getDatabaseFlagsOrThrow(String key)

public String getDatabaseFlagsOrThrow(String key)

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Parameter
Name Description
key String
Returns
Type Description
String

getDatabaseVersion()

public CloudSqlSettings.SqlDatabaseVersion getDatabaseVersion()

The database engine type and version.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;

Returns
Type Description
CloudSqlSettings.SqlDatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public int getDatabaseVersionValue()

The database engine type and version.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;

Returns
Type Description
int

The enum numeric value on the wire for databaseVersion.

getDefaultInstanceForType()

public CloudSqlSettings getDefaultInstanceForType()
Returns
Type Description
CloudSqlSettings

getDescriptorForType()

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

getEdition()

public CloudSqlSettings.Edition getEdition()

Optional. The edition of the given Cloud SQL instance.

.google.cloud.clouddms.v1.CloudSqlSettings.Edition edition = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudSqlSettings.Edition

The edition.

getEditionValue()

public int getEditionValue()

Optional. The edition of the given Cloud SQL instance.

.google.cloud.clouddms.v1.CloudSqlSettings.Edition edition = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for edition.

getIpConfig()

public SqlIpConfig getIpConfig()

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Returns
Type Description
SqlIpConfig

The ipConfig.

getIpConfigBuilder()

public SqlIpConfig.Builder getIpConfigBuilder()

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Returns
Type Description
SqlIpConfig.Builder

getIpConfigOrBuilder()

public SqlIpConfigOrBuilder getIpConfigOrBuilder()

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Returns
Type Description
SqlIpConfigOrBuilder

getMutableDatabaseFlags() (deprecated)

public Map<String,String> getMutableDatabaseFlags()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableUserLabels() (deprecated)

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getRootPassword()

public String getRootPassword()

Input only. Initial root password.

string root_password = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
String

The rootPassword.

getRootPasswordBytes()

public ByteString getRootPasswordBytes()

Input only. Initial root password.

string root_password = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The bytes for rootPassword.

getRootPasswordSet()

public boolean getRootPasswordSet()

Output only. Indicates If this connection profile root password is stored.

bool root_password_set = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The rootPasswordSet.

getSecondaryZone()

public String getSecondaryZone()

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

string secondary_zone = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The secondaryZone.

getSecondaryZoneBytes()

public ByteString getSecondaryZoneBytes()

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

string secondary_zone = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for secondaryZone.

getSourceId()

public String getSourceId()

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

string source_id = 12;

Returns
Type Description
String

The sourceId.

getSourceIdBytes()

public ByteString getSourceIdBytes()

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

string source_id = 12;

Returns
Type Description
ByteString

The bytes for sourceId.

getStorageAutoResizeLimit()

public Int64Value getStorageAutoResizeLimit()

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Returns
Type Description
Int64Value

The storageAutoResizeLimit.

getStorageAutoResizeLimitBuilder()

public Int64Value.Builder getStorageAutoResizeLimitBuilder()

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Returns
Type Description
Builder

getStorageAutoResizeLimitOrBuilder()

public Int64ValueOrBuilder getStorageAutoResizeLimitOrBuilder()

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Returns
Type Description
Int64ValueOrBuilder

getTier()

public String getTier()

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.

string tier = 3;

Returns
Type Description
String

The tier.

getTierBytes()

public ByteString getTierBytes()

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.

string tier = 3;

Returns
Type Description
ByteString

The bytes for tier.

getUserLabels() (deprecated)

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type Description
Map<String,String>

getUserLabelsCount()

public int getUserLabelsCount()

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Returns
Type Description
int

getUserLabelsMap()

public Map<String,String> getUserLabelsMap()

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Returns
Type Description
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public String getUserLabelsOrDefault(String key, String defaultValue)

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getUserLabelsOrThrow(String key)

public String getUserLabelsOrThrow(String key)

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getZone()

public String getZone()

The Google Cloud Platform zone where your Cloud SQL database instance is located.

string zone = 11;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

The Google Cloud Platform zone where your Cloud SQL database instance is located.

string zone = 11;

Returns
Type Description
ByteString

The bytes for zone.

hasAutoStorageIncrease()

public boolean hasAutoStorageIncrease()

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Returns
Type Description
boolean

Whether the autoStorageIncrease field is set.

hasDataDiskSizeGb()

public boolean hasDataDiskSizeGb()

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Returns
Type Description
boolean

Whether the dataDiskSizeGb field is set.

hasIpConfig()

public boolean hasIpConfig()

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Returns
Type Description
boolean

Whether the ipConfig field is set.

hasStorageAutoResizeLimit()

public boolean hasStorageAutoResizeLimit()

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Returns
Type Description
boolean

Whether the storageAutoResizeLimit field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAutoStorageIncrease(BoolValue value)

public CloudSqlSettings.Builder mergeAutoStorageIncrease(BoolValue value)

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Parameter
Name Description
value BoolValue
Returns
Type Description
CloudSqlSettings.Builder

mergeDataDiskSizeGb(Int64Value value)

public CloudSqlSettings.Builder mergeDataDiskSizeGb(Int64Value value)

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Parameter
Name Description
value Int64Value
Returns
Type Description
CloudSqlSettings.Builder

mergeFrom(CloudSqlSettings other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeIpConfig(SqlIpConfig value)

public CloudSqlSettings.Builder mergeIpConfig(SqlIpConfig value)

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Parameter
Name Description
value SqlIpConfig
Returns
Type Description
CloudSqlSettings.Builder

mergeStorageAutoResizeLimit(Int64Value value)

public CloudSqlSettings.Builder mergeStorageAutoResizeLimit(Int64Value value)

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Parameter
Name Description
value Int64Value
Returns
Type Description
CloudSqlSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CloudSqlSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CloudSqlSettings.Builder
Overrides

putAllDatabaseFlags(Map<String,String> values)

public CloudSqlSettings.Builder putAllDatabaseFlags(Map<String,String> values)

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
CloudSqlSettings.Builder

putAllUserLabels(Map<String,String> values)

public CloudSqlSettings.Builder putAllUserLabels(Map<String,String> values)

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
CloudSqlSettings.Builder

putDatabaseFlags(String key, String value)

public CloudSqlSettings.Builder putDatabaseFlags(String key, String value)

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Parameters
Name Description
key String
value String
Returns
Type Description
CloudSqlSettings.Builder

putUserLabels(String key, String value)

public CloudSqlSettings.Builder putUserLabels(String key, String value)

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
CloudSqlSettings.Builder

removeDatabaseFlags(String key)

public CloudSqlSettings.Builder removeDatabaseFlags(String key)

The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> database_flags = 8;

Parameter
Name Description
key String
Returns
Type Description
CloudSqlSettings.Builder

removeUserLabels(String key)

public CloudSqlSettings.Builder removeUserLabels(String key)

The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

map<string, string> user_labels = 2;

Parameter
Name Description
key String
Returns
Type Description
CloudSqlSettings.Builder

setActivationPolicy(CloudSqlSettings.SqlActivationPolicy value)

public CloudSqlSettings.Builder setActivationPolicy(CloudSqlSettings.SqlActivationPolicy value)

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:

'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy activation_policy = 5;

Parameter
Name Description
value CloudSqlSettings.SqlActivationPolicy

The activationPolicy to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setActivationPolicyValue(int value)

public CloudSqlSettings.Builder setActivationPolicyValue(int value)

The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:

'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy activation_policy = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for activationPolicy to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setAutoStorageIncrease(BoolValue value)

public CloudSqlSettings.Builder setAutoStorageIncrease(BoolValue value)

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Parameter
Name Description
value BoolValue
Returns
Type Description
CloudSqlSettings.Builder

setAutoStorageIncrease(BoolValue.Builder builderForValue)

public CloudSqlSettings.Builder setAutoStorageIncrease(BoolValue.Builder builderForValue)

[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

.google.protobuf.BoolValue auto_storage_increase = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CloudSqlSettings.Builder

setAvailabilityType(CloudSqlSettings.SqlAvailabilityType value)

public CloudSqlSettings.Builder setAvailabilityType(CloudSqlSettings.SqlAvailabilityType value)

Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.
  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

.google.cloud.clouddms.v1.CloudSqlSettings.SqlAvailabilityType availability_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CloudSqlSettings.SqlAvailabilityType

The availabilityType to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setAvailabilityTypeValue(int value)

public CloudSqlSettings.Builder setAvailabilityTypeValue(int value)

Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.
  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

.google.cloud.clouddms.v1.CloudSqlSettings.SqlAvailabilityType availability_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for availabilityType to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setCmekKeyName(String value)

public CloudSqlSettings.Builder setCmekKeyName(String value)

The KMS key name used for the csql instance.

string cmek_key_name = 16;

Parameter
Name Description
value String

The cmekKeyName to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setCmekKeyNameBytes(ByteString value)

public CloudSqlSettings.Builder setCmekKeyNameBytes(ByteString value)

The KMS key name used for the csql instance.

string cmek_key_name = 16;

Parameter
Name Description
value ByteString

The bytes for cmekKeyName to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setCollation(String value)

public CloudSqlSettings.Builder setCollation(String value)

The Cloud SQL default instance level collation.

string collation = 15;

Parameter
Name Description
value String

The collation to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setCollationBytes(ByteString value)

public CloudSqlSettings.Builder setCollationBytes(ByteString value)

The Cloud SQL default instance level collation.

string collation = 15;

Parameter
Name Description
value ByteString

The bytes for collation to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setDataDiskSizeGb(Int64Value value)

public CloudSqlSettings.Builder setDataDiskSizeGb(Int64Value value)

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Parameter
Name Description
value Int64Value
Returns
Type Description
CloudSqlSettings.Builder

setDataDiskSizeGb(Int64Value.Builder builderForValue)

public CloudSqlSettings.Builder setDataDiskSizeGb(Int64Value.Builder builderForValue)

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

.google.protobuf.Int64Value data_disk_size_gb = 10;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CloudSqlSettings.Builder

setDataDiskType(CloudSqlSettings.SqlDataDiskType value)

public CloudSqlSettings.Builder setDataDiskType(CloudSqlSettings.SqlDataDiskType value)

The type of storage: PD_SSD (default) or PD_HDD.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType data_disk_type = 9;

Parameter
Name Description
value CloudSqlSettings.SqlDataDiskType

The dataDiskType to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setDataDiskTypeValue(int value)

public CloudSqlSettings.Builder setDataDiskTypeValue(int value)

The type of storage: PD_SSD (default) or PD_HDD.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType data_disk_type = 9;

Parameter
Name Description
value int

The enum numeric value on the wire for dataDiskType to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setDatabaseVersion(CloudSqlSettings.SqlDatabaseVersion value)

public CloudSqlSettings.Builder setDatabaseVersion(CloudSqlSettings.SqlDatabaseVersion value)

The database engine type and version.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;

Parameter
Name Description
value CloudSqlSettings.SqlDatabaseVersion

The databaseVersion to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setDatabaseVersionValue(int value)

public CloudSqlSettings.Builder setDatabaseVersionValue(int value)

The database engine type and version.

.google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;

Parameter
Name Description
value int

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

This builder for chaining.

setEdition(CloudSqlSettings.Edition value)

public CloudSqlSettings.Builder setEdition(CloudSqlSettings.Edition value)

Optional. The edition of the given Cloud SQL instance.

.google.cloud.clouddms.v1.CloudSqlSettings.Edition edition = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CloudSqlSettings.Edition

The edition to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setEditionValue(int value)

public CloudSqlSettings.Builder setEditionValue(int value)

Optional. The edition of the given Cloud SQL instance.

.google.cloud.clouddms.v1.CloudSqlSettings.Edition edition = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for edition to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CloudSqlSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CloudSqlSettings.Builder
Overrides

setIpConfig(SqlIpConfig value)

public CloudSqlSettings.Builder setIpConfig(SqlIpConfig value)

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Parameter
Name Description
value SqlIpConfig
Returns
Type Description
CloudSqlSettings.Builder

setIpConfig(SqlIpConfig.Builder builderForValue)

public CloudSqlSettings.Builder setIpConfig(SqlIpConfig.Builder builderForValue)

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

.google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

Parameter
Name Description
builderForValue SqlIpConfig.Builder
Returns
Type Description
CloudSqlSettings.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CloudSqlSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CloudSqlSettings.Builder
Overrides

setRootPassword(String value)

public CloudSqlSettings.Builder setRootPassword(String value)

Input only. Initial root password.

string root_password = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value String

The rootPassword to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setRootPasswordBytes(ByteString value)

public CloudSqlSettings.Builder setRootPasswordBytes(ByteString value)

Input only. Initial root password.

string root_password = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setRootPasswordSet(boolean value)

public CloudSqlSettings.Builder setRootPasswordSet(boolean value)

Output only. Indicates If this connection profile root password is stored.

bool root_password_set = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The rootPasswordSet to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setSecondaryZone(String value)

public CloudSqlSettings.Builder setSecondaryZone(String value)

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

string secondary_zone = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The secondaryZone to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setSecondaryZoneBytes(ByteString value)

public CloudSqlSettings.Builder setSecondaryZoneBytes(ByteString value)

Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

string secondary_zone = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for secondaryZone to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setSourceId(String value)

public CloudSqlSettings.Builder setSourceId(String value)

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

string source_id = 12;

Parameter
Name Description
value String

The sourceId to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setSourceIdBytes(ByteString value)

public CloudSqlSettings.Builder setSourceIdBytes(ByteString value)

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

string source_id = 12;

Parameter
Name Description
value ByteString

The bytes for sourceId to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setStorageAutoResizeLimit(Int64Value value)

public CloudSqlSettings.Builder setStorageAutoResizeLimit(Int64Value value)

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Parameter
Name Description
value Int64Value
Returns
Type Description
CloudSqlSettings.Builder

setStorageAutoResizeLimit(Int64Value.Builder builderForValue)

public CloudSqlSettings.Builder setStorageAutoResizeLimit(Int64Value.Builder builderForValue)

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

.google.protobuf.Int64Value storage_auto_resize_limit = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CloudSqlSettings.Builder

setTier(String value)

public CloudSqlSettings.Builder setTier(String value)

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.

string tier = 3;

Parameter
Name Description
value String

The tier to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setTierBytes(ByteString value)

public CloudSqlSettings.Builder setTierBytes(ByteString value)

The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.

string tier = 3;

Parameter
Name Description
value ByteString

The bytes for tier to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CloudSqlSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CloudSqlSettings.Builder
Overrides

setZone(String value)

public CloudSqlSettings.Builder setZone(String value)

The Google Cloud Platform zone where your Cloud SQL database instance is located.

string zone = 11;

Parameter
Name Description
value String

The zone to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public CloudSqlSettings.Builder setZoneBytes(ByteString value)

The Google Cloud Platform zone where your Cloud SQL database instance is located.

string zone = 11;

Parameter
Name Description
value ByteString

The bytes for zone to set.
Returns
Type Description
CloudSqlSettings.Builder

This builder for chaining.