Backup

import type { Backup } from "https://googleapis.deno.dev/v1/spanner:v1.ts";

A backup of a Cloud Spanner database.

interface Backup {

readonly createTime?: Date;

database?: string;

readonly databaseDialect?: "DATABASE_DIALECT_UNSPECIFIED" | "GOOGLE_STANDARD_SQL" | "POSTGRESQL";

readonly encryptionInfo?: EncryptionInfo;

readonly encryptionInformation?: EncryptionInfo[];

expireTime?: Date;

readonly maxExpireTime?: Date;

name?: string;

readonly referencingBackups?: string[];

readonly referencingDatabases?: string[];

readonly sizeBytes?: bigint;

readonly state?: "STATE_UNSPECIFIED" | "CREATING" | "READY";

versionTime?: Date;

}

§Properties

readonly createTime?: Date

[src]

Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.

database?: string

[src]

Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects//instances//databases/.

readonly databaseDialect?: "DATABASE_DIALECT_UNSPECIFIED" | "GOOGLE_STANDARD_SQL" | "POSTGRESQL"

[src]

Output only. The database dialect information for the backup.

readonly encryptionInfo?: EncryptionInfo

[src]

Output only. The encryption information for the backup.

readonly encryptionInformation?: EncryptionInfo[]

[src]

Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The encryption_status' field inside of each EncryptionInfo` is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.

expireTime?: Date

[src]

Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

readonly maxExpireTime?: Date

[src]

Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup.max_expire_time.

name?: string

[src]

Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects//instances//backups/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects//instances/.

readonly referencingBackups?: string[]

[src]

Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects//instances//backups/. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.

readonly referencingDatabases?: string[]

[src]

Output only. The names of the restored databases that reference the backup. The database names are of the form projects//instances//databases/. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

readonly sizeBytes?: bigint

[src]

Output only. Size of the backup in bytes.

readonly state?: "STATE_UNSPECIFIED" | "CREATING" | "READY"

[src]

Output only. The current state of the backup.

versionTime?: Date

[src]

The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.