CloudSqlSettings class

Settings for creating a Cloud SQL database instance.

Inheritance
  • Object
  • GeneratedMessage
  • CloudSqlSettings

Constructors

CloudSqlSettings({CloudSqlSettings_SqlDatabaseVersion? databaseVersion, Map<String, String>? userLabels, String? tier, Int64Value? storageAutoResizeLimit, CloudSqlSettings_SqlActivationPolicy? activationPolicy, SqlIpConfig? ipConfig, BoolValue? autoStorageIncrease, Map<String, String>? databaseFlags, CloudSqlSettings_SqlDataDiskType? dataDiskType, Int64Value? dataDiskSizeGb, String? zone, String? sourceId, bool? rootPasswordSet, String? collation, String? cmekKeyName, CloudSqlSettings_SqlAvailabilityType? availabilityType, String? secondaryZone})
factory
CloudSqlSettings.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
CloudSqlSettings.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

activationPolicy ↔ CloudSqlSettings_SqlActivationPolicy
The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:
getter/setter pair
autoStorageIncrease ↔ BoolValue
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.
getter/setter pair
availabilityType ↔ CloudSqlSettings_SqlAvailabilityType
Optional. Availability type. Potential values:
getter/setter pair
cmekKeyName ↔ String
The KMS key name used for the csql instance.
getter/setter pair
collation ↔ String
The Cloud SQL default instance level collation.
getter/setter pair
databaseFlags → Map<String, String>
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" }.
no setter
databaseVersion ↔ CloudSqlSettings_SqlDatabaseVersion
The database engine type and version.
getter/setter pair
dataDiskSizeGb ↔ Int64Value
The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
getter/setter pair
dataDiskType ↔ CloudSqlSettings_SqlDataDiskType
The type of storage: PD_SSD (default) or PD_HDD.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
ipConfig ↔ SqlIpConfig
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.
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
rootPasswordSet ↔ bool
Output only. Indicates If this connection profile root password is stored.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryZone ↔ String
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).
getter/setter pair
sourceId ↔ String
The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID
getter/setter pair
storageAutoResizeLimit ↔ Int64Value
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
getter/setter pair
tier ↔ String
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.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
userLabels → Map<String, String>
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.
no setter
zone ↔ String
The Google Cloud Platform zone where your Cloud SQL database instance is located.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearActivationPolicy() → void
clearAutoStorageIncrease() → void
clearAvailabilityType() → void
clearCmekKeyName() → void
clearCollation() → void
clearDatabaseVersion() → void
clearDataDiskSizeGb() → void
clearDataDiskType() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearIpConfig() → void
clearRootPasswordSet() → void
clearSecondaryZone() → void
clearSourceId() → void
clearStorageAutoResizeLimit() → void
clearTier() → void
clearZone() → void
clone() → CloudSqlSettings
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(CloudSqlSettings)) → CloudSqlSettings
Apply updates to a copy of this message.
override
createEmptyInstance() → CloudSqlSettings
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field.
inherited
ensureAutoStorageIncrease() → BoolValue
ensureDataDiskSizeGb() → Int64Value
ensureIpConfig() → SqlIpConfig
ensureStorageAutoResizeLimit() → Int64Value
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasActivationPolicy() → bool
hasAutoStorageIncrease() → bool
hasAvailabilityType() → bool
hasCmekKeyName() → bool
hasCollation() → bool
hasDatabaseVersion() → bool
hasDataDiskSizeGb() → bool
hasDataDiskType() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasIpConfig() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRootPasswordSet() → bool
hasSecondaryZone() → bool
hasSourceId() → bool
hasStorageAutoResizeLimit() → bool
hasTier() → bool
hasZone() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited