Package com.google.bigtable.admin.v2

Class Backup

  • All Implemented Interfaces:
    BackupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Backup
extends com.google.protobuf.GeneratedMessageV3
implements BackupOrBuilder
     A backup of a Cloud Bigtable table.
    Protobuf type google.bigtable.admin.v2.Backup
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Backup.Builder
      A backup of a Cloud Bigtable table.
      static class  Backup.State
      Indicates the current state of the backup.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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()
         A globally unique identifier for the backup which cannot be
 changed. Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/
    backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
 The final segment of the name must be between 1 and 50 characters
 in length.

 The backup is stored in the cluster identified by the prefix of the backup
 name of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}`.
        string name = 1;
        Specified by:
        getName in interface BackupOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         A globally unique identifier for the backup which cannot be
 changed. Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/
    backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
 The final segment of the name must be between 1 and 50 characters
 in length.

 The backup is stored in the cluster identified by the prefix of the backup
 name of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}`.
        string name = 1;
        Specified by:
        getNameBytes in interface BackupOrBuilder
        Returns:
        The bytes for name.

      • getSourceTable

        public String getSourceTable()
         Required. Immutable. Name of the table from which this backup was created.
 This needs to be in the same instance as the backup. Values are of the form
 `projects/{project}/instances/{instance}/tables/{source_table}`.
        string source_table = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSourceTable in interface BackupOrBuilder
        Returns:
        The sourceTable.

      • getSourceTableBytes

        public com.google.protobuf.ByteString getSourceTableBytes()
         Required. Immutable. Name of the table from which this backup was created.
 This needs to be in the same instance as the backup. Values are of the form
 `projects/{project}/instances/{instance}/tables/{source_table}`.
        string source_table = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSourceTableBytes in interface BackupOrBuilder
        Returns:
        The bytes for sourceTable.

      • getSourceBackup

        public String getSourceBackup()
         Output only. Name of the backup from which this backup was copied. If a
 backup is not created by copying a backup, this field will be empty. Values
 are of the form: projects/<project>/instances/<instance>/backups/<backup>.
        string source_backup = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSourceBackup in interface BackupOrBuilder
        Returns:
        The sourceBackup.

      • getSourceBackupBytes

        public com.google.protobuf.ByteString getSourceBackupBytes()
         Output only. Name of the backup from which this backup was copied. If a
 backup is not created by copying a backup, this field will be empty. Values
 are of the form: projects/<project>/instances/<instance>/backups/<backup>.
        string source_backup = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSourceBackupBytes in interface BackupOrBuilder
        Returns:
        The bytes for sourceBackup.

      • hasExpireTime

        public boolean hasExpireTime()
         Required. The expiration time of the backup, with microseconds
 granularity that must be at least 6 hours and at most 90 days
 from the time the request is received. Once the `expire_time`
 has passed, Cloud Bigtable will delete the backup and free the
 resources used by the backup.
        .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasExpireTime in interface BackupOrBuilder
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        public com.google.protobuf.Timestamp getExpireTime()
         Required. The expiration time of the backup, with microseconds
 granularity that must be at least 6 hours and at most 90 days
 from the time the request is received. Once the `expire_time`
 has passed, Cloud Bigtable will delete the backup and free the
 resources used by the backup.
        .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getExpireTime in interface BackupOrBuilder
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
         Required. The expiration time of the backup, with microseconds
 granularity that must be at least 6 hours and at most 90 days
 from the time the request is received. Once the `expire_time`
 has passed, Cloud Bigtable will delete the backup and free the
 resources used by the backup.
        .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getExpireTimeOrBuilder in interface BackupOrBuilder

      • hasStartTime

        public boolean hasStartTime()
         Output only. `start_time` is the time that the backup was started
 (i.e. approximately the time the
 [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup]
 request is received).  The row data in this backup will be no older than
 this timestamp.
        .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface BackupOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. `start_time` is the time that the backup was started
 (i.e. approximately the time the
 [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup]
 request is received).  The row data in this backup will be no older than
 this timestamp.
        .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface BackupOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. `start_time` is the time that the backup was started
 (i.e. approximately the time the
 [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup]
 request is received).  The row data in this backup will be no older than
 this timestamp.
        .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface BackupOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         Output only. `end_time` is the time that the backup was finished. The row
 data in the backup will be no newer than this timestamp.
        .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndTime in interface BackupOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         Output only. `end_time` is the time that the backup was finished. The row
 data in the backup will be no newer than this timestamp.
        .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTime in interface BackupOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. `end_time` is the time that the backup was finished. The row
 data in the backup will be no newer than this timestamp.
        .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTimeOrBuilder in interface BackupOrBuilder

      • getSizeBytes

        public long getSizeBytes()
         Output only. Size of the backup in bytes.
        int64 size_bytes = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSizeBytes in interface BackupOrBuilder
        Returns:
        The sizeBytes.

      • getStateValue

        public int getStateValue()
         Output only. The current state of the backup.
        .google.bigtable.admin.v2.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface BackupOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Backup.State getState()
         Output only. The current state of the backup.
        .google.bigtable.admin.v2.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface BackupOrBuilder
        Returns:
        The state.

      • hasEncryptionInfo

        public boolean hasEncryptionInfo()
         Output only. The encryption information for the backup.
        .google.bigtable.admin.v2.EncryptionInfo encryption_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEncryptionInfo in interface BackupOrBuilder
        Returns:
        Whether the encryptionInfo field is set.

      • getEncryptionInfo

        public EncryptionInfo getEncryptionInfo()
         Output only. The encryption information for the backup.
        .google.bigtable.admin.v2.EncryptionInfo encryption_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEncryptionInfo in interface BackupOrBuilder
        Returns:
        The encryptionInfo.

      • getEncryptionInfoOrBuilder

        public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
         Output only. The encryption information for the backup.
        .google.bigtable.admin.v2.EncryptionInfo encryption_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEncryptionInfoOrBuilder in interface BackupOrBuilder

      • 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 Backup parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Backup getDefaultInstance()

      • parser

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

      • getParserForType

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