GetInstanceResult

data class GetInstanceResult(val availableMaintenanceVersions: List<String>, val backendType: String, val connectionName: String, val createTime: String, val currentDiskSize: String, val databaseInstalledVersion: String, val databaseVersion: String, val diskEncryptionConfiguration: DiskEncryptionConfigurationResponse, val diskEncryptionStatus: DiskEncryptionStatusResponse, val etag: String, val failoverReplica: InstanceFailoverReplicaResponse, val gceZone: String, val instanceType: String, val ipAddresses: List<IpMappingResponse>, val ipv6Address: String, val kind: String, val maintenanceVersion: String, val masterInstanceName: String, val maxDiskSize: String, val name: String, val onPremisesConfiguration: OnPremisesConfigurationResponse, val outOfDiskReport: SqlOutOfDiskReportResponse, val project: String, val region: String, val replicaConfiguration: ReplicaConfigurationResponse, val replicaNames: List<String>, val rootPassword: String, val satisfiesPzs: Boolean, val scheduledMaintenance: SqlScheduledMaintenanceResponse, val secondaryGceZone: String, val selfLink: String, val serverCaCert: SslCertResponse, val serviceAccountEmailAddress: String, val settings: SettingsResponse, val state: String, val suspensionReason: List<String>)

Constructors

Link copied to clipboard
fun GetInstanceResult(availableMaintenanceVersions: List<String>, backendType: String, connectionName: String, createTime: String, currentDiskSize: String, databaseInstalledVersion: String, databaseVersion: String, diskEncryptionConfiguration: DiskEncryptionConfigurationResponse, diskEncryptionStatus: DiskEncryptionStatusResponse, etag: String, failoverReplica: InstanceFailoverReplicaResponse, gceZone: String, instanceType: String, ipAddresses: List<IpMappingResponse>, ipv6Address: String, kind: String, maintenanceVersion: String, masterInstanceName: String, maxDiskSize: String, name: String, onPremisesConfiguration: OnPremisesConfigurationResponse, outOfDiskReport: SqlOutOfDiskReportResponse, project: String, region: String, replicaConfiguration: ReplicaConfigurationResponse, replicaNames: List<String>, rootPassword: String, satisfiesPzs: Boolean, scheduledMaintenance: SqlScheduledMaintenanceResponse, secondaryGceZone: String, selfLink: String, serverCaCert: SslCertResponse, serviceAccountEmailAddress: String, settings: SettingsResponse, state: String, suspensionReason: List<String>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

List all maintenance versions applicable on the instance

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The database engine type and version. The databaseVersion field cannot be changed after instance creation.

Link copied to clipboard

Disk encryption configuration specific to an instance.

Link copied to clipboard

Disk encryption status specific to an instance.

Link copied to clipboard

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

Link copied to clipboard

The name and status of the failover replica.

Link copied to clipboard

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.

Link copied to clipboard

The instance type.

Link copied to clipboard

The assigned IP addresses for the instance.

Link copied to clipboard

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

Link copied to clipboard

This is always sql#instance.

Link copied to clipboard

The current software version on the instance.

Link copied to clipboard

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

Link copied to clipboard

The maximum disk size of the instance in bytes.

Link copied to clipboard

Name of the Cloud SQL instance. This does not include the project ID.

Link copied to clipboard

Configuration specific to on-premises instances.

Link copied to clipboard

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

Link copied to clipboard

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

Link copied to clipboard

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.

Link copied to clipboard

Configuration specific to failover replicas and read replicas.

Link copied to clipboard

The replicas of the instance.

Link copied to clipboard

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

Link copied to clipboard

The status indicating if instance satisfiesPzs. Reserved for future use.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The URI of this resource.

Link copied to clipboard

SSL configuration.

Link copied to clipboard

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

Link copied to clipboard

The user settings.

Link copied to clipboard

The current serving state of the Cloud SQL instance.

Link copied to clipboard

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