public final class CloudSqlSettings extends GeneratedMessageV3 implements CloudSqlSettingsOrBuilder
Settings for creating a Cloud SQL database instance.
Protobuf type google.cloud.clouddms.v1.CloudSqlSettings
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ACTIVATION_POLICY_FIELD_NUMBER
public static final int ACTIVATION_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
AUTO_STORAGE_INCREASE_FIELD_NUMBER
public static final int AUTO_STORAGE_INCREASE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
AVAILABILITY_TYPE_FIELD_NUMBER
public static final int AVAILABILITY_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CMEK_KEY_NAME_FIELD_NUMBER
public static final int CMEK_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
COLLATION_FIELD_NUMBER
public static final int COLLATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATABASE_FLAGS_FIELD_NUMBER
public static final int DATABASE_FLAGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATABASE_VERSION_FIELD_NUMBER
public static final int DATABASE_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATA_DISK_SIZE_GB_FIELD_NUMBER
public static final int DATA_DISK_SIZE_GB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATA_DISK_TYPE_FIELD_NUMBER
public static final int DATA_DISK_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IP_CONFIG_FIELD_NUMBER
public static final int IP_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ROOT_PASSWORD_FIELD_NUMBER
public static final int ROOT_PASSWORD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ROOT_PASSWORD_SET_FIELD_NUMBER
public static final int ROOT_PASSWORD_SET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SECONDARY_ZONE_FIELD_NUMBER
public static final int SECONDARY_ZONE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SOURCE_ID_FIELD_NUMBER
public static final int SOURCE_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STORAGE_AUTO_RESIZE_LIMIT_FIELD_NUMBER
public static final int STORAGE_AUTO_RESIZE_LIMIT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIER_FIELD_NUMBER
public static final int TIER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static CloudSqlSettings getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CloudSqlSettings.Builder newBuilder()
newBuilder(CloudSqlSettings prototype)
public static CloudSqlSettings.Builder newBuilder(CloudSqlSettings prototype)
public static CloudSqlSettings parseDelimitedFrom(InputStream input)
public static CloudSqlSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CloudSqlSettings parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CloudSqlSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CloudSqlSettings parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloudSqlSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloudSqlSettings parseFrom(CodedInputStream input)
public static CloudSqlSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CloudSqlSettings parseFrom(InputStream input)
public static CloudSqlSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CloudSqlSettings parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CloudSqlSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CloudSqlSettings> parser()
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 |
|---|
| Name | Description |
key | String
|
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
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.
|
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;
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];
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.
|
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;
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;
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()
public Map<String,String> getDatabaseFlags()
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;
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;
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
|
getDatabaseVersion()
public CloudSqlSettings.SqlDatabaseVersion getDatabaseVersion()
The database engine type and version.
.google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;
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()
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;
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;
getParserForType()
public Parser<CloudSqlSettings> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
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 |
|---|
| 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.
|
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;
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUserLabels()
public Map<String,String> getUserLabels()
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;
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;
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
|
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CloudSqlSettings.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CloudSqlSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public CloudSqlSettings.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
