GetDatabaseResult

data class GetDatabaseResult(val createTime: String, val databaseDialect: String, val defaultLeader: String, val earliestVersionTime: String, val enableDropProtection: Boolean, val encryptionConfig: EncryptionConfigResponse, val encryptionInfo: List<EncryptionInfoResponse>, val name: String, val reconciling: Boolean, val restoreInfo: RestoreInfoResponse, val state: String, val versionRetentionPeriod: String)

Constructors

Link copied to clipboard
fun GetDatabaseResult(createTime: String, databaseDialect: String, defaultLeader: String, earliestVersionTime: String, enableDropProtection: Boolean, encryptionConfig: EncryptionConfigResponse, encryptionInfo: List<EncryptionInfoResponse>, name: String, reconciling: Boolean, restoreInfo: RestoreInfoResponse, state: String, versionRetentionPeriod: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

If exists, the time at which the database creation started.

Link copied to clipboard

The dialect of the Cloud Spanner Database.

Link copied to clipboard

The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.

Link copied to clipboard

Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.

Link copied to clipboard

Whether drop protection is enabled for this database. Defaults to false, if not set.

Link copied to clipboard

For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default or other types of encryption, this field is empty.

Link copied to clipboard

For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.

Link copied to clipboard

The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

Link copied to clipboard

If true, the database is being updated. If false, there are no ongoing update operations for the database.

Link copied to clipboard

Applicable only for restored databases. Contains information about the restore source.

Link copied to clipboard

The current database state.

Link copied to clipboard

The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.