public sealed class VolumeBackup : IMessage<VolumeBackup>, IEquatable<VolumeBackup>, IDeepCloneable<VolumeBackup>, IBufferMessage, IMessage
Reference documentation and code samples for the Backup for GKE v1 API 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.
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.
Output only. A human readable message explaining why the VolumeBackup is in
its current state. This field is only meant for human consumption and
should not be used programmatically as this field is not guaranteed to be
consistent.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis page provides reference documentation for the \u003ccode\u003eVolumeBackup\u003c/code\u003e class within the Google Cloud GKE Backup v1 API, detailing its properties, methods, and usage within the .NET environment.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eVolumeBackup\u003c/code\u003e represents a backup of a persistent volume, including operation records and storage artifacts, with the latest version being 2.6.0 and several previous versions available.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, offering functionalities for message handling, comparison, and deep cloning.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eVolumeBackup\u003c/code\u003e include \u003ccode\u003eCreateTime\u003c/code\u003e, \u003ccode\u003eCompleteTime\u003c/code\u003e, \u003ccode\u003eDiskSizeBytes\u003c/code\u003e, \u003ccode\u003eState\u003c/code\u003e, \u003ccode\u003eStorageBytes\u003c/code\u003e and \u003ccode\u003eName\u003c/code\u003e, which provide information about the backup's creation, completion status, size, and resource name.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eVolumeBackup\u003c/code\u003e class provides methods to interact with the backup operations and storage details through specific properties like \u003ccode\u003eVolumeBackupHandle\u003c/code\u003e and \u003ccode\u003eSourcePvc\u003c/code\u003e as well as having an option to call its resource name property by using \u003ccode\u003eVolumeBackupName\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Backup for GKE v1 API - Class VolumeBackup (2.8.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.8.0 (latest)](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.7.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.6.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.5.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.4.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.3.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.2.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.1.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.0.0/Google.Cloud.GkeBackup.V1.VolumeBackup)\n- [1.0.0-beta01](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/1.0.0-beta01/Google.Cloud.GkeBackup.V1.VolumeBackup) \n\n public sealed class VolumeBackup : IMessage\u003cVolumeBackup\u003e, IEquatable\u003cVolumeBackup\u003e, IDeepCloneable\u003cVolumeBackup\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Backup for GKE v1 API class VolumeBackup.\n\nRepresents the backup of a specific persistent volume as a component of a\nBackup - both the record of the operation and a pointer to the underlying\nstorage-specific artifacts. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e VolumeBackup \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[VolumeBackup](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.VolumeBackup), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[VolumeBackup](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.VolumeBackup), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[VolumeBackup](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.VolumeBackup), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.GkeBackup.V1](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.GkeBackup.V1.dll\n\nConstructors\n------------\n\n### VolumeBackup()\n\n public VolumeBackup()\n\n### VolumeBackup(VolumeBackup)\n\n public VolumeBackup(VolumeBackup other)\n\nProperties\n----------\n\n### CompleteTime\n\n public Timestamp CompleteTime { get; set; }\n\nOutput only. The timestamp when the associated underlying volume backup\noperation completed.\n\n### CreateTime\n\n public Timestamp CreateTime { get; set; }\n\nOutput only. The timestamp when this VolumeBackup resource was\ncreated.\n\n### DiskSizeBytes\n\n public long DiskSizeBytes { get; set; }\n\nOutput only. The minimum size of the disk to which this VolumeBackup can be\nrestored.\n\n### Etag\n\n public string Etag { get; set; }\n\nOutput only. `etag` is used for optimistic concurrency control as a way to\nhelp prevent simultaneous updates of a volume backup from overwriting each\nother. It is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform volume backup updates in order to avoid\nrace conditions.\n\n### Format\n\n public VolumeBackup.Types.VolumeBackupFormat Format { get; set; }\n\nOutput only. The format used for the volume backup.\n\n### Name\n\n public string Name { get; set; }\n\nOutput only. The full name of the VolumeBackup resource.\nFormat: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.\n\n### SatisfiesPzi\n\n public bool SatisfiesPzi { get; set; }\n\nOutput only. \\[Output Only\\] Reserved for future use.\n\n### SatisfiesPzs\n\n public bool SatisfiesPzs { get; set; }\n\nOutput only. \\[Output Only\\] Reserved for future use.\n\n### SourcePvc\n\n public NamespacedName SourcePvc { get; set; }\n\nOutput only. A reference to the source Kubernetes PVC from which this\nVolumeBackup was created.\n\n### State\n\n public VolumeBackup.Types.State State { get; set; }\n\nOutput only. The current state of this VolumeBackup.\n\n### StateMessage\n\n public string StateMessage { get; set; }\n\nOutput only. A human readable message explaining why the VolumeBackup is in\nits current state. This field is only meant for human consumption and\nshould not be used programmatically as this field is not guaranteed to be\nconsistent.\n\n### StorageBytes\n\n public long StorageBytes { get; set; }\n\nOutput only. The aggregate size of the underlying artifacts associated with\nthis VolumeBackup in the backup storage. This may change over time when\nmultiple backups of the same volume share the same backup storage\nlocation. In particular, this is likely to increase in size when\nthe immediately preceding backup of the same volume is deleted.\n\n### Uid\n\n public string Uid { get; set; }\n\nOutput only. Server generated global unique identifier of\n[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.\n\n### UpdateTime\n\n public Timestamp UpdateTime { get; set; }\n\nOutput only. The timestamp when this VolumeBackup resource was last\nupdated.\n\n### VolumeBackupHandle\n\n public string VolumeBackupHandle { get; set; }\n\nOutput only. A storage system-specific opaque handle to the underlying\nvolume backup.\n\n### VolumeBackupName\n\n public VolumeBackupName VolumeBackupName { get; set; }\n\n[VolumeBackupName](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.VolumeBackupName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.VolumeBackup#Google_Cloud_GkeBackup_V1_VolumeBackup_Name) resource name property."]]
