View Source GoogleApi.SQLAdmin.V1.Model.DatabaseInstance (google_api_sql_admin v0.54.0)
A Cloud SQL instance resource.
Attributes
-
ipv6Address
(type:String.t
, default:nil
) - The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. -
etag
(type:String.t
, default:nil
) - This field is deprecated and will be removed from a future version of the API. Use thesettings.settingsVersion
field instead. -
databaseVersion
(type:String.t
, default:nil
) - The database engine type and version. ThedatabaseVersion
field cannot be changed after instance creation. -
serverCaCert
(type:GoogleApi.SQLAdmin.V1.Model.SslCert.t
, default:nil
) - SSL configuration. -
dnsName
(type:String.t
, default:nil
) - Output only. The dns name of the instance. -
sqlNetworkArchitecture
(type:String.t
, default:nil
) - -
suspensionReason
(type:list(String.t)
, default:nil
) - If the instance state is SUSPENDED, the reason for the suspension. -
maintenanceVersion
(type:String.t
, default:nil
) - The current software version on the instance. -
serviceAccountEmailAddress
(type:String.t
, default:nil
) - The service account email address assigned to the instance.\This property is read-only. -
masterInstanceName
(type:String.t
, default:nil
) - The name of the instance which will act as primary in the replication setup. -
createTime
(type:DateTime.t
, default:nil
) - Output only. The time when the instance was created in RFC 3339 format, for example2012-11-15T16:19:00.094Z
. -
satisfiesPzs
(type:boolean()
, default:nil
) - The status indicating if instance satisfiesPzs. Reserved for future use. -
databaseInstalledVersion
(type:String.t
, default:nil
) - Output only. Stores the current database version running on the instance including minor version such asMYSQL_8_0_18
. -
kind
(type:String.t
, default:nil
) - This is alwayssql#instance
. -
gceZone
(type:String.t
, default:nil
) - 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. -
project
(type:String.t
, default:nil
) - The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. -
name
(type:String.t
, default:nil
) - Name of the Cloud SQL instance. This does not include the project ID. -
state
(type:String.t
, default:nil
) - The current serving state of the Cloud SQL instance. -
region
(type:String.t
, default:nil
) - The geographical region of the Cloud SQL instance. It can be one of the regions where Cloud SQL operates: For example,asia-east1
,europe-west1
, andus-central1
. The default value isus-central1
. -
replicaConfiguration
(type:GoogleApi.SQLAdmin.V1.Model.ReplicaConfiguration.t
, default:nil
) - Configuration specific to failover replicas and read replicas. -
diskEncryptionStatus
(type:GoogleApi.SQLAdmin.V1.Model.DiskEncryptionStatus.t
, default:nil
) - Disk encryption status specific to an instance. -
connectionName
(type:String.t
, default:nil
) - Connection name of the Cloud SQL instance used in connection strings. -
onPremisesConfiguration
(type:GoogleApi.SQLAdmin.V1.Model.OnPremisesConfiguration.t
, default:nil
) - Configuration specific to on-premises instances. -
primaryDnsName
(type:String.t
, default:nil
) - Output only. DEPRECATED: please use write_endpoint instead. -
availableMaintenanceVersions
(type:list(String.t)
, default:nil
) - Output only. List all maintenance versions applicable on the instance -
writeEndpoint
(type:String.t
, default:nil
) - Output only. The dns name of the primary instance in a replication group. -
instanceType
(type:String.t
, default:nil
) - The instance type. -
ipAddresses
(type:list(GoogleApi.SQLAdmin.V1.Model.IpMapping.t)
, default:nil
) - The assigned IP addresses for the instance. -
replicaNames
(type:list(String.t)
, default:nil
) - The replicas of the instance. -
currentDiskSize
(type:String.t
, default:nil
) - 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. -
secondaryGceZone
(type:String.t
, default:nil
) - 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. -
pscServiceAttachmentLink
(type:String.t
, default:nil
) - Output only. The link to service attachment of PSC instance. -
settings
(type:GoogleApi.SQLAdmin.V1.Model.Settings.t
, default:nil
) - The user settings. -
rootPassword
(type:String.t
, default:nil
) - Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. -
selfLink
(type:String.t
, default:nil
) - The URI of this resource. -
backendType
(type:String.t
, default:nil
) - 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 thetier
property in thesettings
object to determine the database type. -
scheduledMaintenance
(type:GoogleApi.SQLAdmin.V1.Model.SqlScheduledMaintenance.t
, default:nil
) - The start time of any upcoming scheduled maintenance for this instance. -
maxDiskSize
(type:String.t
, default:nil
) - The maximum disk size of the instance in bytes. -
failoverReplica
(type:GoogleApi.SQLAdmin.V1.Model.DatabaseInstanceFailoverReplica.t
, default:nil
) - The name and status of the failover replica. -
diskEncryptionConfiguration
(type:GoogleApi.SQLAdmin.V1.Model.DiskEncryptionConfiguration.t
, default:nil
) - Disk encryption configuration specific to an instance. -
outOfDiskReport
(type:GoogleApi.SQLAdmin.V1.Model.SqlOutOfDiskReport.t
, default:nil
) - 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
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.SQLAdmin.V1.Model.DatabaseInstance{ availableMaintenanceVersions: [String.t()] | nil, backendType: String.t() | nil, connectionName: String.t() | nil, createTime: DateTime.t() | nil, currentDiskSize: String.t() | nil, databaseInstalledVersion: String.t() | nil, databaseVersion: String.t() | nil, diskEncryptionConfiguration: GoogleApi.SQLAdmin.V1.Model.DiskEncryptionConfiguration.t() | nil, diskEncryptionStatus: GoogleApi.SQLAdmin.V1.Model.DiskEncryptionStatus.t() | nil, dnsName: String.t() | nil, etag: String.t() | nil, failoverReplica: GoogleApi.SQLAdmin.V1.Model.DatabaseInstanceFailoverReplica.t() | nil, gceZone: String.t() | nil, instanceType: String.t() | nil, ipAddresses: [GoogleApi.SQLAdmin.V1.Model.IpMapping.t()] | nil, ipv6Address: String.t() | nil, kind: String.t() | nil, maintenanceVersion: String.t() | nil, masterInstanceName: String.t() | nil, maxDiskSize: String.t() | nil, name: String.t() | nil, onPremisesConfiguration: GoogleApi.SQLAdmin.V1.Model.OnPremisesConfiguration.t() | nil, outOfDiskReport: GoogleApi.SQLAdmin.V1.Model.SqlOutOfDiskReport.t() | nil, primaryDnsName: String.t() | nil, project: String.t() | nil, pscServiceAttachmentLink: String.t() | nil, region: String.t() | nil, replicaConfiguration: GoogleApi.SQLAdmin.V1.Model.ReplicaConfiguration.t() | nil, replicaNames: [String.t()] | nil, rootPassword: String.t() | nil, satisfiesPzs: boolean() | nil, scheduledMaintenance: GoogleApi.SQLAdmin.V1.Model.SqlScheduledMaintenance.t() | nil, secondaryGceZone: String.t() | nil, selfLink: String.t() | nil, serverCaCert: GoogleApi.SQLAdmin.V1.Model.SslCert.t() | nil, serviceAccountEmailAddress: String.t() | nil, settings: GoogleApi.SQLAdmin.V1.Model.Settings.t() | nil, sqlNetworkArchitecture: String.t() | nil, state: String.t() | nil, suspensionReason: [String.t()] | nil, writeEndpoint: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.