Interface VolumeBackupOrBuilder (0.45.0)

public interface VolumeBackupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCompleteTime()

public abstract 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 abstract 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];

Returns
Type Description
TimestampOrBuilder

getCreateTime()

public abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

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
TimestampOrBuilder

getDiskSizeBytes()

public abstract 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()

public abstract String 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 abstract 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.

getFormat()

public abstract 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];

Returns
Type Description
VolumeBackup.VolumeBackupFormat

The format.

getFormatValue()

public abstract 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()

public abstract String 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 abstract 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.

getSourcePvc()

public abstract 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];

Returns
Type Description
NamespacedName

The sourcePvc.

getSourcePvcOrBuilder()

public abstract 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];

Returns
Type Description
NamespacedNameOrBuilder

getState()

public abstract 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];

Returns
Type Description
VolumeBackup.State

The state.

getStateMessage()

public abstract 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 abstract 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 abstract 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 abstract 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()

public abstract String 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 abstract 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.

getUpdateTime()

public abstract 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 abstract 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];

Returns
Type Description
TimestampOrBuilder

getVolumeBackupHandle()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.