Cloud Bigtable V2 Client - Class Backup (2.1.0)
Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Cloud Bigtable V2 Client class Backup.

A backup of a Cloud Bigtable table.

Generated from protobuf message google.bigtable.admin.v2.Backup

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`↳ source_table`	`string` Required. Immutable. Name of the table 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}/tables/{source_table}`.
`↳ source_backup`	`string` Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/
`↳ expire_time`	`Google\Protobuf\Timestamp` Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
`↳ start_time`	`Google\Protobuf\Timestamp` Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
`↳ end_time`	`Google\Protobuf\Timestamp` Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
`↳ size_bytes`	`int\|string` Output only. Size of the backup in bytes.
`↳ state`	`int` Output only. The current state of the backup.
`↳ encryption_info`	`Google\Cloud\Bigtable\Admin\V2\EncryptionInfo` Output only. The encryption information for the backup.

getName

A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type	Description
`string`

setName

The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceTable

Required. Immutable. Name of the table 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}/tables/{source_table}.

Returns
Type	Description
`string`

setSourceTable

Required. Immutable. Name of the table 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}/tables/{source_table}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceBackup

Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/

Returns
Type	Description
`string`

setSourceBackup

Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExpireTime

Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and 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`

getStartTime

Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.

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

Returns
Type	Description
`$this`

getEndTime

Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime