Backup (Cloud Spanner API v1-rev20250708-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.spanner.v1.model.Backup

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Backup
extends com.google.api.client.json.GenericJson
```
A backup of a Cloud Spanner database.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Backup()

Constructors
Constructor and Description
`Backup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Backup`	`clone()`
`List<String>`	`getBackupSchedules()` Output only.
`String`	`getCreateTime()` Output only.
`String`	`getDatabase()` Required for the CreateBackup operation.
`String`	`getDatabaseDialect()` Output only.
`EncryptionInfo`	`getEncryptionInfo()` Output only.
`List<EncryptionInfo>`	`getEncryptionInformation()` Output only.
`Long`	`getExclusiveSizeBytes()` Output only.
`String`	`getExpireTime()` Required for the CreateBackup operation.
`Long`	`getFreeableSizeBytes()` Output only.
`String`	`getIncrementalBackupChainId()` Output only.
`List<BackupInstancePartition>`	`getInstancePartitions()` Output only.
`String`	`getMaxExpireTime()` Output only.
`String`	`getName()` Output only for the CreateBackup operation.
`String`	`getOldestVersionTime()` Output only.
`List<String>`	`getReferencingBackups()` Output only.
`List<String>`	`getReferencingDatabases()` Output only.
`Long`	`getSizeBytes()` Output only.
`String`	`getState()` Output only.
`String`	`getVersionTime()` The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`.
`Backup`	`set(String fieldName, Object value)`
`Backup`	`setBackupSchedules(List<String> backupSchedules)` Output only.
`Backup`	`setCreateTime(String createTime)` Output only.
`Backup`	`setDatabase(String database)` Required for the CreateBackup operation.
`Backup`	`setDatabaseDialect(String databaseDialect)` Output only.
`Backup`	`setEncryptionInfo(EncryptionInfo encryptionInfo)` Output only.
`Backup`	`setEncryptionInformation(List<EncryptionInfo> encryptionInformation)` Output only.
`Backup`	`setExclusiveSizeBytes(Long exclusiveSizeBytes)` Output only.
`Backup`	`setExpireTime(String expireTime)` Required for the CreateBackup operation.
`Backup`	`setFreeableSizeBytes(Long freeableSizeBytes)` Output only.
`Backup`	`setIncrementalBackupChainId(String incrementalBackupChainId)` Output only.
`Backup`	`setInstancePartitions(List<BackupInstancePartition> instancePartitions)` Output only.
`Backup`	`setMaxExpireTime(String maxExpireTime)` Output only.
`Backup`	`setName(String name)` Output only for the CreateBackup operation.
`Backup`	`setOldestVersionTime(String oldestVersionTime)` Output only.
`Backup`	`setReferencingBackups(List<String> referencingBackups)` Output only.
`Backup`	`setReferencingDatabases(List<String> referencingDatabases)` Output only.
`Backup`	`setSizeBytes(Long sizeBytes)` Output only.
`Backup`	`setState(String state)` Output only.
`Backup`	`setVersionTime(String versionTime)` The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Backup
```
public Backup()
```
- Method Detail
  - getBackupSchedules
```
public List<String> getBackupSchedules()
```
    Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
    
    Returns:
    
    value or null for none
  - setBackupSchedules
```
public Backup setBackupSchedules(List<String> backupSchedules)
```
    Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
    
    Parameters:
    
    backupSchedules - backupSchedules or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Backup setCreateTime(String createTime)
```
    Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDatabase
```
public String getDatabase()
```
    Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
    
    Returns:
    
    value or null for none
  - setDatabase
```
public Backup setDatabase(String database)
```
    Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
    
    Parameters:
    
    database - database or null for none
  - getDatabaseDialect
```
public String getDatabaseDialect()
```
    Output only. The database dialect information for the backup.
    
    Returns:
    
    value or null for none
  - setDatabaseDialect
```
public Backup setDatabaseDialect(String databaseDialect)
```
    Output only. The database dialect information for the backup.
    
    Parameters:
    
    databaseDialect - databaseDialect or null for none
  - getEncryptionInfo
```
public EncryptionInfo getEncryptionInfo()
```
    Output only. The encryption information for the backup.
    
    Returns:
    
    value or null for none
  - setEncryptionInfo
```
public Backup setEncryptionInfo(EncryptionInfo encryptionInfo)
```
    Output only. The encryption information for the backup.
    
    Parameters:
    
    encryptionInfo - encryptionInfo or null for none
  - getEncryptionInformation
```
public List<EncryptionInfo> getEncryptionInformation()
```
    Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The `encryption_status` field inside of each `EncryptionInfo` is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.
    
    Returns:
    
    value or null for none
  - setEncryptionInformation
```
public Backup setEncryptionInformation(List<EncryptionInfo> encryptionInformation)
```
    Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The `encryption_status` field inside of each `EncryptionInfo` is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.
    
    Parameters:
    
    encryptionInformation - encryptionInformation or null for none
  - getExclusiveSizeBytes
```
public Long getExclusiveSizeBytes()
```
    Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.
    
    Returns:
    
    value or null for none
  - setExclusiveSizeBytes
```
public Backup setExclusiveSizeBytes(Long exclusiveSizeBytes)
```
    Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.
    
    Parameters:
    
    exclusiveSizeBytes - exclusiveSizeBytes or null for none
  - getExpireTime
```
public String getExpireTime()
```
    Required for the CreateBackup operation. 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 CreateBackup request is processed. 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.
    
    Returns:
    
    value or null for none
  - setExpireTime
```
public Backup setExpireTime(String expireTime)
```
    Required for the CreateBackup operation. 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 CreateBackup request is processed. 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.
    
    Parameters:
    
    expireTime - expireTime or null for none
  - getFreeableSizeBytes
```
public Long getFreeableSizeBytes()
```
    Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.
    
    Returns:
    
    value or null for none
  - setFreeableSizeBytes
```
public Backup setFreeableSizeBytes(Long freeableSizeBytes)
```
    Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.
    
    Parameters:
    
    freeableSizeBytes - freeableSizeBytes or null for none
  - getIncrementalBackupChainId
```
public String getIncrementalBackupChainId()
```
    Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`.
    
    Returns:
    
    value or null for none
  - setIncrementalBackupChainId
```
public Backup setIncrementalBackupChainId(String incrementalBackupChainId)
```
    Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`.
    
    Parameters:
    
    incrementalBackupChainId - incrementalBackupChainId or null for none
  - getInstancePartitions
```
public List<BackupInstancePartition> getInstancePartitions()
```
    Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`.
    
    Returns:
    
    value or null for none
  - setInstancePartitions
```
public Backup setInstancePartitions(List<BackupInstancePartition> instancePartitions)
```
    Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`.
    
    Parameters:
    
    instancePartitions - instancePartitions or null for none
  - getMaxExpireTime
```
public String getMaxExpireTime()
```
    Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`.
    
    Returns:
    
    value or null for none
  - setMaxExpireTime
```
public Backup setMaxExpireTime(String maxExpireTime)
```
    Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`.
    
    Parameters:
    
    maxExpireTime - maxExpireTime or null for none
  - getName
```
public String getName()
```
    Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
    
    Returns:
    
    value or null for none
  - setName
```
public Backup setName(String name)
```
    Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
    
    Parameters:
    
    name - name or null for none
  - getOldestVersionTime
```
public String getOldestVersionTime()
```
    Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
    
    Returns:
    
    value or null for none
  - setOldestVersionTime
```
public Backup setOldestVersionTime(String oldestVersionTime)
```
    Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
    
    Parameters:
    
    oldestVersionTime - oldestVersionTime or null for none
  - getReferencingBackups
```
public List<String> getReferencingBackups()
```
    Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.
    
    Returns:
    
    value or null for none
  - setReferencingBackups
```
public Backup setReferencingBackups(List<String> referencingBackups)
```
    Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.
    
    Parameters:
    
    referencingBackups - referencingBackups or null for none
  - getReferencingDatabases
```
public List<String> getReferencingDatabases()
```
    Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
    
    Returns:
    
    value or null for none
  - setReferencingDatabases
```
public Backup setReferencingDatabases(List<String> referencingDatabases)
```
    Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
    
    Parameters:
    
    referencingDatabases - referencingDatabases or null for none
  - getSizeBytes
```
public Long getSizeBytes()
```
    Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain.
    
    Returns:
    
    value or null for none
  - setSizeBytes
```
public Backup setSizeBytes(Long sizeBytes)
```
    Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain.
    
    Parameters:
    
    sizeBytes - sizeBytes or null for none
  - getState
```
public String getState()
```
    Output only. The current state of the backup.
    
    Returns:
    
    value or null for none
  - setState
```
public Backup setState(String state)
```
    Output only. The current state of the backup.
    
    Parameters:
    
    state - state or null for none
  - getVersionTime
```
public String getVersionTime()
```
    The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup.
    
    Returns:
    
    value or null for none
  - setVersionTime
```
public Backup setVersionTime(String versionTime)
```
    The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup.
    
    Parameters:
    
    versionTime - versionTime or null for none
  - set
```
public Backup set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Backup clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Backup

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Backup

Method Detail

getBackupSchedules

setBackupSchedules

getCreateTime

setCreateTime

getDatabase

setDatabase

getDatabaseDialect

setDatabaseDialect

getEncryptionInfo

setEncryptionInfo

getEncryptionInformation

setEncryptionInformation

getExclusiveSizeBytes

setExclusiveSizeBytes

getExpireTime

setExpireTime

getFreeableSizeBytes

setFreeableSizeBytes

getIncrementalBackupChainId

setIncrementalBackupChainId

getInstancePartitions

setInstancePartitions

getMaxExpireTime

setMaxExpireTime

getName

setName

getOldestVersionTime

setOldestVersionTime

getReferencingBackups

setReferencingBackups

getReferencingDatabases

setReferencingDatabases

getSizeBytes

setSizeBytes

getState

setState

getVersionTime

setVersionTime

set

clone