Google Cloud Bigtable Administration v2 API - Class Table.Types.AutomatedBackupPolicy (3.36.0)

public sealed class Table.Types.AutomatedBackupPolicy : IMessage<Table.Types.AutomatedBackupPolicy>, IEquatable<Table.Types.AutomatedBackupPolicy>, IDeepCloneable<Table.Types.AutomatedBackupPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class Table.Types.AutomatedBackupPolicy.

Defines an automated backup policy for a table

Inheritance

object > Table.Types.AutomatedBackupPolicy

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

AutomatedBackupPolicy()

public AutomatedBackupPolicy()

AutomatedBackupPolicy(AutomatedBackupPolicy)

public AutomatedBackupPolicy(Table.Types.AutomatedBackupPolicy other)
Parameter
Name Description
other TableTypesAutomatedBackupPolicy

Properties

Disabled

public bool Disabled { get; set; }

Optional. If true, automated backups are explicitly disabled on this table. This allows users to opt out of default enablement.

Property Value
Type Description
bool

Frequency

public Duration Frequency { get; set; }

How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.

Property Value
Type Description
Duration

KeepHotDuration

public Duration KeepHotDuration { get; set; }

Optional. The amount of time that the automated backups remain hot. If specified, the backups created by this policy are HOT backups. If not specified, the backups are STANDARD backups.

The value must be at least 24 hours and at most 10 days, and can't exceed the policy's retention_period.

Only SSD instances support HOT automated backups.

Property Value
Type Description
Duration

Locations

public RepeatedField<string> Locations { get; }

Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format projects/{project}/locations/{zone}. This field can only set for tables in Enterprise Plus instances.

Property Value
Type Description
RepeatedFieldstring

LocationsAsLocationNames

public ResourceNameList<LocationName> LocationsAsLocationNames { get; }

LocationName-typed view over the Locations resource name property.

Property Value
Type Description
ResourceNameListLocationName

RetentionPeriod

public Duration RetentionPeriod { get; set; }

Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.

Property Value
Type Description
Duration