Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class State.
The current state of a VolumeBackup
Protobuf type google.cloud.gkebackup.v1.VolumeBackup.State
Namespace
Google \ Cloud \ GkeBackup \ V1 \ VolumeBackup
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
STATE_UNSPECIFIED
Value: 0
This is an illegal state and should not be encountered.
Generated from protobuf enum STATE_UNSPECIFIED = 0;
CREATING
Value: 1
A volume for the backup was identified and backup process is about to
start.
Generated from protobuf enum CREATING = 1;
SNAPSHOTTING
Value: 2
The volume backup operation has begun and is in the initial "snapshot"
phase of the process. Any defined ProtectedApplication "pre" hooks will
be executed before entering this state and "post" hooks will be executed
upon leaving this state.
Generated from protobuf enum SNAPSHOTTING = 2;
UPLOADING
Value: 3
The snapshot phase of the volume backup operation has completed and
the snapshot is now being uploaded to backup storage.
Generated from protobuf enum UPLOADING = 3;
SUCCEEDED
Value: 4
The volume backup operation has completed successfully.
Generated from protobuf enum SUCCEEDED = 4;
FAILED
Value: 5
The volume backup operation has failed.
Generated from protobuf enum FAILED = 5;
DELETING
Value: 6
This VolumeBackup resource (and its associated artifacts) is in the
process of being deleted.
Generated from protobuf enum DELETING = 6;
CLEANED_UP
Value: 7
The underlying artifacts of a volume backup (eg: persistent disk
snapshots) are deleted.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Gke Backup V1 Client - Class State (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-gke-backup/latest/V1.VolumeBackup.State)\n- [1.2.0](/php/docs/reference/cloud-gke-backup/1.2.0/V1.VolumeBackup.State)\n- [1.0.3](/php/docs/reference/cloud-gke-backup/1.0.3/V1.VolumeBackup.State)\n- [0.8.1](/php/docs/reference/cloud-gke-backup/0.8.1/V1.VolumeBackup.State)\n- [0.7.2](/php/docs/reference/cloud-gke-backup/0.7.2/V1.VolumeBackup.State)\n- [0.6.0](/php/docs/reference/cloud-gke-backup/0.6.0/V1.VolumeBackup.State)\n- [0.5.3](/php/docs/reference/cloud-gke-backup/0.5.3/V1.VolumeBackup.State)\n- [0.4.0](/php/docs/reference/cloud-gke-backup/0.4.0/V1.VolumeBackup.State)\n- [0.3.1](/php/docs/reference/cloud-gke-backup/0.3.1/V1.VolumeBackup.State)\n- [0.2.0](/php/docs/reference/cloud-gke-backup/0.2.0/V1.VolumeBackup.State)\n- [0.1.7](/php/docs/reference/cloud-gke-backup/0.1.7/V1.VolumeBackup.State) \nReference documentation and code samples for the Google Cloud Gke Backup V1 Client class State.\n\nThe current state of a VolumeBackup\n\nProtobuf type `google.cloud.gkebackup.v1.VolumeBackup.State`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeBackup \\\\ V1 \\\\ VolumeBackup\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### STATE_UNSPECIFIED\n\n Value: 0\n\nThis is an illegal state and should not be encountered.\n\nGenerated from protobuf enum `STATE_UNSPECIFIED = 0;`\n\n### CREATING\n\n Value: 1\n\nA volume for the backup was identified and backup process is about to\nstart.\n\nGenerated from protobuf enum `CREATING = 1;`\n\n### SNAPSHOTTING\n\n Value: 2\n\nThe volume backup operation has begun and is in the initial \"snapshot\"\nphase of the process. Any defined ProtectedApplication \"pre\" hooks will\nbe executed before entering this state and \"post\" hooks will be executed\nupon leaving this state.\n\nGenerated from protobuf enum `SNAPSHOTTING = 2;`\n\n### UPLOADING\n\n Value: 3\n\nThe snapshot phase of the volume backup operation has completed and\nthe snapshot is now being uploaded to backup storage.\n\nGenerated from protobuf enum `UPLOADING = 3;`\n\n### SUCCEEDED\n\n Value: 4\n\nThe volume backup operation has completed successfully.\n\nGenerated from protobuf enum `SUCCEEDED = 4;`\n\n### FAILED\n\n Value: 5\n\nThe volume backup operation has failed.\n\nGenerated from protobuf enum `FAILED = 5;`\n\n### DELETING\n\n Value: 6\n\nThis VolumeBackup resource (and its associated artifacts) is in the\nprocess of being deleted.\n\nGenerated from protobuf enum `DELETING = 6;`\n\n### CLEANED_UP\n\n Value: 7\n\nThe underlying artifacts of a volume backup (eg: persistent disk\nsnapshots) are deleted.\n\nGenerated from protobuf enum `CLEANED_UP = 7;`"]]
