AlloyDB v1 API - Class AutomatedBackupPolicy (1.4.0)

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

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

Message describing the user-specified automated backup policy.

All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.

Inheritance

object > AutomatedBackupPolicy

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

AutomatedBackupPolicy()

public AutomatedBackupPolicy()

AutomatedBackupPolicy(AutomatedBackupPolicy)

public AutomatedBackupPolicy(AutomatedBackupPolicy other)
Parameter
NameDescription
otherAutomatedBackupPolicy

Properties

BackupWindow

public Duration BackupWindow { get; set; }

The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.

The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

Property Value
TypeDescription
Duration

Enabled

public bool Enabled { get; set; }

Whether automated automated backups are enabled. If not set, defaults to true.

Property Value
TypeDescription
bool

EncryptionConfig

public EncryptionConfig EncryptionConfig { get; set; }

Optional. The encryption config can be specified to encrypt the backups 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
TypeDescription
EncryptionConfig

HasEnabled

public bool HasEnabled { get; }

Gets whether the "enabled" field is set

Property Value
TypeDescription
bool

Labels

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

Labels to apply to backups created using this configuration.

Property Value
TypeDescription
MapFieldstringstring

Location

public string Location { get; set; }

The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.

If empty, defaults to the region of the cluster.

Property Value
TypeDescription
string

QuantityBasedRetention

public AutomatedBackupPolicy.Types.QuantityBasedRetention QuantityBasedRetention { get; set; }

Quantity-based Backup retention policy to retain recent backups.

Property Value
TypeDescription
AutomatedBackupPolicyTypesQuantityBasedRetention

RetentionCase

public AutomatedBackupPolicy.RetentionOneofCase RetentionCase { get; }
Property Value
TypeDescription
AutomatedBackupPolicyRetentionOneofCase

ScheduleCase

public AutomatedBackupPolicy.ScheduleOneofCase ScheduleCase { get; }
Property Value
TypeDescription
AutomatedBackupPolicyScheduleOneofCase

TimeBasedRetention

public AutomatedBackupPolicy.Types.TimeBasedRetention TimeBasedRetention { get; set; }

Time-based Backup retention policy.

Property Value
TypeDescription
AutomatedBackupPolicyTypesTimeBasedRetention

WeeklySchedule

public AutomatedBackupPolicy.Types.WeeklySchedule WeeklySchedule { get; set; }

Weekly schedule for the Backup.

Property Value
TypeDescription
AutomatedBackupPolicyTypesWeeklySchedule