Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::VolumeBackup (v0.11.0)

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::VolumeBackup.

Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#complete_time

def complete_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp when the associated underlying volume backup operation completed.

#create_time

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

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp when this VolumeBackup resource was created.

#disk_size_bytes

def disk_size_bytes() -> ::Integer

Returns

(::Integer) — Output only. The minimum size of the disk to which this VolumeBackup can be restored.

#etag

def etag() -> ::String

Returns

(::String) — Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions.

#format

def format() -> ::Google::Cloud::GkeBackup::V1::VolumeBackup::VolumeBackupFormat

Returns

(::Google::Cloud::GkeBackup::V1::VolumeBackup::VolumeBackupFormat) — Output only. The format used for the volume backup.

#name

def name() -> ::String

Returns

(::String) — Output only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.

#source_pvc

def source_pvc() -> ::Google::Cloud::GkeBackup::V1::NamespacedName

Returns

(::Google::Cloud::GkeBackup::V1::NamespacedName) — Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.

#state

def state() -> ::Google::Cloud::GkeBackup::V1::VolumeBackup::State

Returns

(::Google::Cloud::GkeBackup::V1::VolumeBackup::State) — Output only. The current state of this VolumeBackup.

#state_message

def state_message() -> ::String

Returns

(::String) — Output only. A human readable message explaining why the VolumeBackup is in its current state.

#storage_bytes

def storage_bytes() -> ::Integer

Returns

(::Integer) — Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted.

#uid

def uid() -> ::String

Returns

(::String) — Output only. Server generated global unique identifier of UUID format.

#update_time

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

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp when this VolumeBackup resource was last updated.

#volume_backup_handle

def volume_backup_handle() -> ::String

Returns

(::String) — Output only. A storage system-specific opaque handle to the underlying volume backup.