Class CloudSqlSettings (2.13.0)

public final class CloudSqlSettings extends GeneratedMessageV3 implements CloudSqlSettingsOrBuilder

Settings for creating a Cloud SQL database instance.

Protobuf type google.cloud.clouddms.v1.CloudSqlSettings

Static Fields

ACTIVATION_POLICY_FIELD_NUMBER

public static final int ACTIVATION_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

AUTO_STORAGE_INCREASE_FIELD_NUMBER

public static final int AUTO_STORAGE_INCREASE_FIELD_NUMBER
Field Value
TypeDescription
int

COLLATION_FIELD_NUMBER

public static final int COLLATION_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_FLAGS_FIELD_NUMBER

public static final int DATABASE_FLAGS_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_VERSION_FIELD_NUMBER

public static final int DATABASE_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_DISK_SIZE_GB_FIELD_NUMBER

public static final int DATA_DISK_SIZE_GB_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_DISK_TYPE_FIELD_NUMBER

public static final int DATA_DISK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

IP_CONFIG_FIELD_NUMBER

public static final int IP_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

ROOT_PASSWORD_FIELD_NUMBER

public static final int ROOT_PASSWORD_FIELD_NUMBER
Field Value
TypeDescription
int

ROOT_PASSWORD_SET_FIELD_NUMBER

public static final int ROOT_PASSWORD_SET_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_ID_FIELD_NUMBER

public static final int SOURCE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

STORAGE_AUTO_RESIZE_LIMIT_FIELD_NUMBER

public static final int STORAGE_AUTO_RESIZE_LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
TypeDescription
int

USER_LABELS_FIELD_NUMBER

public static final int USER_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CloudSqlSettings getDefaultInstance()
Returns
TypeDescription
CloudSqlSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CloudSqlSettings.Builder newBuilder()
Returns
TypeDescription
CloudSqlSettings.Builder

newBuilder(CloudSqlSettings prototype)

public static CloudSqlSettings.Builder newBuilder(CloudSqlSettings prototype)
Parameter
NameDescription
prototypeCloudSqlSettings
Returns
TypeDescription
CloudSqlSettings.Builder

parseDelimitedFrom(InputStream input)

public static CloudSqlSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudSqlSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CloudSqlSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloudSqlSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CloudSqlSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloudSqlSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CloudSqlSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudSqlSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CloudSqlSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudSqlSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CloudSqlSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloudSqlSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudSqlSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CloudSqlSettings> parser()
Returns
TypeDescription
Parser<CloudSqlSettings>

Methods

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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
BoolValue

The autoStorageIncrease.

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
TypeDescription
BoolValueOrBuilder

getCollation()

public String getCollation()

The Cloud SQL default instance level collation.

string collation = 15;

Returns
TypeDescription
String

The collation.

getCollationBytes()

public ByteString getCollationBytes()

The Cloud SQL default instance level collation.

string collation = 15;

Returns
TypeDescription
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
TypeDescription
Int64Value

The dataDiskSizeGb.

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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for dataDiskType.

getDatabaseFlags()

public Map<String,String> getDatabaseFlags()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getDatabaseVersion()

public CloudSqlSettings.SqlDatabaseVersion getDatabaseVersion()

The database engine type and version.

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

Returns
TypeDescription
CloudSqlSettings.SqlDatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public int getDatabaseVersionValue()

The database engine type and version.

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

Returns
TypeDescription
int

The enum numeric value on the wire for databaseVersion.

getDefaultInstanceForType()

public CloudSqlSettings getDefaultInstanceForType()
Returns
TypeDescription
CloudSqlSettings

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
TypeDescription
SqlIpConfig

The ipConfig.

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
TypeDescription
SqlIpConfigOrBuilder

getParserForType()

public Parser<CloudSqlSettings> getParserForType()
Returns
TypeDescription
Parser<CloudSqlSettings>
Overrides

getRootPassword()

public String getRootPassword()

Input only. Initial root password.

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

Returns
TypeDescription
String

The rootPassword.

getRootPasswordBytes()

public ByteString getRootPasswordBytes()

Input only. Initial root password.

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

Returns
TypeDescription
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
TypeDescription
boolean

The rootPasswordSet.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
Int64Value

The storageAutoResizeLimit.

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

The bytes for tier.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUserLabels()

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getZone()

public String getZone()

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

string zone = 11;

Returns
TypeDescription
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

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

string zone = 11;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the storageAutoResizeLimit field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CloudSqlSettings.Builder newBuilderForType()
Returns
TypeDescription
CloudSqlSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CloudSqlSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CloudSqlSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CloudSqlSettings.Builder toBuilder()
Returns
TypeDescription
CloudSqlSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException