Interface CopyBackupRequestOrBuilder (6.25.0)

public interface CopyBackupRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBackupId()

public abstract 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
TypeDescription
String

The backupId.

getBackupIdBytes()

public abstract 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
TypeDescription
ByteString

The bytes for backupId.

getEncryptionConfig()

public abstract 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 = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CopyBackupEncryptionConfig

The encryptionConfig.

getEncryptionConfigOrBuilder()

public abstract 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 = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CopyBackupEncryptionConfigOrBuilder

getExpireTime()

public abstract 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
TypeDescription
Timestamp

The expireTime.

getExpireTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

getParent()

public abstract 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
TypeDescription
String

The parent.

getParentBytes()

public abstract 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
TypeDescription
ByteString

The bytes for parent.

getSourceBackup()

public abstract 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
TypeDescription
String

The sourceBackup.

getSourceBackupBytes()

public abstract 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
TypeDescription
ByteString

The bytes for sourceBackup.

hasEncryptionConfig()

public abstract 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 = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the encryptionConfig field is set.

hasExpireTime()

public abstract 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
TypeDescription
boolean

Whether the expireTime field is set.