Backup and DR Service v1 API - Class BackupVault (2.0.0)

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

Reference documentation and code samples for the Backup and DR Service v1 API class BackupVault.

Message describing a BackupVault object.

Inheritance

object > BackupVault

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

BackupVault()

public BackupVault()

BackupVault(BackupVault)

public BackupVault(BackupVault other)
Parameter
Name Description
other BackupVault

Properties

AccessRestriction

public BackupVault.Types.AccessRestriction AccessRestriction { get; set; }

Optional. Note: This field is added for future use case and will not be supported in the current release.

Optional.

Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.

Property Value
Type Description
BackupVaultTypesAccessRestriction

Annotations

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

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

Property Value
Type Description
MapFieldstringstring

BackupCount

public long BackupCount { get; set; }

Output only. The number of backups in this backup vault.

Property Value
Type Description
long

BackupMinimumEnforcedRetentionDuration

public Duration BackupMinimumEnforcedRetentionDuration { get; set; }

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

Property Value
Type Description
Duration

BackupVaultName

public BackupVaultName BackupVaultName { get; set; }

BackupVaultName-typed view over the Name resource name property.

Property Value
Type Description
BackupVaultName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time when the instance was created.

Property Value
Type Description
Timestamp

Deletable

public bool Deletable { get; set; }

Output only. Set to true when there are no backups nested under this resource.

Property Value
Type Description
bool

Description

public string Description { get; set; }

Optional. The description of the BackupVault instance (2048 characters or less).

Property Value
Type Description
string

EffectiveTime

public Timestamp EffectiveTime { get; set; }

Optional. Time after which the BackupVault resource is locked.

Property Value
Type Description
Timestamp

Etag

public string Etag { get; set; }

Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

Property Value
Type Description
string

HasDeletable

public bool HasDeletable { get; }

Gets whether the "deletable" field is set

Property Value
Type Description
bool

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type Description
bool

HasEtag

public bool HasEtag { get; }

Gets whether the "etag" field is set

Property Value
Type Description
bool

Labels

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

Optional. Resource labels to represent user provided metadata. No labels currently defined:

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Output only. Identifier. Name of the backup vault to create. It must have the format"projects/{project}/locations/{location}/backupVaults/{backupvault}". {backupvault} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.

Property Value
Type Description
string

ServiceAccount

public string ServiceAccount { get; set; }

Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.

Property Value
Type Description
string

State

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

Output only. The BackupVault resource instance state.

Property Value
Type Description
BackupVaultTypesState

TotalStoredBytes

public long TotalStoredBytes { get; set; }

Output only. Total size of the storage used by all backup resources.

Property Value
Type Description
long

Uid

public string Uid { get; set; }

Output only. Output only Immutable after resource creation until resource deletion.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The time when the instance was updated.

Property Value
Type Description
Timestamp