Reference documentation and code samples for the Cloud Bigtable V2 Client class Backup.
A backup of a Cloud Bigtable table.
Generated from protobuf messagegoogle.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 formprojects/{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 formprojects/{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 formprojects/{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/
Required. The expiration time of the backup. When creating a backup or updating itsexpire_time, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once theexpire_timehas passed, Cloud Bigtable will delete the backup.
Output only.start_timeis the time that the backup was started (i.e. approximately the time theCreateBackuprequest is received). The row data in this backup will be no older than this timestamp.
The time at which the hot backup will be converted to a standard backup. Once thehot_to_standard_timehas passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.
getName
A globally unique identifier for the backup which cannot be
changed. Values are of the formprojects/{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 formprojects/{project}/instances/{instance}/clusters/{cluster}.
Returns
Type
Description
string
setName
A globally unique identifier for the backup which cannot be
changed. Values are of the formprojects/{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 formprojects/{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 formprojects/{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 formprojects/{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.
When creating a backup or updating itsexpire_time, the value must be
greater than the backup creation time by:
At least 6 hours
At most 90 days
Once theexpire_timehas passed, Cloud Bigtable will delete the backup.
Output only.start_timeis the time that the backup was started
(i.e. approximately the time theCreateBackuprequest is received). The row data in this backup will be no older than
this timestamp.
Output only.start_timeis the time that the backup was started
(i.e. approximately the time theCreateBackuprequest is received). The row data in this backup will be no older than
this timestamp.
The time at which the hot backup will be converted to a standard backup.
Once thehot_to_standard_timehas passed, Cloud Bigtable will convert the
hot backup to a standard backup. This value must be greater than the backup
creation time by:
At least 24 hours
This field only applies for hot backups. When creating or updating a
standard backup, attempting to set this field will fail the request.
The time at which the hot backup will be converted to a standard backup.
Once thehot_to_standard_timehas passed, Cloud Bigtable will convert the
hot backup to a standard backup. This value must be greater than the backup
creation time by:
At least 24 hours
This field only applies for hot backups. When creating or updating a
standard backup, attempting to set this field will fail the request.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class Backup (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Backup)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.Backup)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.Backup)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.Backup)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.Backup)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.Backup)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.Backup)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.Backup)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.Backup)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.Backup)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.Backup)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.Backup)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.Backup)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.Backup)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.Backup)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.Backup)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.Backup)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.Backup)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.Backup)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.Backup)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.Backup)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.Backup)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.Backup)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.Backup)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.Backup)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.Backup)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.Backup)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.Backup)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.Backup)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.Backup)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.Backup) \nReference documentation and code samples for the Cloud Bigtable V2 Client class Backup.\n\nA backup of a Cloud Bigtable table.\n\nGenerated from protobuf message `google.bigtable.admin.v2.Backup`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nA globally unique identifier for the backup which cannot be\nchanged. Values are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}/\nbackups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`\nThe final segment of the name must be between 1 and 50 characters\nin length.\n\nThe backup is stored in the cluster identified by the prefix of the backup\nname of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.\n\n### setName\n\nA globally unique identifier for the backup which cannot be\nchanged. Values are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}/\nbackups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`\nThe final segment of the name must be between 1 and 50 characters\nin length.\n\nThe backup is stored in the cluster identified by the prefix of the backup\nname of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.\n\n### getSourceTable\n\nRequired. Immutable. Name of the table from which this backup was created.\n\nThis needs to be in the same instance as the backup. Values are of the form\n`projects/{project}/instances/{instance}/tables/{source_table}`.\n\n### setSourceTable\n\nRequired. Immutable. Name of the table from which this backup was created.\n\nThis needs to be in the same instance as the backup. Values are of the form\n`projects/{project}/instances/{instance}/tables/{source_table}`.\n\n### getSourceBackup\n\nOutput only. Name of the backup from which this backup was copied. If a\nbackup is not created by copying a backup, this field will be empty. Values\nare of the form:\nprojects/\n\n\n### setSourceBackup\n\nOutput only. Name of the backup from which this backup was copied. If a\nbackup is not created by copying a backup, this field will be empty. Values\nare of the form:\nprojects/\n\n\n### getExpireTime\n\nRequired. The expiration time of the backup.\n\nWhen creating a backup or updating its `expire_time`, the value must be\ngreater than the backup creation time by:\n\n- At least 6 hours\n- At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup.\n\n### hasExpireTime\n\n### clearExpireTime\n\n### setExpireTime\n\nRequired. The expiration time of the backup.\n\nWhen creating a backup or updating its `expire_time`, the value must be\ngreater than the backup creation time by:\n\n- At least 6 hours\n- At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup.\n\n### getStartTime\n\nOutput only. `start_time` is the time that the backup was started\n(i.e. approximately the time the\n[CreateBackup](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__createBackup__)\nrequest is received). The row data in this backup will be no older than\nthis timestamp.\n\n### hasStartTime\n\n### clearStartTime\n\n### setStartTime\n\nOutput only. `start_time` is the time that the backup was started\n(i.e. approximately the time the\n[CreateBackup](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__createBackup__)\nrequest is received). The row data in this backup will be no older than\nthis timestamp.\n\n### getEndTime\n\nOutput only. `end_time` is the time that the backup was finished. The row\ndata in the backup will be no newer than this timestamp.\n\n### hasEndTime\n\n### clearEndTime\n\n### setEndTime\n\nOutput only. `end_time` is the time that the backup was finished. The row\ndata in the backup will be no newer than this timestamp.\n\n### getSizeBytes\n\nOutput only. Size of the backup in bytes.\n\n### setSizeBytes\n\nOutput only. Size of the backup in bytes.\n\n### getState\n\nOutput only. The current state of the backup.\n\n### setState\n\nOutput only. The current state of the backup.\n\n### getEncryptionInfo\n\nOutput only. The encryption information for the backup.\n\n### hasEncryptionInfo\n\n### clearEncryptionInfo\n\n### setEncryptionInfo\n\nOutput only. The encryption information for the backup.\n\n### getBackupType\n\nIndicates the backup type of the backup.\n\n### setBackupType\n\nIndicates the backup type of the backup.\n\n### getHotToStandardTime\n\nThe time at which the hot backup will be converted to a standard backup.\n\nOnce the `hot_to_standard_time` has passed, Cloud Bigtable will convert the\nhot backup to a standard backup. This value must be greater than the backup\ncreation time by:\n\n- At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.\n\n### hasHotToStandardTime\n\n### clearHotToStandardTime\n\n### setHotToStandardTime\n\nThe time at which the hot backup will be converted to a standard backup.\n\nOnce the `hot_to_standard_time` has passed, Cloud Bigtable will convert the\nhot backup to a standard backup. This value must be greater than the backup\ncreation time by:\n\n- At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request."]]
