Package com.google.spanner.admin.database.v1

Interface BackupScheduleOrBuilder

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

  • Method Details

    • getName

      String getName()
       Identifier. Output only for the
 [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation.
 Required for the
 [UpdateBackupSchedule][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupSchedule]
 operation. A globally unique identifier for the backup schedule which
 cannot be changed. Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9]`
 The final segment of the name must be between 2 and 60 characters in
 length.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Output only for the
 [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation.
 Required for the
 [UpdateBackupSchedule][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupSchedule]
 operation. A globally unique identifier for the backup schedule which
 cannot be changed. Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9]`
 The final segment of the name must be between 2 and 60 characters in
 length.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • hasSpec

      boolean hasSpec()
       Optional. The schedule specification based on which the backup creations
 are triggered.
      .google.spanner.admin.database.v1.BackupScheduleSpec spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the spec field is set.

    • getSpec

      BackupScheduleSpec getSpec()
       Optional. The schedule specification based on which the backup creations
 are triggered.
      .google.spanner.admin.database.v1.BackupScheduleSpec spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The spec.

    • getSpecOrBuilder

      BackupScheduleSpecOrBuilder getSpecOrBuilder()
       Optional. The schedule specification based on which the backup creations
 are triggered.
      .google.spanner.admin.database.v1.BackupScheduleSpec spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasRetentionDuration

      boolean hasRetentionDuration()
       Optional. The retention duration of a backup that must be at least 6 hours
 and at most 366 days. The backup is eligible to be automatically deleted
 once the retention period has elapsed.
      .google.protobuf.Duration retention_duration = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the retentionDuration field is set.

    • getRetentionDuration

      com.google.protobuf.Duration getRetentionDuration()
       Optional. The retention duration of a backup that must be at least 6 hours
 and at most 366 days. The backup is eligible to be automatically deleted
 once the retention period has elapsed.
      .google.protobuf.Duration retention_duration = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The retentionDuration.

    • getRetentionDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getRetentionDurationOrBuilder()
       Optional. The retention duration of a backup that must be at least 6 hours
 and at most 366 days. The backup is eligible to be automatically deleted
 once the retention period has elapsed.
      .google.protobuf.Duration retention_duration = 3 [(.google.api.field_behavior) = OPTIONAL];

    • hasEncryptionConfig

      boolean hasEncryptionConfig()
       Optional. The encryption configuration that will be used to encrypt the
 backup. If this field is not specified, the backup will use the same
 encryption configuration as the database.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the encryptionConfig field is set.

    • getEncryptionConfig

      CreateBackupEncryptionConfig getEncryptionConfig()
       Optional. The encryption configuration that will be used to encrypt the
 backup. If this field is not specified, the backup will use the same
 encryption configuration as the database.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The encryptionConfig.

    • getEncryptionConfigOrBuilder

      CreateBackupEncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
       Optional. The encryption configuration that will be used to encrypt the
 backup. If this field is not specified, the backup will use the same
 encryption configuration as the database.
      .google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

    • hasFullBackupSpec

      boolean hasFullBackupSpec()
       The schedule creates only full backups.
      .google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;
      Returns:
      Whether the fullBackupSpec field is set.

    • getFullBackupSpec

      FullBackupSpec getFullBackupSpec()
       The schedule creates only full backups.
      .google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;
      Returns:
      The fullBackupSpec.

    • getFullBackupSpecOrBuilder

      FullBackupSpecOrBuilder getFullBackupSpecOrBuilder()
       The schedule creates only full backups.
      .google.spanner.admin.database.v1.FullBackupSpec full_backup_spec = 7;

    • hasIncrementalBackupSpec

      boolean hasIncrementalBackupSpec()
       The schedule creates incremental backup chains.
      .google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;
      Returns:
      Whether the incrementalBackupSpec field is set.

    • getIncrementalBackupSpec

      IncrementalBackupSpec getIncrementalBackupSpec()
       The schedule creates incremental backup chains.
      .google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;
      Returns:
      The incrementalBackupSpec.

    • getIncrementalBackupSpecOrBuilder

      IncrementalBackupSpecOrBuilder getIncrementalBackupSpecOrBuilder()
       The schedule creates incremental backup chains.
      .google.spanner.admin.database.v1.IncrementalBackupSpec incremental_backup_spec = 8;

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The timestamp at which the schedule was last updated.
 If the schedule has never been updated, this field contains the timestamp
 when the schedule was first created.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp at which the schedule was last updated.
 If the schedule has never been updated, this field contains the timestamp
 when the schedule was first created.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp at which the schedule was last updated.
 If the schedule has never been updated, this field contains the timestamp
 when the schedule was first created.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getBackupTypeSpecCase

      BackupSchedule.BackupTypeSpecCase getBackupTypeSpecCase()