Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class 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.
Generated from protobuf message google.cloud.gkebackup.v1.VolumeBackup
Namespace
Google \ Cloud \ GkeBackup \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*
.
↳ uid
↳ create_time
↳ update_time
Google\Protobuf\Timestamp
Output only. The timestamp when this VolumeBackup resource was last updated.
↳ source_pvc
Google\Cloud\GkeBackup\V1\NamespacedName
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.
↳ volume_backup_handle
string
Output only. A storage system-specific opaque handle to the underlying volume backup.
↳ format
int
Output only. The format used for the volume backup.
↳ storage_bytes
int|string
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.
↳ disk_size_bytes
int|string
Output only. The minimum size of the disk to which this VolumeBackup can be restored.
↳ complete_time
Google\Protobuf\Timestamp
Output only. The timestamp when the associated underlying volume backup operation completed.
↳ state
int
Output only. The current state of this VolumeBackup.
↳ state_message
string
Output only. A human readable message explaining why the VolumeBackup is in its current state.
↳ etag
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.
getName
Output only. The full name of the VolumeBackup resource.
Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*
.
string
setName
Output only. The full name of the VolumeBackup resource.
Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*
.
var
string
$this
getUid
Output only. Server generated global unique identifier of UUID format.
string
setUid
Output only. Server generated global unique identifier of UUID format.
var
string
$this
getCreateTime
Output only. The timestamp when this VolumeBackup resource was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when this VolumeBackup resource was created.
$this
getUpdateTime
Output only. The timestamp when this VolumeBackup resource was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when this VolumeBackup resource was last updated.
$this
getSourcePvc
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.
hasSourcePvc
clearSourcePvc
setSourcePvc
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.
$this
getVolumeBackupHandle
Output only. A storage system-specific opaque handle to the underlying volume backup.
string
setVolumeBackupHandle
Output only. A storage system-specific opaque handle to the underlying volume backup.
var
string
$this
getFormat
Output only. The format used for the volume backup.
int
setFormat
Output only. The format used for the volume backup.
var
int
$this
getStorageBytes
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.
int|string
setStorageBytes
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.
var
int|string
$this
getDiskSizeBytes
Output only. The minimum size of the disk to which this VolumeBackup can be restored.
int|string
setDiskSizeBytes
Output only. The minimum size of the disk to which this VolumeBackup can be restored.
var
int|string
$this
getCompleteTime
Output only. The timestamp when the associated underlying volume backup operation completed.
hasCompleteTime
clearCompleteTime
setCompleteTime
Output only. The timestamp when the associated underlying volume backup operation completed.
$this
getState
Output only. The current state of this VolumeBackup.
int
setState
Output only. The current state of this VolumeBackup.
var
int
$this
getStateMessage
Output only. A human readable message explaining why the VolumeBackup is in its current state.
string
setStateMessage
Output only. A human readable message explaining why the VolumeBackup is in its current state.
var
string
$this
getEtag
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.
string
setEtag
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.
var
string
$this