Package com.google.cloud.gkebackup.v1

Class VolumeRestore

  • All Implemented Interfaces:
    VolumeRestoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class VolumeRestore
extends com.google.protobuf.GeneratedMessageV3
implements VolumeRestoreOrBuilder
     Represents the operation of restoring a volume from a VolumeBackup.
 Next id: 13
    Protobuf type google.cloud.gkebackup.v1.VolumeRestore
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface VolumeRestoreOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface VolumeRestoreOrBuilder
        Returns:
        The bytes for name.

      • getUid

        public String getUid()
         Output only. Server generated global unique identifier of
 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface VolumeRestoreOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. Server generated global unique identifier of
 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface VolumeRestoreOrBuilder
        Returns:
        The bytes for uid.

      • 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];
        Specified by:
        hasCreateTime in interface VolumeRestoreOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The timestamp when this VolumeRestore resource was
 created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface VolumeRestoreOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The timestamp when this VolumeRestore resource was
 created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface VolumeRestoreOrBuilder

      • 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];
        Specified by:
        hasUpdateTime in interface VolumeRestoreOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.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];
        Specified by:
        getUpdateTime in interface VolumeRestoreOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getUpdateTimeOrBuilder in interface VolumeRestoreOrBuilder

      • 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];
        Specified by:
        getVolumeBackup in interface VolumeRestoreOrBuilder
        Returns:
        The volumeBackup.

      • getVolumeBackupBytes

        public com.google.protobuf.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];
        Specified by:
        getVolumeBackupBytes in interface VolumeRestoreOrBuilder
        Returns:
        The bytes for volumeBackup.

      • 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];
        Specified by:
        hasTargetPvc in interface VolumeRestoreOrBuilder
        Returns:
        Whether the targetPvc field is set.

      • 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];
        Specified by:
        getTargetPvc in interface VolumeRestoreOrBuilder
        Returns:
        The targetPvc.

      • 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];
        Specified by:
        getVolumeHandle in interface VolumeRestoreOrBuilder
        Returns:
        The volumeHandle.

      • getVolumeHandleBytes

        public com.google.protobuf.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];
        Specified by:
        getVolumeHandleBytes in interface VolumeRestoreOrBuilder
        Returns:
        The bytes for volumeHandle.

      • 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];
        Specified by:
        getVolumeTypeValue in interface VolumeRestoreOrBuilder
        Returns:
        The enum numeric value on the wire for volumeType.

      • 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];
        Specified by:
        getVolumeType in interface VolumeRestoreOrBuilder
        Returns:
        The 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];
        Specified by:
        hasCompleteTime in interface VolumeRestoreOrBuilder
        Returns:
        Whether the completeTime field is set.

      • getCompleteTime

        public com.google.protobuf.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];
        Specified by:
        getCompleteTime in interface VolumeRestoreOrBuilder
        Returns:
        The completeTime.

      • getCompleteTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getCompleteTimeOrBuilder in interface VolumeRestoreOrBuilder

      • 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];
        Specified by:
        getStateValue in interface VolumeRestoreOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface VolumeRestoreOrBuilder
        Returns:
        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];
        Specified by:
        getStateMessage in interface VolumeRestoreOrBuilder
        Returns:
        The stateMessage.

      • getStateMessageBytes

        public com.google.protobuf.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];
        Specified by:
        getStateMessageBytes in interface VolumeRestoreOrBuilder
        Returns:
        The bytes for stateMessage.

      • 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];
        Specified by:
        getEtag in interface VolumeRestoreOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.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];
        Specified by:
        getEtagBytes in interface VolumeRestoreOrBuilder
        Returns:
        The bytes for etag.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static VolumeRestore parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VolumeRestore parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VolumeRestore parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VolumeRestore parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VolumeRestore parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VolumeRestore parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VolumeRestore parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public VolumeRestore.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public VolumeRestore.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected VolumeRestore.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static VolumeRestore getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<VolumeRestore> parser()

      • getParserForType

        public com.google.protobuf.Parser<VolumeRestore> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public VolumeRestore getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder