AlloyDB v1 API - Class Backup (1.9.0) 

public sealed class Backup : IMessage<Backup>, IEquatable<Backup>, IDeepCloneable<Backup>, IBufferMessage, IMessage

Reference documentation and code samples for the AlloyDB v1 API class Backup.

Message describing Backup object

Inheritance

object > Backup

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

Backup()

public Backup()

Backup(Backup)

public Backup(Backup other)
Parameter
Name Description
other Backup

Properties

Annotations

public MapField<string, string> Annotations { get; }

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

Property Value
Type Description
MapFieldstringstring

BackupName

public BackupName BackupName { get; set; }

BackupName-typed view over the Name resource name property.

Property Value
Type Description
BackupName

ClusterName

public string ClusterName { get; set; }

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

Property Value
Type Description
string

ClusterNameAsClusterName

public ClusterName ClusterNameAsClusterName { get; set; }

ClusterName-typed view over the ClusterName resource name property.

Property Value
Type Description
ClusterName

ClusterUid

public string ClusterUid { get; set; }

Output only. The system-generated UID of the cluster which was used to create this resource.

Property Value
Type Description
string

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Create time stamp

Property Value
Type Description
Timestamp

DatabaseVersion

public DatabaseVersion DatabaseVersion { get; set; }

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

Property Value
Type Description
DatabaseVersion

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. Delete time stamp

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

User-provided description of the backup.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

User-settable and human-readable display name for the Backup.

Property Value
Type Description
string

EncryptionConfig

public EncryptionConfig EncryptionConfig { get; set; }

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

Property Value
Type Description
EncryptionConfig

EncryptionInfo

public EncryptionInfo EncryptionInfo { get; set; }

Output only. The encryption information for the backup.

Property Value
Type Description
EncryptionInfo

Etag

public string Etag { get; set; }

For Resource freshness validation (https://google.aip.dev/154)

Property Value
Type Description
string

ExpiryQuantity

public Backup.Types.QuantityBasedExpiry ExpiryQuantity { get; set; }

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

Property Value
Type Description
BackupTypesQuantityBasedExpiry

ExpiryTime

public Timestamp ExpiryTime { get; set; }

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

Property Value
Type Description
Timestamp

Labels

public MapField<string, string> Labels { get; }

Labels as key value pairs

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Output only. The name of the backup resource with the format:

  • projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource:
  • projects/{project}/locations/{region}
Property Value
Type Description
string

Reconciling

public bool Reconciling { get; set; }

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

Property Value
Type Description
bool

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

SizeBytes

public long SizeBytes { get; set; }

Output only. The size of the backup in bytes.

Property Value
Type Description
long

State

public Backup.Types.State State { get; set; }

Output only. The current state of the backup.

Property Value
Type Description
BackupTypesState

Tags

public MapField<string, string> Tags { get; }

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:

"123/environment": "production",
"123/costCenter": "marketing"
Property Value
Type Description
MapFieldstringstring

Type

public Backup.Types.Type Type { get; set; }

The backup type, which suggests the trigger for the backup.

Property Value
Type Description
BackupTypesType

Uid

public string Uid { get; set; }

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Update time stamp

Property Value
Type Description
Timestamp