Class BackupInfo.Builder (6.56.0)

public abstract static class BackupInfo.Builder

Inheritance

java.lang.Object > BackupInfo.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

public Builder()

Methods

addAllReferencingBackups(List<String> referencingBackups)

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

Output Only.

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

Parameter
Name	Description
`referencingBackups`	`List<String>`

Returns
Type	Description
`BackupInfo.Builder`

build()

public abstract Backup build()

Builds the backup from this builder.

Returns
Type	Description
`Backup`

setDatabase(DatabaseId database)

public abstract BackupInfo.Builder setDatabase(DatabaseId database)

Required for creating a new backup.

Sets the source database to use for creating the backup.

Parameter
Name	Description
`database`	`DatabaseId`

Returns
Type	Description
`BackupInfo.Builder`

setEncryptionConfig(BackupEncryptionConfig encryptionConfig)

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 com.google.cloud.spanner.encryption.CustomerManagedEncryption, com.google.cloud.spanner.encryption.GoogleDefaultEncryption and com.google.cloud.spanner.encryption.UseDatabaseEncryption.

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

Parameter
Name	Description
`encryptionConfig`	`BackupEncryptionConfig`

Returns
Type	Description
`BackupInfo.Builder`

setExpireTime(Timestamp expireTime)

public abstract BackupInfo.Builder setExpireTime(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.

Parameter
Name	Description
`expireTime`	`com.google.cloud.Timestamp`

Returns
Type	Description
`BackupInfo.Builder`

setMaxExpireTime(Timestamp maxExpireTime)

protected BackupInfo.Builder setMaxExpireTime(Timestamp maxExpireTime)

Output Only.

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

Parameter
Name	Description
`maxExpireTime`	`com.google.cloud.Timestamp`

Returns
Type	Description
`BackupInfo.Builder`

setVersionTime(Timestamp versionTime)

public abstract BackupInfo.Builder setVersionTime(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 Database#getEarliestVersionTime()).

Parameter
Name	Description
`versionTime`	`com.google.cloud.Timestamp`

Returns
Type	Description
`BackupInfo.Builder`