BackupArgs class

The set of arguments for Backup. The set of arguments for Backup.

Constructors

BackupArgs({required Input<String> backupId, Input<String>? database, required Input<String> encryptionConfigEncryptionType, Input<String>? encryptionConfigKmsKeyName, Input<String>? expireTime, required Input<String> instanceId, Input<String>? name, Input<String>? project, Input<String>? versionTime})

Creates a new BackupArgs. backupId 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/. database 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/. encryptionConfigEncryptionType Required. The encryption type of the backup. encryptionConfigKmsKeyName 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/. expireTime 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. instanceId Required. name 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/. project Optional. versionTime 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.

const

BackupArgs.fromMap(Map<String, dynamic> map)

factory

Properties

backupId → Input<String>

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

final

database → Input<String>?

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

final

encryptionConfigEncryptionType → Input<String>

Required. The encryption type of the backup.

final

encryptionConfigKmsKeyName → Input<String>?

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

final

expireTime → Input<String>?

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.

final

hashCode → int

The hash code for this object.

no setter, inherited

instanceId → Input<String>

final

name → Input<String>?

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

final

project → Input<String>?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

versionTime → Input<String>?

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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited