Class Backup (0.1.1)

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

Message describing Backup object

Attributes
Name	Description
`name`	`str` 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}
`display_name`	`str` User-settable and human-readable display name for the Backup.
`uid`	`str` 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.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Create time stamp
`update_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Update time stamp
`delete_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Delete time stamp
`labels`	`MutableMapping[str, str]` Labels as key value pairs
`state`	`google.cloud.alloydb_v1.types.Backup.State` Output only. The current state of the backup.
`type_`	`google.cloud.alloydb_v1.types.Backup.Type` The backup type, which suggests the trigger for the backup.
`description`	`str` User-provided description of the backup.
`cluster_uid`	`str` Output only. The system-generated UID of the cluster which was used to create this resource.
`cluster_name`	`str` Required. The full resource name of the backup source cluster (e.g., projects//locations//clusters/
`reconciling`	`bool` 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.
`encryption_config`	`google.cloud.alloydb_v1.types.EncryptionConfig` 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.
`encryption_info`	`google.cloud.alloydb_v1.types.EncryptionInfo` Output only. The encryption information for the backup.
`etag`	`str` For Resource freshness validation (https://google.aip.dev/154)
`annotations`	`MutableMapping[str, str]` Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
`size_bytes`	`int` Output only. The size of the backup in bytes.
`expiry_time`	`google.protobuf.timestamp_pb2.Timestamp` 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.

Classes

AnnotationsEntry

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

The abstract base class for a message.

Parameters
Name	Description
`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.

LabelsEntry

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

The abstract base class for a message.

Parameters
Name	Description
`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.

State

State(value)

Backup State

Values: STATE_UNSPECIFIED (0): The state of the backup is unknown. READY (1): The backup is ready. CREATING (2): The backup is creating. FAILED (3): The backup failed. DELETING (4): The backup is being deleted.

Type

Type(value)

Backup Type

Values: TYPE_UNSPECIFIED (0): Backup Type is unknown. ON_DEMAND (1): ON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED). AUTOMATED (2): AUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy. CONTINUOUS (3): CONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.