GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance (google_api_sql_admin v0.71.0)

View Source

A Cloud SQL instance resource.

Attributes

  • selfLink (type: String.t, default: nil) - The URI of this resource.
  • 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.
  • state (type: String.t, default: nil) - The current serving state of the Cloud SQL instance.
  • name (type: String.t, default: nil) - Name of the Cloud SQL instance. This does not include the project ID.
  • dnsName (type: String.t, default: nil) - Output only. The dns name 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.
  • availableMaintenanceVersions (type: list(String.t), default: nil) - Output only. List all maintenance versions applicable on the instance
  • nodes (type: list(GoogleApi.SQLAdmin.V1beta4.Model.PoolNodeConfig.t), default: nil) - Output only. Entries containing information about each node of the read pool.
  • masterInstanceName (type: String.t, default: nil) - The name of the instance which will act as primary in the replication setup.
  • 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.
  • diskEncryptionStatus (type: GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionStatus.t, default: nil) - Disk encryption status specific to an instance.
  • kind (type: String.t, default: nil) - This is always sql#instance.
  • connectionName (type: String.t, default: nil) - Connection name of the Cloud SQL instance used in connection strings.
  • upgradableDatabaseVersions (type: list(GoogleApi.SQLAdmin.V1beta4.Model.AvailableDatabaseVersion.t), default: nil) - Output only. All database versions that are available for upgrade.
  • ipv6Address (type: String.t, default: nil) - The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
  • satisfiesPzs (type: boolean(), default: nil) - This status indicates whether the instance satisfies PZS. The status is reserved for future use.
  • sqlNetworkArchitecture (type: String.t, default: nil) - The SQL network architecture for the instance.
  • instanceType (type: String.t, default: nil) - The instance type.
  • 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.
  • includeReplicasForMajorVersionUpgrade (type: boolean(), default: nil) - Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.
  • replicaNames (type: list(String.t), default: nil) - The replicas of the instance.
  • writeEndpoint (type: String.t, default: nil) - Output only. The dns name of the primary instance in a replication group.
  • 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, and us-central1. The default value is us-central1.
  • 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.
  • maintenanceVersion (type: String.t, default: nil) - The current software version on the instance.
  • serverCaCert (type: GoogleApi.SQLAdmin.V1beta4.Model.SslCert.t, default: nil) - SSL configuration.
  • serviceAccountEmailAddress (type: String.t, default: nil) - The service account email address assigned to the instance. \This property is read-only.
  • 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.
  • 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.
  • tags (type: map(), default: nil) - Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: "" : "". For example, a single resource can have the following tags: "123/environment": "production", "123/costCenter": "marketing", For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.
  • onPremisesConfiguration (type: GoogleApi.SQLAdmin.V1beta4.Model.OnPremisesConfiguration.t, default: nil) - Configuration specific to on-premises instances.
  • settings (type: GoogleApi.SQLAdmin.V1beta4.Model.Settings.t, default: nil) - The user settings.
  • databaseInstalledVersion (type: String.t, default: nil) - Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.
  • geminiConfig (type: GoogleApi.SQLAdmin.V1beta4.Model.GeminiInstanceConfig.t, default: nil) - Gemini instance configuration.
  • databaseVersion (type: String.t, default: nil) - The database engine type and version. The databaseVersion field cannot be changed after instance creation.
  • ipAddresses (type: list(GoogleApi.SQLAdmin.V1beta4.Model.IpMapping.t), default: nil) - The assigned IP addresses for the instance.
  • diskEncryptionConfiguration (type: GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionConfiguration.t, default: nil) - Disk encryption configuration specific to an instance.
  • suspensionReason (type: list(String.t), default: nil) - If the instance state is SUSPENDED, the reason for the suspension.
  • nodeCount (type: integer(), default: nil) - The number of nodes in a read pool.
  • pscServiceAttachmentLink (type: String.t, default: nil) - Output only. The link to service attachment of PSC instance.
  • failoverReplica (type: GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstanceFailoverReplica.t, default: nil) - The name and status of the failover replica.
  • dnsNames (type: list(GoogleApi.SQLAdmin.V1beta4.Model.DnsNameMapping.t), default: nil) - Output only. The list of DNS names used by this instance.
  • scheduledMaintenance (type: GoogleApi.SQLAdmin.V1beta4.Model.SqlScheduledMaintenance.t, default: nil) - The start time of any upcoming scheduled maintenance for this 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
  • replicationCluster (type: GoogleApi.SQLAdmin.V1beta4.Model.ReplicationCluster.t, default: nil) - A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.
  • maxDiskSize (type: String.t, default: nil) - The maximum disk size of the instance in bytes.
  • 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.
  • replicaConfiguration (type: GoogleApi.SQLAdmin.V1beta4.Model.ReplicaConfiguration.t, default: nil) - Configuration specific to failover replicas and read replicas.
  • switchTransactionLogsToCloudStorageEnabled (type: boolean(), default: nil) - Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
  • primaryDnsName (type: String.t, default: nil) - Output only. DEPRECATED: please use write_endpoint instead.
  • satisfiesPzi (type: boolean(), default: nil) - Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.SQLAdmin.V1beta4.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.V1beta4.Model.DiskEncryptionConfiguration.t() | nil,
  diskEncryptionStatus:
    GoogleApi.SQLAdmin.V1beta4.Model.DiskEncryptionStatus.t() | nil,
  dnsName: String.t() | nil,
  dnsNames: [GoogleApi.SQLAdmin.V1beta4.Model.DnsNameMapping.t()] | nil,
  etag: String.t() | nil,
  failoverReplica:
    GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstanceFailoverReplica.t() | nil,
  gceZone: String.t() | nil,
  geminiConfig: GoogleApi.SQLAdmin.V1beta4.Model.GeminiInstanceConfig.t() | nil,
  includeReplicasForMajorVersionUpgrade: boolean() | nil,
  instanceType: String.t() | nil,
  ipAddresses: [GoogleApi.SQLAdmin.V1beta4.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,
  nodeCount: integer() | nil,
  nodes: [GoogleApi.SQLAdmin.V1beta4.Model.PoolNodeConfig.t()] | nil,
  onPremisesConfiguration:
    GoogleApi.SQLAdmin.V1beta4.Model.OnPremisesConfiguration.t() | nil,
  outOfDiskReport:
    GoogleApi.SQLAdmin.V1beta4.Model.SqlOutOfDiskReport.t() | nil,
  primaryDnsName: String.t() | nil,
  project: String.t() | nil,
  pscServiceAttachmentLink: String.t() | nil,
  region: String.t() | nil,
  replicaConfiguration:
    GoogleApi.SQLAdmin.V1beta4.Model.ReplicaConfiguration.t() | nil,
  replicaNames: [String.t()] | nil,
  replicationCluster:
    GoogleApi.SQLAdmin.V1beta4.Model.ReplicationCluster.t() | nil,
  rootPassword: String.t() | nil,
  satisfiesPzi: boolean() | 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,
  sqlNetworkArchitecture: String.t() | nil,
  state: String.t() | nil,
  suspensionReason: [String.t()] | nil,
  switchTransactionLogsToCloudStorageEnabled: boolean() | nil,
  tags: map() | nil,
  upgradableDatabaseVersions:
    [GoogleApi.SQLAdmin.V1beta4.Model.AvailableDatabaseVersion.t()] | nil,
  writeEndpoint: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.