Class AutomatedBackupPolicy (0.3.2)

AutomatedBackupPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof:


Weekly schedule for the Backup. This field is a member of oneof_ schedule.
Time-based Backup retention policy. This field is a member of oneof_ retention.
Quantity-based Backup retention policy to retain recent backups. This field is a member of oneof_ retention.
enabled bool
Whether automated automated backups are enabled. If not set, defaults to true. This field is a member of oneof_ _enabled.
backup_window google.protobuf.duration_pb2.Duration
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.
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.
location str
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.
labels MutableMapping[str, str]
Labels to apply to backups created using this configuration.



LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.


QuantityBasedRetention(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A quantity based policy specifies that a certain number of the most recent successful backups should be retained.


TimeBasedRetention(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A time based retention policy specifies that all backups within a certain time period should be retained.


WeeklySchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.

The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the start_times field to have one element "22:00" and the days_of_week field to have all seven days of the week.