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

Interface CopyBackupRequestOrBuilder

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

  • Method Details

    • getParent

      String getParent()
       Required. The name of the destination instance that will contain the backup copy.
 Values are of the form: `projects/<project>/instances/<instance>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The name of the destination instance that will contain the backup copy.
 Values are of the form: `projects/<project>/instances/<instance>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getBackupId

      String getBackupId()
       Required. The id of the backup copy.
 The `backup_id` appended to `parent` forms the full backup_uri of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
      string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The backupId.

    • getBackupIdBytes

      com.google.protobuf.ByteString getBackupIdBytes()
       Required. The id of the backup copy.
 The `backup_id` appended to `parent` forms the full backup_uri of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
      string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for backupId.

    • getSourceBackup

      String getSourceBackup()
       Required. The source backup to be copied.
 The source backup needs to be in READY state for it to be copied.
 Once CopyBackup is in progress, the source backup cannot be deleted or
 cleaned up on expiration until CopyBackup is finished.
 Values are of the form:
 `projects/<project>/instances/<instance>/backups/<backup>`.
      string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The sourceBackup.

    • getSourceBackupBytes

      com.google.protobuf.ByteString getSourceBackupBytes()
       Required. The source backup to be copied.
 The source backup needs to be in READY state for it to be copied.
 Once CopyBackup is in progress, the source backup cannot be deleted or
 cleaned up on expiration until CopyBackup is finished.
 Values are of the form:
 `projects/<project>/instances/<instance>/backups/<backup>`.
      string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for sourceBackup.

    • hasExpireTime

      boolean hasExpireTime()
       Required. The expiration time of the backup in microsecond granularity.
 The expiration time must be at least 6 hours and at most 366 days
 from the `create_time` of the source backup. Once the `expire_time` has
 passed, the backup is eligible to be automatically deleted by Cloud Spanner
 to free the resources used by the backup.
      .google.protobuf.Timestamp expire_time = 4 [(.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 in microsecond granularity.
 The expiration time must be at least 6 hours and at most 366 days
 from the `create_time` of the source backup. Once the `expire_time` has
 passed, the backup is eligible to be automatically deleted by Cloud Spanner
 to free the resources used by the backup.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       Required. The expiration time of the backup in microsecond granularity.
 The expiration time must be at least 6 hours and at most 366 days
 from the `create_time` of the source backup. Once the `expire_time` has
 passed, the backup is eligible to be automatically deleted by Cloud Spanner
 to free the resources used by the backup.
      .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];

    • hasEncryptionConfig

      boolean hasEncryptionConfig()
       Optional. The encryption configuration used to encrypt the backup. If this field is
 not specified, the backup will use the same
 encryption configuration as the source backup by default, namely
 [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] =
 `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
      .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the encryptionConfig field is set.

    • getEncryptionConfig

      CopyBackupEncryptionConfig getEncryptionConfig()
       Optional. The encryption configuration used to encrypt the backup. If this field is
 not specified, the backup will use the same
 encryption configuration as the source backup by default, namely
 [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] =
 `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
      .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The encryptionConfig.

    • getEncryptionConfigOrBuilder

      CopyBackupEncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
       Optional. The encryption configuration used to encrypt the backup. If this field is
 not specified, the backup will use the same
 encryption configuration as the source backup by default, namely
 [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] =
 `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
      .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];