DatabaseInstance class

A Cloud SQL instance resource.

Constructors

DatabaseInstance({List<String>? availableMaintenanceVersions, String? backendType, String? connectionName, String? createTime, String? currentDiskSize, String? databaseCenterIntegration, bool? databaseCenterIntegrationEnabled, String? databaseInstalledVersion, String? databaseVersion, BlueGreenDeploymentInfo? deploymentInfo, DiskEncryptionConfiguration? diskEncryptionConfiguration, DiskEncryptionStatus? diskEncryptionStatus, String? dnsName, List<DnsNameMapping>? dnsNames, String? etag, DatabaseInstanceFailoverReplica? failoverReplica, String? gceZone, GeminiInstanceConfig? geminiConfig, bool? includeReplicasForMajorVersionUpgrade, String? instanceType, List<IpMapping>? ipAddresses, String? ipv6Address, String? kind, String? maintenanceVersion, String? masterInstanceName, String? maxDiskSize, String? name, int? nodeCount, List<PoolNodeConfig>? nodes, OnPremisesConfiguration? onPremisesConfiguration, SqlOutOfDiskReport? outOfDiskReport, String? primaryDnsName, String? project, String? pscServiceAttachmentLink, String? region, ReplicaConfiguration? replicaConfiguration, List<String>? replicaNames, ReplicationCluster? replicationCluster, String? rootPassword, bool? satisfiesPzi, bool? satisfiesPzs, SqlScheduledMaintenance? scheduledMaintenance, String? secondaryGceZone, String? selfLink, SslCert? serverCaCert, String? serviceAccountEmailAddress, Settings? settings, bool? skipPrecheck, String? sqlNetworkArchitecture, String? state, List<String>? suspensionReason, bool? switchTransactionLogsToCloudStorageEnabled, Map<String, String>? tags, List<AvailableDatabaseVersion>? upgradableDatabaseVersions, String? writeEndpoint})

DatabaseInstance.fromJson(Map json_)

Properties

availableMaintenanceVersions ↔ List<String>?

List all maintenance versions applicable on the instance

getter/setter pair

backendType ↔ String?

The backend type.

getter/setter pair

connectionName ↔ String?

Connection name of the Cloud SQL instance used in connection strings.

getter/setter pair

createTime ↔ String?

The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

getter/setter pair

currentDiskSize ↔ String?

The current disk usage of the instance in bytes.

getter/setter pair

databaseCenterIntegration ↔ String?

State of the Database Center integration for this instance.

getter/setter pair

databaseCenterIntegrationEnabled ↔ bool?

If true, instance metadata is sent to the Database Center.

getter/setter pair

databaseInstalledVersion ↔ String?

Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

getter/setter pair

databaseVersion ↔ String?

The database engine type and version.

getter/setter pair

deploymentInfo ↔ BlueGreenDeploymentInfo?

Deployment info for the instance.

getter/setter pair

diskEncryptionConfiguration ↔ DiskEncryptionConfiguration?

Disk encryption configuration specific to an instance.

getter/setter pair

diskEncryptionStatus ↔ DiskEncryptionStatus?

Disk encryption status specific to an instance.

getter/setter pair

dnsName ↔ String?

The dns name of the instance.

getter/setter pair

dnsNames ↔ List<DnsNameMapping>?

The list of DNS names used by this instance.

getter/setter pair

etag ↔ String?

This field is deprecated and will be removed from a future version of the API.

getter/setter pair

failoverReplica ↔ DatabaseInstanceFailoverReplica?

The name and status of the failover replica.

getter/setter pair

gceZone ↔ String?

The Compute Engine zone that the instance is currently serving from.

getter/setter pair

geminiConfig ↔ GeminiInstanceConfig?

Gemini instance configuration.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

includeReplicasForMajorVersionUpgrade ↔ bool?

Input only.

getter/setter pair

instanceType ↔ String?

The instance type. Possible string values are:

getter/setter pair

ipAddresses ↔ List<IpMapping>?

The assigned IP addresses for the instance.

getter/setter pair

ipv6Address ↔ String?

The IPv6 address assigned to the instance.

getter/setter pair

kind ↔ String?

This is always sql#instance.

getter/setter pair

maintenanceVersion ↔ String?

The current software version on the instance.

getter/setter pair

masterInstanceName ↔ String?

The name of the instance which will act as primary in the replication setup.

getter/setter pair

maxDiskSize ↔ String?

The maximum disk size of the instance in bytes.

getter/setter pair

name ↔ String?

Name of the Cloud SQL instance.

getter/setter pair

nodeCount ↔ int?

The number of read pool nodes in a read pool.

getter/setter pair

nodes ↔ List<PoolNodeConfig>?

Entries containing information about each read pool node of the read pool.

getter/setter pair

onPremisesConfiguration ↔ OnPremisesConfiguration?

Configuration specific to on-premises instances.

getter/setter pair

outOfDiskReport ↔ SqlOutOfDiskReport?

This field represents the report generated by the proactive database wellness job for OutOfDisk issues.

getter/setter pair

primaryDnsName ↔ String?

DEPRECATED: please use write_endpoint instead.

getter/setter pair

project ↔ String?

The project ID of the project containing the Cloud SQL instance.

getter/setter pair

pscServiceAttachmentLink ↔ String?

The link to service attachment of PSC instance.

getter/setter pair

region ↔ String?

The geographical region of the Cloud SQL instance.

getter/setter pair

replicaConfiguration ↔ ReplicaConfiguration?

Configuration specific to failover replicas and read replicas.

getter/setter pair

replicaNames ↔ List<String>?

The replicas of the instance.

getter/setter pair

replicationCluster ↔ ReplicationCluster?

A primary instance and disaster recovery (DR) replica pair.

getter/setter pair

rootPassword ↔ String?

Initial root password.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

satisfiesPzi ↔ bool?

This status indicates whether the instance satisfies PZI.

getter/setter pair

satisfiesPzs ↔ bool?

This status indicates whether the instance satisfies PZS.

getter/setter pair

scheduledMaintenance ↔ SqlScheduledMaintenance?

The start time of any upcoming scheduled maintenance for this instance.

getter/setter pair

secondaryGceZone ↔ String?

The Compute Engine zone that the failover instance is currently serving from for a regional instance.

getter/setter pair

selfLink ↔ String?

The URI of this resource.

getter/setter pair

serverCaCert ↔ SslCert?

SSL configuration.

getter/setter pair

serviceAccountEmailAddress ↔ String?

The service account email address assigned to the instance.\This property is read-only.

getter/setter pair

settings ↔ Settings?

The user settings.

getter/setter pair

skipPrecheck ↔ bool?

Input only.

getter/setter pair

sqlNetworkArchitecture ↔ String?

Possible string values are:

getter/setter pair

state ↔ String?

The current serving state of the Cloud SQL instance. Possible string values are:

getter/setter pair

suspensionReason ↔ List<String>?

If the instance state is SUSPENDED, the reason for the suspension.

getter/setter pair

switchTransactionLogsToCloudStorageEnabled ↔ bool?

Input only.

getter/setter pair

tags ↔ Map<String, String>?

Input only.

getter/setter pair

upgradableDatabaseVersions ↔ List<AvailableDatabaseVersion>?

All database versions that are available for upgrade.

getter/setter pair

writeEndpoint ↔ String?

The dns name of the primary instance in a replication group.

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