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.
Next id: 14
Generated from protobuf message google.cloud.gkebackup.v1.VolumeBackup
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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 |
string
Output only. Server generated global unique identifier of UUID format. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when this VolumeBackup resource was created. |
↳ 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. |
getName
Output only. The full name of the VolumeBackup resource.
Format: projects//locations//backupPlans//backups//volumeBackups/*.
Returns | |
---|---|
Type | Description |
string |
setName
Output only. The full name of the VolumeBackup resource.
Format: projects//locations//backupPlans//backups//volumeBackups/*.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getUid
Output only. Server generated global unique identifier of UUID format.
Returns | |
---|---|
Type | Description |
string |
setUid
Output only. Server generated global unique identifier of UUID format.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
Output only. The timestamp when this VolumeBackup resource was created.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when this VolumeBackup resource was created.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateTime
Output only. The timestamp when this VolumeBackup resource was last updated.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when this VolumeBackup resource was last updated.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getSourcePvc
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.
Returns | |
---|---|
Type | Description |
Google\Cloud\GkeBackup\V1\NamespacedName|null |
hasSourcePvc
clearSourcePvc
setSourcePvc
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\GkeBackup\V1\NamespacedName
|
Returns | |
---|---|
Type | Description |
$this |
getVolumeBackupHandle
Output only. A storage system-specific opaque handle to the underlying volume backup.
Returns | |
---|---|
Type | Description |
string |
setVolumeBackupHandle
Output only. A storage system-specific opaque handle to the underlying volume backup.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFormat
Output only. The format used for the volume backup.
Returns | |
---|---|
Type | Description |
int |
setFormat
Output only. The format used for the volume backup.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getDiskSizeBytes
Output only. The minimum size of the disk to which this VolumeBackup can be restored.
Returns | |
---|---|
Type | Description |
int|string |
setDiskSizeBytes
Output only. The minimum size of the disk to which this VolumeBackup can be restored.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getCompleteTime
Output only. The timestamp when the associated underlying volume backup operation completed.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCompleteTime
clearCompleteTime
setCompleteTime
Output only. The timestamp when the associated underlying volume backup operation completed.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getState
Output only. The current state of this VolumeBackup.
Returns | |
---|---|
Type | Description |
int |
setState
Output only. The current state of this VolumeBackup.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getStateMessage
Output only. A human readable message explaining why the VolumeBackup is in its current state.
Returns | |
---|---|
Type | Description |
string |
setStateMessage
Output only. A human readable message explaining why the VolumeBackup is in its current state.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |