Interface CloudSqlSettingsOrBuilder (2.52.0) 

public interface CloudSqlSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDatabaseFlags(String key)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getAutoStorageIncreaseOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract String getCmekKeyName()

The KMS key name used for the csql instance.

string cmek_key_name = 16;

Returns
Type Description
String

The cmekKeyName.

getCmekKeyNameBytes()

public abstract 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 abstract String getCollation()

The Cloud SQL default instance level collation.

string collation = 15;

Returns
Type Description
String

The collation.

getCollationBytes()

public abstract ByteString getCollationBytes()

The Cloud SQL default instance level collation.

string collation = 15;

Returns
Type Description
ByteString

The bytes for collation.

getDataDiskSizeGb()

public abstract 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.

getDataDiskSizeGbOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract Map<String,String> getDatabaseFlags()

Use #getDatabaseFlagsMap() instead.

Returns
Type Description
Map<String,String>

getDatabaseFlagsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getEdition()

public abstract 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 abstract 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 abstract 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.

getIpConfigOrBuilder()

public abstract 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

getRootPassword()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getStorageAutoResizeLimitOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type Description
Map<String,String>

getUserLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.