GoogleApi.Spanner.V1.Model.Database (google_api_spanner v0.32.0) View Source

A Cloud Spanner database.

Attributes

  • createTime (type: DateTime.t, default: nil) - Output only. If exists, the time at which the database creation started.
  • earliestVersionTime (type: DateTime.t, default: nil) - Output only. 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.
  • encryptionConfig (type: GoogleApi.Spanner.V1.Model.EncryptionConfig.t, default: nil) - Output only. 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.
  • encryptionInfo (type: list(GoogleApi.Spanner.V1.Model.EncryptionInfo.t), default: nil) - Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as encryption state and the Cloud KMS key versions that are in use. 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.
  • name (type: String.t, default: nil) - Required. The name of the database. Values are of the form projects//instances//databases/, where ` is as specified in theCREATE DATABASEstatement. This name can be passed to other API methods to identify the database. *restoreInfo(*type:*GoogleApi.Spanner.V1.Model.RestoreInfo.t, *default:*nil) - Output only. Applicable only for restored databases. Contains information about the restore source. *state(*type:*String.t, *default:*nil) - Output only. The current database state. *versionRetentionPeriod(*type:*String.t, *default:*nil`) - Output only. 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Spanner.V1.Model.Database{
  createTime: DateTime.t() | nil,
  earliestVersionTime: DateTime.t() | nil,
  encryptionConfig: GoogleApi.Spanner.V1.Model.EncryptionConfig.t() | nil,
  encryptionInfo: [GoogleApi.Spanner.V1.Model.EncryptionInfo.t()] | nil,
  name: String.t() | nil,
  restoreInfo: GoogleApi.Spanner.V1.Model.RestoreInfo.t() | nil,
  state: String.t() | nil,
  versionRetentionPeriod: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.