GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance (google_api_sql_admin v0.48.0) View Source
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 the settings.settingsVersion field instead. -
databaseVersion
(type:String.t
, default:nil
) - The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13 (default), POSTGRES_14. *SQL Server instances: SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB, SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB. -
serverCaCert
(type:GoogleApi.SQLAdmin.V1beta4.Model.SslCert.t
, default:nil
) - SSL configuration. -
suspensionReason
(type:list(String.t)
, default:nil
) - If the instance state is SUSPENDED, the reason for the suspension. -
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 example 2012-11-15T16:19:00.094Z. -
satisfiesPzs
(type:boolean()
, default:nil
) - The status indicating if instance satisfiesPzs. Reserved for future use. -
kind
(type:String.t
, default:nil
) - This is always sql#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. -
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. This can be one of the following: SQL_INSTANCE_STATE_UNSPECIFIED: The state of the instance is unknown. RUNNABLE: The instance is running, or has been stopped by owner. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_DELETE: The instance is being deleted. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. *FAILED: The instance creation failed. -
region
(type:String.t
, default:nil
) - 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
(type:GoogleApi.SQLAdmin.V1beta4.Model.ReplicaConfiguration.t
, default:nil
) - Configuration specific to failover replicas and read replicas. -
diskEncryptionStatus
(type:GoogleApi.SQLAdmin.V1beta4.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.V1beta4.Model.OnPremisesConfiguration.t
, default:nil
) - Configuration specific to on-premises instances. -
instanceType
(type:String.t
, default:nil
) - The instance type. This can be one of the following: CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a primary instance. ON_PREMISES_INSTANCE: An instance running on the customer's premises. *READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. -
ipAddresses
(type:list(GoogleApi.SQLAdmin.V1beta4.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. Reserved for future use. -
settings
(type:GoogleApi.SQLAdmin.V1beta4.Model.Settings.t
, default:nil
) - The user settings. -
rootPassword
(type:String.t
, default:nil
) - Initial root password. Use only on creation. -
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 the tier property in the settings object to determine the database type. -
scheduledMaintenance
(type:GoogleApi.SQLAdmin.V1beta4.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.V1beta4.Model.DatabaseInstanceFailoverReplica.t
, default:nil
) - The name and status of the failover replica. -
diskEncryptionConfiguration
(type:GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionConfiguration.t
, default:nil
) - Disk encryption configuration specific to an instance. -
outOfDiskReport
(type:GoogleApi.SQLAdmin.V1beta4.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
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance{ backendType: String.t() | nil, connectionName: String.t() | nil, createTime: DateTime.t() | nil, currentDiskSize: String.t() | nil, databaseVersion: String.t() | nil, diskEncryptionConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionConfiguration.t() | nil, diskEncryptionStatus: GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionStatus.t() | nil, etag: String.t() | nil, failoverReplica: GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstanceFailoverReplica.t() | nil, gceZone: String.t() | nil, instanceType: String.t() | nil, ipAddresses: [GoogleApi.SQLAdmin.V1beta4.Model.IpMapping.t()] | nil, ipv6Address: String.t() | nil, kind: String.t() | nil, masterInstanceName: String.t() | nil, maxDiskSize: String.t() | nil, name: String.t() | nil, onPremisesConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.OnPremisesConfiguration.t() | nil, outOfDiskReport: GoogleApi.SQLAdmin.V1beta4.Model.SqlOutOfDiskReport.t() | nil, project: String.t() | nil, region: String.t() | nil, replicaConfiguration: GoogleApi.SQLAdmin.V1beta4.Model.ReplicaConfiguration.t() | nil, replicaNames: [String.t()] | nil, rootPassword: String.t() | nil, satisfiesPzs: boolean() | nil, scheduledMaintenance: GoogleApi.SQLAdmin.V1beta4.Model.SqlScheduledMaintenance.t() | nil, secondaryGceZone: String.t() | nil, selfLink: String.t() | nil, serverCaCert: GoogleApi.SQLAdmin.V1beta4.Model.SslCert.t() | nil, serviceAccountEmailAddress: String.t() | nil, settings: GoogleApi.SQLAdmin.V1beta4.Model.Settings.t() | nil, state: String.t() | nil, suspensionReason: [String.t()] | nil }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.