Reference documentation and code samples for the AlloyDB V1BETA API class Google::Cloud::AlloyDB::V1beta::Backup.
Message describing Backup object
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
#cluster_name
def cluster_name() -> ::String
Returns
- (::String) — Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
#cluster_name=
def cluster_name=(value) -> ::String
Parameter
- value (::String) — Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
Returns
- (::String) — Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
#cluster_uid
def cluster_uid() -> ::String
Returns
- (::String) — Output only. The system-generated UID of the cluster which was used to create this resource.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Create time stamp
#database_version
def database_version() -> ::Google::Cloud::AlloyDB::V1beta::DatabaseVersion
Returns
- (::Google::Cloud::AlloyDB::V1beta::DatabaseVersion) — Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
#delete_time
def delete_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Delete time stamp
#description
def description() -> ::String
Returns
- (::String) — User-provided description of the backup.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — User-provided description of the backup.
Returns
- (::String) — User-provided description of the backup.
#display_name
def display_name() -> ::String
Returns
- (::String) — User-settable and human-readable display name for the Backup.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — User-settable and human-readable display name for the Backup.
Returns
- (::String) — User-settable and human-readable display name for the Backup.
#encryption_config
def encryption_config() -> ::Google::Cloud::AlloyDB::V1beta::EncryptionConfig
Returns
- (::Google::Cloud::AlloyDB::V1beta::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_config=
def encryption_config=(value) -> ::Google::Cloud::AlloyDB::V1beta::EncryptionConfig
Parameter
- value (::Google::Cloud::AlloyDB::V1beta::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.
Returns
- (::Google::Cloud::AlloyDB::V1beta::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
def encryption_info() -> ::Google::Cloud::AlloyDB::V1beta::EncryptionInfo
Returns
- (::Google::Cloud::AlloyDB::V1beta::EncryptionInfo) — Output only. The encryption information for the backup.
#etag
def etag() -> ::String
Returns
- (::String) — For Resource freshness validation (https://google.aip.dev/154)
#etag=
def etag=(value) -> ::String
Parameter
- value (::String) — For Resource freshness validation (https://google.aip.dev/154)
Returns
- (::String) — For Resource freshness validation (https://google.aip.dev/154)
#expiry_quantity
def expiry_quantity() -> ::Google::Cloud::AlloyDB::V1beta::Backup::QuantityBasedExpiry
Returns
- (::Google::Cloud::AlloyDB::V1beta::Backup::QuantityBasedExpiry) — Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
#expiry_time
def expiry_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
#name
def name() -> ::String
Returns
-
(::String) —
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}
- projects/{project}/locations/{region}/backups/{backup_id}
where the cluster and backup ID segments should satisfy the regex
expression
#reconciling
def reconciling() -> ::Boolean
Returns
- (::Boolean) — 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.
#size_bytes
def size_bytes() -> ::Integer
Returns
- (::Integer) — Output only. The size of the backup in bytes.
#state
def state() -> ::Google::Cloud::AlloyDB::V1beta::Backup::State
Returns
- (::Google::Cloud::AlloyDB::V1beta::Backup::State) — Output only. The current state of the backup.
#type
def type() -> ::Google::Cloud::AlloyDB::V1beta::Backup::Type
Returns
- (::Google::Cloud::AlloyDB::V1beta::Backup::Type) — The backup type, which suggests the trigger for the backup.
#type=
def type=(value) -> ::Google::Cloud::AlloyDB::V1beta::Backup::Type
Parameter
- value (::Google::Cloud::AlloyDB::V1beta::Backup::Type) — The backup type, which suggests the trigger for the backup.
Returns
- (::Google::Cloud::AlloyDB::V1beta::Backup::Type) — The backup type, which suggests the trigger for the backup.
#uid
def uid() -> ::String
Returns
- (::String) — 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Update time stamp