Package com.google.bigtable.admin.v2

Interface BackupOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Backup, Backup.Builder
public interface BackupOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getSourceTable

      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];
      Returns:
      The sourceTable.

    • getSourceTableBytes

      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];
      Returns:
      The bytes for sourceTable.

    • getSourceBackup

      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>/clusters/<cluster>/backups/<backup>
      string source_backup = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The sourceBackup.

    • getSourceBackupBytes

      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>/clusters/<cluster>/backups/<backup>
      string source_backup = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for sourceBackup.

    • hasExpireTime

      boolean hasExpireTime()
       Required. The expiration time of the backup.
 When creating a backup or updating its `expire_time`, the value must be
 greater than the backup creation time by:
 - At least 6 hours
 - At most 90 days

 Once the `expire_time` has passed, Cloud Bigtable will delete the backup.
      .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the expireTime field is set.

    • getExpireTime

      com.google.protobuf.Timestamp getExpireTime()
       Required. The expiration time of the backup.
 When creating a backup or updating its `expire_time`, the value must be
 greater than the backup creation time by:
 - At least 6 hours
 - At most 90 days

 Once the `expire_time` has passed, Cloud Bigtable will delete the backup.
      .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       Required. The expiration time of the backup.
 When creating a backup or updating its `expire_time`, the value must be
 greater than the backup creation time by:
 - At least 6 hours
 - At most 90 days

 Once the `expire_time` has passed, Cloud Bigtable will delete the backup.
      .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = REQUIRED];

    • hasStartTime

      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];
      Returns:
      Whether the startTime field is set.

    • getStartTime

      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];
      Returns:
      The startTime.

    • getStartTimeOrBuilder

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

    • hasEndTime

      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];
      Returns:
      Whether the endTime field is set.

    • getEndTime

      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];
      Returns:
      The endTime.

    • getEndTimeOrBuilder

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

    • getSizeBytes

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

    • getStateValue

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

    • getState

      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];
      Returns:
      The state.

    • hasEncryptionInfo

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

    • getEncryptionInfo

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

    • getEncryptionInfoOrBuilder

      EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
       Output only. The encryption information for the backup.
      .google.bigtable.admin.v2.EncryptionInfo encryption_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getBackupTypeValue

      int getBackupTypeValue()
       Indicates the backup type of the backup.
      .google.bigtable.admin.v2.Backup.BackupType backup_type = 11;
      Returns:
      The enum numeric value on the wire for backupType.

    • getBackupType

      Backup.BackupType getBackupType()
       Indicates the backup type of the backup.
      .google.bigtable.admin.v2.Backup.BackupType backup_type = 11;
      Returns:
      The backupType.

    • hasHotToStandardTime

      boolean hasHotToStandardTime()
       The time at which the hot backup will be converted to a standard backup.
 Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the
 hot backup to a standard backup. This value must be greater than the backup
 creation time by:
 - At least 24 hours

 This field only applies for hot backups. When creating or updating a
 standard backup, attempting to set this field will fail the request.
      .google.protobuf.Timestamp hot_to_standard_time = 12;
      Returns:
      Whether the hotToStandardTime field is set.

    • getHotToStandardTime

      com.google.protobuf.Timestamp getHotToStandardTime()
       The time at which the hot backup will be converted to a standard backup.
 Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the
 hot backup to a standard backup. This value must be greater than the backup
 creation time by:
 - At least 24 hours

 This field only applies for hot backups. When creating or updating a
 standard backup, attempting to set this field will fail the request.
      .google.protobuf.Timestamp hot_to_standard_time = 12;
      Returns:
      The hotToStandardTime.

    • getHotToStandardTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getHotToStandardTimeOrBuilder()
       The time at which the hot backup will be converted to a standard backup.
 Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the
 hot backup to a standard backup. This value must be greater than the backup
 creation time by:
 - At least 24 hours

 This field only applies for hot backups. When creating or updating a
 standard backup, attempting to set this field will fail the request.
      .google.protobuf.Timestamp hot_to_standard_time = 12;