Settings class

Database instance settings.

Constructors

Settings({bool? acceleratedReplicaMode, String? activationPolicy, SqlActiveDirectoryConfig? activeDirectoryConfig, AdvancedMachineFeatures? advancedMachineFeatures, List<String>? authorizedGaeApplications, bool? autoUpgradeEnabled, String? availabilityType, BackupConfiguration? backupConfiguration, String? collation, ConnectionPoolConfig? connectionPoolConfig, String? connectorEnforcement, bool? crashSafeReplicationEnabled, String? dataApiAccess, DataCacheConfig? dataCacheConfig, String? dataDiskProvisionedIops, String? dataDiskProvisionedThroughput, String? dataDiskSizeGb, String? dataDiskType, List<DatabaseFlags>? databaseFlags, bool? databaseReplicationEnabled, bool? deletionProtectionEnabled, List<DenyMaintenancePeriod>? denyMaintenancePeriods, String? edition, bool? enableDataplexIntegration, bool? enableGoogleMlIntegration, SqlServerEntraIdConfig? entraidConfig, FinalBackupConfig? finalBackupConfig, InsightsConfig? insightsConfig, IpConfiguration? ipConfiguration, String? kind, LocationPreference? locationPreference, MaintenanceWindow? maintenanceWindow, PasswordValidationPolicy? passwordValidationPolicy, PerformanceCaptureConfig? performanceCaptureConfig, String? pricingPlan, ReadPoolAutoScaleConfig? readPoolAutoScaleConfig, int? replicationLagMaxSeconds, String? replicationType, bool? retainBackupsOnDelete, String? settingsVersion, SqlServerAuditConfig? sqlServerAuditConfig, bool? storageAutoResize, String? storageAutoResizeLimit, String? tier, String? timeZone, Map<String, String>? userLabels})

Settings.fromJson(Map json_)

Properties

acceleratedReplicaMode ↔ bool?

Whether the replica is in accelerated mode.

getter/setter pair

activationPolicy ↔ String?

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

getter/setter pair

activeDirectoryConfig ↔ SqlActiveDirectoryConfig?

Active Directory configuration, relevant only for Cloud SQL for SQL Server.

getter/setter pair

advancedMachineFeatures ↔ AdvancedMachineFeatures?

Specifies advanced machine configuration for the instances relevant only for SQL Server.

getter/setter pair

authorizedGaeApplications ↔ List<String>?

The App Engine app IDs that can access this instance.

getter/setter pair

autoUpgradeEnabled ↔ bool?

Cloud SQL for MySQL auto-upgrade configuration.

getter/setter pair

availabilityType ↔ String?

Availability type.

getter/setter pair

backupConfiguration ↔ BackupConfiguration?

The daily backup configuration for the instance.

getter/setter pair

collation ↔ String?

The name of server Instance collation.

getter/setter pair

connectionPoolConfig ↔ ConnectionPoolConfig?

The managed connection pooling configuration for the instance.

getter/setter pair

connectorEnforcement ↔ String?

Specifies if connections must use Cloud SQL connectors.

getter/setter pair

crashSafeReplicationEnabled ↔ bool?

Configuration specific to read replica instances.

getter/setter pair

dataApiAccess ↔ String?

This parameter controls whether to allow using ExecuteSql API to connect to the instance.

getter/setter pair

databaseFlags ↔ List<DatabaseFlags>?

The database flags passed to the instance at startup.

getter/setter pair

databaseReplicationEnabled ↔ bool?

Configuration specific to read replica instances.

getter/setter pair

dataCacheConfig ↔ DataCacheConfig?

Configuration for data cache.

getter/setter pair

dataDiskProvisionedIops ↔ String?

Provisioned number of I/O operations per second for the data disk.

getter/setter pair

dataDiskProvisionedThroughput ↔ String?

Provisioned throughput measured in MiB per second for the data disk.

getter/setter pair

dataDiskSizeGb ↔ String?

The size of data disk, in GB.

getter/setter pair

dataDiskType ↔ String?

The type of data disk: PD_SSD (default) or PD_HDD.

getter/setter pair

deletionProtectionEnabled ↔ bool?

Configuration to protect against accidental instance deletion.

getter/setter pair

denyMaintenancePeriods ↔ List<DenyMaintenancePeriod>?

Deny maintenance periods

getter/setter pair

edition ↔ String?

The edition type of the Cloud SQL instance.

getter/setter pair

enableDataplexIntegration ↔ bool?

By default, Cloud SQL instances have schema extraction disabled for Dataplex.

getter/setter pair

enableGoogleMlIntegration ↔ bool?

When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI.

getter/setter pair

entraidConfig ↔ SqlServerEntraIdConfig?

The Microsoft Entra ID configuration for the SQL Server instance.

getter/setter pair

finalBackupConfig ↔ FinalBackupConfig?

The final backup configuration for the instance.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

insightsConfig ↔ InsightsConfig?

Insights configuration, for now relevant only for Postgres.

getter/setter pair

ipConfiguration ↔ IpConfiguration?

The settings for IP Management.

getter/setter pair

kind ↔ String?

This is always sql#settings.

getter/setter pair

locationPreference ↔ LocationPreference?

The location preference settings.

getter/setter pair

maintenanceWindow ↔ MaintenanceWindow?

The maintenance window for this instance.

getter/setter pair

passwordValidationPolicy ↔ PasswordValidationPolicy?

The local user password validation policy of the instance for PostgreSQL and MySQL.

getter/setter pair

performanceCaptureConfig ↔ PerformanceCaptureConfig?

Configuration for Performance Capture, provides diagnostic metrics during high load situations.

getter/setter pair

pricingPlan ↔ String?

The pricing plan for this instance.

getter/setter pair

readPoolAutoScaleConfig ↔ ReadPoolAutoScaleConfig?

The read pool auto-scale configuration for the instance.

getter/setter pair

replicationLagMaxSeconds ↔ int?

Configuration value for recreation of replica after certain replication lag

getter/setter pair

replicationType ↔ String?

The type of replication this instance uses.

getter/setter pair

retainBackupsOnDelete ↔ bool?

When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

settingsVersion ↔ String?

The version of instance settings.

getter/setter pair

sqlServerAuditConfig ↔ SqlServerAuditConfig?

SQL Server specific audit configuration.

getter/setter pair

storageAutoResize ↔ bool?

Configuration to increase storage size automatically.

getter/setter pair

storageAutoResizeLimit ↔ String?

The maximum size to which storage capacity can be automatically increased.

getter/setter pair

tier ↔ String?

The tier (or machine type) for this instance, for example db-custom-1-3840.

getter/setter pair

timeZone ↔ String?

Server timezone, relevant only for Cloud SQL for SQL Server.

getter/setter pair

userLabels ↔ Map<String, String>?

User-provided labels, represented as a dictionary where each label is a single key value pair.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited