Class VolumeRestore (0.45.0)

public final class VolumeRestore extends GeneratedMessageV3 implements VolumeRestoreOrBuilder

Represents the operation of restoring a volume from a VolumeBackup.

Protobuf type google.cloud.gkebackup.v1.VolumeRestore

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

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_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

TARGET_PVC_FIELD_NUMBER

public static final int TARGET_PVC_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_FIELD_NUMBER

public static final int VOLUME_BACKUP_FIELD_NUMBER
Field Value
Type Description
int

VOLUME_HANDLE_FIELD_NUMBER

public static final int VOLUME_HANDLE_FIELD_NUMBER
Field Value
Type Description
int

VOLUME_TYPE_FIELD_NUMBER

public static final int VOLUME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VolumeRestore getDefaultInstance()
Returns
Type Description
VolumeRestore

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static VolumeRestore.Builder newBuilder()
Returns
Type Description
VolumeRestore.Builder

newBuilder(VolumeRestore prototype)

public static VolumeRestore.Builder newBuilder(VolumeRestore prototype)
Parameter
Name Description
prototype VolumeRestore
Returns
Type Description
VolumeRestore.Builder

parseDelimitedFrom(InputStream input)

public static VolumeRestore parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VolumeRestore
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VolumeRestore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VolumeRestore
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VolumeRestore parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VolumeRestore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VolumeRestore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VolumeRestore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VolumeRestore parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VolumeRestore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VolumeRestore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VolumeRestore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VolumeRestore parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VolumeRestore
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VolumeRestore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VolumeRestore
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VolumeRestore parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VolumeRestore
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VolumeRestore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VolumeRestore
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VolumeRestore parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VolumeRestore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VolumeRestore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VolumeRestore
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VolumeRestore> parser()
Returns
Type Description
Parser<VolumeRestore>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCompleteTime()

public Timestamp getCompleteTime()

Output only. The timestamp when the associated underlying volume restoration completed.

.google.protobuf.Timestamp complete_time = 9 [(.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 restoration completed.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when this VolumeRestore 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 VolumeRestore resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public VolumeRestore getDefaultInstanceForType()
Returns
Type Description
VolumeRestore

getEtag()

public String getEtag()

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions.

string etag = 12 [(.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 restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

Output only. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<VolumeRestore> getParserForType()
Returns
Type Description
Parser<VolumeRestore>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public VolumeRestore.State getState()

Output only. The current state of this VolumeRestore.

.google.cloud.gkebackup.v1.VolumeRestore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
VolumeRestore.State

The state.

getStateMessage()

public String getStateMessage()

Output only. A human readable message explaining why the VolumeRestore is in its current state.

string state_message = 11 [(.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 VolumeRestore is in its current state.

string state_message = 11 [(.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 VolumeRestore.

.google.cloud.gkebackup.v1.VolumeRestore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTargetPvc()

public NamespacedName getTargetPvc()

Output only. The reference to the target Kubernetes PVC to be restored.

.google.cloud.gkebackup.v1.NamespacedName target_pvc = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NamespacedName

The targetPvc.

getTargetPvcOrBuilder()

public NamespacedNameOrBuilder getTargetPvcOrBuilder()

Output only. The reference to the target Kubernetes PVC to be restored.

.google.cloud.gkebackup.v1.NamespacedName target_pvc = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NamespacedNameOrBuilder

getUid()

public 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 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 Timestamp getUpdateTime()

Output only. The timestamp when this VolumeRestore 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 VolumeRestore resource was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVolumeBackup()

public String getVolumeBackup()

Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.

string volume_backup = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The volumeBackup.

getVolumeBackupBytes()

public ByteString getVolumeBackupBytes()

Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.

string volume_backup = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for volumeBackup.

getVolumeHandle()

public String getVolumeHandle()

Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.

string volume_handle = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The volumeHandle.

getVolumeHandleBytes()

public ByteString getVolumeHandleBytes()

Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.

string volume_handle = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for volumeHandle.

getVolumeType()

public VolumeRestore.VolumeType getVolumeType()

Output only. The type of volume provisioned

.google.cloud.gkebackup.v1.VolumeRestore.VolumeType volume_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
VolumeRestore.VolumeType

The volumeType.

getVolumeTypeValue()

public int getVolumeTypeValue()

Output only. The type of volume provisioned

.google.cloud.gkebackup.v1.VolumeRestore.VolumeType volume_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for volumeType.

hasCompleteTime()

public boolean hasCompleteTime()

Output only. The timestamp when the associated underlying volume restoration completed.

.google.protobuf.Timestamp complete_time = 9 [(.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 VolumeRestore 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.

hasTargetPvc()

public boolean hasTargetPvc()

Output only. The reference to the target Kubernetes PVC to be restored.

.google.cloud.gkebackup.v1.NamespacedName target_pvc = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the targetPvc field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when this VolumeRestore 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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VolumeRestore.Builder newBuilderForType()
Returns
Type Description
VolumeRestore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VolumeRestore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VolumeRestore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public VolumeRestore.Builder toBuilder()
Returns
Type Description
VolumeRestore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException