GetInstanceResult class

Result data returned by getInstance.

Constructors

GetInstanceResult({required List<String> availableMaintenanceVersions, required String backendType, required String connectionName, required String createTime, required String currentDiskSize, required String databaseInstalledVersion, required String databaseVersion, required DiskEncryptionConfigurationResponse diskEncryptionConfiguration, required DiskEncryptionStatusResponse diskEncryptionStatus, required String dnsName, required String etag, required InstanceFailoverReplicaResponse failoverReplica, required String gceZone, required String instanceType, required List<IpMappingResponse> ipAddresses, required String ipv6Address, required String kind, required String maintenanceVersion, required String masterInstanceName, required String maxDiskSize, required String name, required OnPremisesConfigurationResponse onPremisesConfiguration, required SqlOutOfDiskReportResponse outOfDiskReport, required String primaryDnsName, required String project, required String pscServiceAttachmentLink, required String region, required ReplicaConfigurationResponse replicaConfiguration, required List<String> replicaNames, required String rootPassword, required bool satisfiesPzs, required SqlScheduledMaintenanceResponse scheduledMaintenance, required String secondaryGceZone, required String selfLink, required SslCertResponse serverCaCert, required String serviceAccountEmailAddress, required SettingsResponse settings, required String sqlNetworkArchitecture, required String state, required List<String> suspensionReason, required String writeEndpoint})
Creates a new GetInstanceResult. availableMaintenanceVersions List all maintenance versions applicable on the instance backendType The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type. connectionName Connection name of the Cloud SQL instance used in connection strings. createTime The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. currentDiskSize The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details. databaseInstalledVersion Stores the current database version running on the instance including minor version such as MYSQL_8_0_18. databaseVersion The database engine type and version. The databaseVersion field cannot be changed after instance creation. diskEncryptionConfiguration Disk encryption configuration specific to an instance. diskEncryptionStatus Disk encryption status specific to an instance. dnsName The dns name of the instance. etag This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead. failoverReplica The name and status of the failover replica. gceZone The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. instanceType The instance type. ipAddresses The assigned IP addresses for the instance. ipv6Address The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. kind This is always sql#instance. maintenanceVersion The current software version on the instance. masterInstanceName The name of the instance which will act as primary in the replication setup. maxDiskSize The maximum disk size of the instance in bytes. name Name of the Cloud SQL instance. This does not include the project ID. onPremisesConfiguration Configuration specific to on-premises instances. outOfDiskReport This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job primaryDnsName DEPRECATED: please use write_endpoint instead. project The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. pscServiceAttachmentLink The link to service attachment of PSC instance. region The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation. replicaConfiguration Configuration specific to failover replicas and read replicas. replicaNames The replicas of the instance. rootPassword Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. satisfiesPzs The status indicating if instance satisfiesPzs. Reserved for future use. scheduledMaintenance The start time of any upcoming scheduled maintenance for this instance. secondaryGceZone The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. selfLink The URI of this resource. serverCaCert SSL configuration. serviceAccountEmailAddress The service account email address assigned to the instance.\This property is read-only. settings The user settings. sqlNetworkArchitecture Required. state The current serving state of the Cloud SQL instance. suspensionReason If the instance state is SUSPENDED, the reason for the suspension. writeEndpoint The dns name of the primary instance in a replication group.
const
GetInstanceResult.fromMap(Map<String, dynamic> map)
factory

Properties

availableMaintenanceVersions → List<String>
List all maintenance versions applicable on the instance
final
backendType → String
The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.
final
connectionName → String
Connection name of the Cloud SQL instance used in connection strings.
final
createTime → String
The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
final
currentDiskSize → String
The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.
final
databaseInstalledVersion → String
Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.
final
databaseVersion → String
The database engine type and version. The databaseVersion field cannot be changed after instance creation.
final
diskEncryptionConfiguration → DiskEncryptionConfigurationResponse
Disk encryption configuration specific to an instance.
final
diskEncryptionStatus → DiskEncryptionStatusResponse
Disk encryption status specific to an instance.
final
dnsName → String
The dns name of the instance.
final
etag → String
This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
final
failoverReplica → InstanceFailoverReplicaResponse
The name and status of the failover replica.
final
gceZone → String
The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceType → String
The instance type.
final
ipAddresses → List<IpMappingResponse>
The assigned IP addresses for the instance.
final
ipv6Address → String
The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
final
kind → String
This is always sql#instance.
final
maintenanceVersion → String
The current software version on the instance.
final
masterInstanceName → String
The name of the instance which will act as primary in the replication setup.
final
maxDiskSize → String
The maximum disk size of the instance in bytes.
final
name → String
Name of the Cloud SQL instance. This does not include the project ID.
final
onPremisesConfiguration → OnPremisesConfigurationResponse
Configuration specific to on-premises instances.
final
outOfDiskReport → SqlOutOfDiskReportResponse
This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
final
primaryDnsName → String
DEPRECATED: please use write_endpoint instead.
final
project → String
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
final
The link to service attachment of PSC instance.
final
region → String
The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.
final
replicaConfiguration → ReplicaConfigurationResponse
Configuration specific to failover replicas and read replicas.
final
replicaNames → List<String>
The replicas of the instance.
final
rootPassword → String
Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs → bool
The status indicating if instance satisfiesPzs. Reserved for future use.
final
scheduledMaintenance → SqlScheduledMaintenanceResponse
The start time of any upcoming scheduled maintenance for this instance.
final
secondaryGceZone → String
The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.
final
The URI of this resource.
final
serverCaCert → SslCertResponse
SSL configuration.
final
serviceAccountEmailAddress → String
The service account email address assigned to the instance.\This property is read-only.
final
settings → SettingsResponse
The user settings.
final
sqlNetworkArchitecture → String
final
state → String
The current serving state of the Cloud SQL instance.
final
suspensionReason → List<String>
If the instance state is SUSPENDED, the reason for the suspension.
final
writeEndpoint → String
The dns name of the primary instance in a replication group.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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