public final class VolumeBackup extends GeneratedMessageV3 implements VolumeBackupOrBuilder
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
Protobuf type google.cloud.gkebackup.v1.VolumeBackup
Static Fields
COMPLETE_TIME_FIELD_NUMBER
public static final int COMPLETE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISK_SIZE_BYTES_FIELD_NUMBER
public static final int DISK_SIZE_BYTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FORMAT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SOURCE_PVC_FIELD_NUMBER
public static final int SOURCE_PVC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_MESSAGE_FIELD_NUMBER
public static final int STATE_MESSAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STORAGE_BYTES_FIELD_NUMBER
public static final int STORAGE_BYTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VOLUME_BACKUP_HANDLE_FIELD_NUMBER
public static final int VOLUME_BACKUP_HANDLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static VolumeBackup getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static VolumeBackup.Builder newBuilder()
newBuilder(VolumeBackup prototype)
public static VolumeBackup.Builder newBuilder(VolumeBackup prototype)
public static VolumeBackup parseDelimitedFrom(InputStream input)
public static VolumeBackup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static VolumeBackup parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VolumeBackup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static VolumeBackup parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VolumeBackup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VolumeBackup parseFrom(CodedInputStream input)
public static VolumeBackup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VolumeBackup parseFrom(InputStream input)
public static VolumeBackup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static VolumeBackup parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VolumeBackup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<VolumeBackup> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCompleteTime()
public Timestamp getCompleteTime()
Output only. The timestamp when the associated underlying volume backup
operation completed.
.google.protobuf.Timestamp complete_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The completeTime.
|
getCompleteTimeOrBuilder()
public TimestampOrBuilder getCompleteTimeOrBuilder()
Output only. The timestamp when the associated underlying volume backup
operation completed.
.google.protobuf.Timestamp complete_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp when this VolumeBackup resource was
created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when this VolumeBackup resource was
created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public VolumeBackup getDefaultInstanceForType()
getDiskSizeBytes()
public long getDiskSizeBytes()
Output only. The minimum size of the disk to which this VolumeBackup can be restored.
int64 disk_size_bytes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
long | The diskSizeBytes.
|
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 etag = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
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 etag = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
public VolumeBackup.VolumeBackupFormat getFormat()
Output only. The format used for the volume backup.
.google.cloud.gkebackup.v1.VolumeBackup.VolumeBackupFormat format = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getFormatValue()
Output only. The format used for the volume backup.
.google.cloud.gkebackup.v1.VolumeBackup.VolumeBackupFormat format = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for format.
|
getName()
Output only. The full name of the VolumeBackup resource.
Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The full name of the VolumeBackup resource.
Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<VolumeBackup> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSourcePvc()
public NamespacedName getSourcePvc()
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup
was created.
.google.cloud.gkebackup.v1.NamespacedName source_pvc = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourcePvcOrBuilder()
public NamespacedNameOrBuilder getSourcePvcOrBuilder()
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup
was created.
.google.cloud.gkebackup.v1.NamespacedName source_pvc = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState()
public VolumeBackup.State getState()
Output only. The current state of this VolumeBackup.
.google.cloud.gkebackup.v1.VolumeBackup.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateMessage()
public String getStateMessage()
Output only. A human readable message explaining why the VolumeBackup is in its current
state.
string state_message = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The stateMessage.
|
getStateMessageBytes()
public ByteString getStateMessageBytes()
Output only. A human readable message explaining why the VolumeBackup is in its current
state.
string state_message = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for stateMessage.
|
getStateValue()
public int getStateValue()
Output only. The current state of this VolumeBackup.
.google.cloud.gkebackup.v1.VolumeBackup.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getStorageBytes()
public long 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.
int64 storage_bytes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
long | The storageBytes.
|
getUid()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp when this VolumeBackup resource was last
updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when this VolumeBackup resource was last
updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVolumeBackupHandle()
public String getVolumeBackupHandle()
Output only. A storage system-specific opaque handle to the underlying volume backup.
string volume_backup_handle = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The volumeBackupHandle.
|
getVolumeBackupHandleBytes()
public ByteString getVolumeBackupHandleBytes()
Output only. A storage system-specific opaque handle to the underlying volume backup.
string volume_backup_handle = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for volumeBackupHandle.
|
hasCompleteTime()
public boolean hasCompleteTime()
Output only. The timestamp when the associated underlying volume backup
operation completed.
.google.protobuf.Timestamp complete_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the completeTime field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp when this VolumeBackup resource was
created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasSourcePvc()
public boolean hasSourcePvc()
Output only. A reference to the source Kubernetes PVC from which this VolumeBackup
was created.
.google.cloud.gkebackup.v1.NamespacedName source_pvc = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the sourcePvc field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The timestamp when this VolumeBackup resource was last
updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public VolumeBackup.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VolumeBackup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public VolumeBackup.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
