Cloud Spanner V1 Client - Class Backup (1.87.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class Backup.

A backup of a Cloud Spanner database.

Generated from protobuf message google.spanner.admin.database.v1.Backup

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ database`	`string` 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/<project>/instances/<instance>/databases/<database>`.
`↳ version_time`	`Google\Protobuf\Timestamp` 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.
`↳ expire_time`	`Google\Protobuf\Timestamp` 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.
`↳ name`	`string` 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/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[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/<project>/instances/<instance>`.
`↳ create_time`	`Google\Protobuf\Timestamp` 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`.
`↳ size_bytes`	`int\|string` Output only. Size of the backup in bytes.
`↳ freeable_size_bytes`	`int\|string` 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.
`↳ exclusive_size_bytes`	`int\|string` 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.
`↳ state`	`int` Output only. The current state of the backup.
`↳ referencing_databases`	`array` Output only. The names of the restored databases that reference the backup. The database names are of the form `projects/<project>/instances/<instance>/databases/<database>`. 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.
`↳ encryption_info`	`Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo` Output only. The encryption information for the backup.
`↳ encryption_information`	`array<Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo>` 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.
`↳ database_dialect`	`int` Output only. The database dialect information for the backup.
`↳ referencing_backups`	`array` Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects/<project>/instances/<instance>/backups/<backup>`. 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.
`↳ max_expire_time`	`Google\Protobuf\Timestamp` 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`.
`↳ backup_schedules`	`array` 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.
`↳ incremental_backup_chain_id`	`string` 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`.
`↳ oldest_version_time`	`Google\Protobuf\Timestamp` 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.

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/<project>/instances/<instance>/databases/<database>.

Returns
Type	Description
`string`

setDatabase

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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
Type	Description
`Google\Protobuf\Timestamp\|null`

hasVersionTime

clearVersionTime

setVersionTime

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

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
Type	Description
`Google\Protobuf\Timestamp\|null`

hasExpireTime

clearExpireTime

setExpireTime

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

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/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[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/<project>/instances/<instance>.

Returns
Type	Description
`string`

setName

Output only for the CreateBackup operation. Required for the UpdateBackup operation.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

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.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getSizeBytes

Output only. Size of the backup in bytes.

Returns
Type	Description
`int\|string`

setSizeBytes

Output only. Size of the backup in bytes.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

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
Type	Description
`int\|string`

setFreeableSizeBytes

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

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
Type	Description
`int\|string`

setExclusiveSizeBytes

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.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getState

Output only. The current state of the backup.

Returns
Type	Description
`int`

setState

Output only. The current state of the backup.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getReferencingDatabases

Output only. The names of the restored databases that reference the backup.

The database names are of the form projects/<project>/instances/<instance>/databases/<database>. 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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setReferencingDatabases

Output only. The names of the restored databases that reference the backup.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getEncryptionInfo

Output only. The encryption information for the backup.

Returns
Type	Description
`Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo\|null`

hasEncryptionInfo

clearEncryptionInfo

setEncryptionInfo

Output only. The encryption information for the backup.

Parameter
Name	Description
`var`	`Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo`

Returns
Type	Description
`$this`

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 eachEncryptionInfo` 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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setEncryptionInformation

Parameter
Name	Description
`var`	`array<Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo>`

Returns
Type	Description
`$this`

getDatabaseDialect

Output only. The database dialect information for the backup.

Returns
Type	Description
`int`

setDatabaseDialect

Output only. The database dialect information for the backup.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getReferencingBackups

Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects/<project>/instances/<instance>/backups/<backup>.

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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setReferencingBackups

Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects/<project>/instances/<instance>/backups/<backup>.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

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
Type	Description
`Google\Protobuf\Timestamp\|null`

hasMaxExpireTime

clearMaxExpireTime

setMaxExpireTime

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setBackupSchedules

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.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

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
Type	Description
`string`

setIncrementalBackupChainId

Output only. Populated only for backups in an incremental backup chain.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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
Type	Description
`Google\Protobuf\Timestamp\|null`

hasOldestVersionTime

clearOldestVersionTime

setOldestVersionTime

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`