BackupArgs

data class BackupArgs(val backupId: Output<String>? = null, val database: Output<String>? = null, val encryptionConfigEncryptionType: Output<String>? = null, val encryptionConfigKmsKeyName: Output<String>? = null, val expireTime: Output<String>? = null, val instanceId: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val versionTime: Output<String>? = null) : ConvertibleToJava<BackupArgs>

Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Constructors

Link copied to clipboard
constructor(backupId: Output<String>? = null, database: Output<String>? = null, encryptionConfigEncryptionType: Output<String>? = null, encryptionConfigKmsKeyName: Output<String>? = null, expireTime: Output<String>? = null, instanceId: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, versionTime: Output<String>? = null)

Properties

Link copied to clipboard
val backupId: Output<String>? = null

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects//instances//backups/.

Link copied to clipboard
val database: Output<String>? = null

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/.

Link copied to clipboard

Required. The encryption type of the backup.

Link copied to clipboard
val encryptionConfigKmsKeyName: Output<String>? = null

Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects//locations//keyRings//cryptoKeys/.

Link copied to clipboard
val expireTime: Output<String>? = null

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.

Link copied to clipboard
val instanceId: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

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/.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val versionTime: Output<String>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): BackupArgs