Package com.google.cloud.gkebackup.v1

Class VolumeBackup

  • All Implemented Interfaces:
    VolumeBackupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class VolumeBackup
extends com.google.protobuf.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
    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. The full name of the VolumeBackup resource.
 Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface VolumeBackupOrBuilder
        Returns:
        The name.

      • getNameBytes

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

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

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

      • 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];
        Specified by:
        hasSourcePvc in interface VolumeBackupOrBuilder
        Returns:
        Whether the sourcePvc field is set.

      • 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];
        Specified by:
        getSourcePvc in interface VolumeBackupOrBuilder
        Returns:
        The sourcePvc.

      • 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];
        Specified by:
        getSourcePvcOrBuilder in interface VolumeBackupOrBuilder

      • 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];
        Specified by:
        getVolumeBackupHandle in interface VolumeBackupOrBuilder
        Returns:
        The volumeBackupHandle.

      • getVolumeBackupHandleBytes

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

      • getFormatValue

        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];
        Specified by:
        getFormatValue in interface VolumeBackupOrBuilder
        Returns:
        The enum numeric value on the wire for format.

      • getFormat

        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];
        Specified by:
        getFormat in interface VolumeBackupOrBuilder
        Returns:
        The format.

      • 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];
        Specified by:
        getStorageBytes in interface VolumeBackupOrBuilder
        Returns:
        The storageBytes.

      • 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];
        Specified by:
        getDiskSizeBytes in interface VolumeBackupOrBuilder
        Returns:
        The diskSizeBytes.

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

      • getCompleteTime

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

      • getCompleteTimeOrBuilder

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

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

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

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

      • getStateMessageBytes

        public com.google.protobuf.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];
        Specified by:
        getStateMessageBytes in interface VolumeBackupOrBuilder
        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 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];
        Specified by:
        getEtag in interface VolumeBackupOrBuilder
        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 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];
        Specified by:
        getEtagBytes in interface VolumeBackupOrBuilder
        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 VolumeBackup parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static VolumeBackup getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<VolumeBackup> 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 VolumeBackup getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder