com.google.cloud.spanner

Class BackupInfo.Builder

java.lang.Object

com.google.cloud.spanner.BackupInfo.Builder

Direct Known Subclasses:

Backup.Builder

Enclosing class:

BackupInfo

public abstract static class BackupInfo.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
protected BackupInfo.Builder	addAllReferencingBackups(List<String> referencingBackups) Output Only.
abstract Backup	build() Builds the backup from this builder.
abstract BackupInfo.Builder	setDatabase(DatabaseId database) Required for creating a new backup.
abstract BackupInfo.Builder	setEncryptionConfig(BackupEncryptionConfig encryptionConfig) Optional for creating a new backup.
abstract BackupInfo.Builder	setExpireTime(com.google.cloud.Timestamp expireTime) Required for creating a new backup.
protected BackupInfo.Builder	setMaxExpireTime(com.google.cloud.Timestamp maxExpireTime) Output Only.
abstract BackupInfo.Builder	setVersionTime(com.google.cloud.Timestamp versionTime) Optional for creating a new backup.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setEncryptionConfig

public abstract BackupInfo.Builder setEncryptionConfig(BackupEncryptionConfig encryptionConfig)

Optional for creating a new backup.

The encryption configuration to be used for the backup. The possible configurations are CustomerManagedEncryption, GoogleDefaultEncryption and UseDatabaseEncryption.

If no encryption config is given the backup will be created with the same encryption as set by the database (UseDatabaseEncryption).

setExpireTime

public abstract BackupInfo.Builder setExpireTime(com.google.cloud.Timestamp expireTime)

Required for creating a new backup.

Sets the expiration time of the backup. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the request is received. Once the expireTime has passed, Cloud Spanner will delete the backup and free the resources used by the backup.

setVersionTime

public abstract BackupInfo.Builder setVersionTime(com.google.cloud.Timestamp versionTime)

Optional for creating a new backup.

Specifies the timestamp to have an externally consistent copy of the database. If no version time is specified, it will be automatically set to the backup create time.

The version time can be as far in the past as specified by the database earliest version time (see DatabaseInfo.getEarliestVersionTime()).

setDatabase

public abstract BackupInfo.Builder setDatabase(DatabaseId database)

Required for creating a new backup.

Sets the source database to use for creating the backup.

build

public abstract Backup build()

Builds the backup from this builder.

setMaxExpireTime

protected BackupInfo.Builder setMaxExpireTime(com.google.cloud.Timestamp maxExpireTime)

Output Only.

Returns the max allowed expiration time of the backup, with microseconds granularity.

addAllReferencingBackups

protected BackupInfo.Builder addAllReferencingBackups(List<String> referencingBackups)

Output Only.

Returns the names of the destination backups being created by copying this source backup.