Backup and DR Service V1 API - Class Google::Cloud::BackupDR::V1::BackupVault (v1.11.2)

Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::BackupVault.

Message describing a BackupVault object.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#access_restriction

def access_restriction() -> ::Google::Cloud::BackupDR::V1::BackupVault::AccessRestriction
Returns

#access_restriction=

def access_restriction=(value) -> ::Google::Cloud::BackupDR::V1::BackupVault::AccessRestriction
Parameter
Returns

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

#backup_count

def backup_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of backups in this backup vault.

#backup_minimum_enforced_retention_duration

def backup_minimum_enforced_retention_duration() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

#backup_minimum_enforced_retention_duration=

def backup_minimum_enforced_retention_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
Returns
  • (::Google::Protobuf::Duration) — Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

#backup_retention_inheritance

def backup_retention_inheritance() -> ::Google::Cloud::BackupDR::V1::BackupVault::BackupRetentionInheritance
Returns

#backup_retention_inheritance=

def backup_retention_inheritance=(value) -> ::Google::Cloud::BackupDR::V1::BackupVault::BackupRetentionInheritance
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#deletable

def deletable() -> ::Boolean
Returns
  • (::Boolean) — Output only. Set to true when there are no backups nested under this resource.

#description

def description() -> ::String
Returns
  • (::String) — Optional. The description of the BackupVault instance (2048 characters or less).

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The description of the BackupVault instance (2048 characters or less).
Returns
  • (::String) — Optional. The description of the BackupVault instance (2048 characters or less).

#effective_time

def effective_time() -> ::Google::Protobuf::Timestamp
Returns

#effective_time=

def effective_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#encryption_config

def encryption_config() -> ::Google::Cloud::BackupDR::V1::BackupVault::EncryptionConfig
Returns

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::BackupDR::V1::BackupVault::EncryptionConfig
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
Returns
  • (::String) — Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels to represent user provided metadata. No labels currently defined:

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels to represent user provided metadata. No labels currently defined:
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Resource labels to represent user provided metadata. No labels currently defined:

#name

def name() -> ::String
Returns
  • (::String) — Output only. Identifier. Name of the backup vault to create. It must have the format"projects/{project}/locations/{location}/backupVaults/{backupvault}". {backupvault} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.

#service_account

def service_account() -> ::String
Returns
  • (::String) — Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.

#state

def state() -> ::Google::Cloud::BackupDR::V1::BackupVault::State
Returns

#total_stored_bytes

def total_stored_bytes() -> ::Integer
Returns
  • (::Integer) — Output only. Total size of the storage used by all backup resources.

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Immutable after resource creation until resource deletion.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns