Reference documentation and code samples for the Cloud Bigtable V2 Client class Snapshot.
A snapshot of a table at a particular time. A snapshot can be used as a
checkpoint for data restoration or a data source for a new table.
Note: This is a private alpha release of Cloud Bigtable snapshots. This
feature is not currently available to most Cloud Bigtable customers. This
feature might be changed in backward-incompatible ways and is not recommended
for production use. It is not subject to any SLA or deprecation policy.
Generated from protobuf messagegoogle.bigtable.admin.v2.Snapshot
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique name of the snapshot. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
Output only. The source table at the time the snapshot was taken.
↳ data_size_bytes
int|string
Output only. The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.
The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.
↳ state
int
Output only. The current state of the snapshot.
↳ description
string
Description of the snapshot.
getName
The unique name of the snapshot.
Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
Returns
Type
Description
string
setName
The unique name of the snapshot.
Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSourceTable
Output only. The source table at the time the snapshot was taken.
Output only. The size of the data in the source table at the time the
snapshot was taken. In some cases, this value may be computed
asynchronously via a background process and a placeholder of 0 will be used
in the meantime.
Returns
Type
Description
int|string
setDataSizeBytes
Output only. The size of the data in the source table at the time the
snapshot was taken. In some cases, this value may be computed
asynchronously via a background process and a placeholder of 0 will be used
in the meantime.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getCreateTime
Output only. The time when the snapshot is created.
The time when the snapshot will be deleted. The maximum amount of time a
snapshot can stay active is 365 days. If 'ttl' is not specified,
the default maximum of 365 days will be used.
The time when the snapshot will be deleted. The maximum amount of time a
snapshot can stay active is 365 days. If 'ttl' is not specified,
the default maximum of 365 days will be used.
[[["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-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class Snapshot (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Snapshot)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.Snapshot)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.Snapshot)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.Snapshot)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.Snapshot)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.Snapshot)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.Snapshot)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.Snapshot)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.Snapshot)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.Snapshot)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.Snapshot)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.Snapshot)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.Snapshot)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.Snapshot)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.Snapshot)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.Snapshot)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.Snapshot)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.Snapshot)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.Snapshot)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.Snapshot)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.Snapshot)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.Snapshot)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.Snapshot)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.Snapshot)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.Snapshot)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.Snapshot)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.Snapshot)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.Snapshot)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.Snapshot)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.Snapshot)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.Snapshot) \nReference documentation and code samples for the Cloud Bigtable V2 Client class Snapshot.\n\nA snapshot of a table at a particular time. A snapshot can be used as a\ncheckpoint for data restoration or a data source for a new table.\n\nNote: This is a private alpha release of Cloud Bigtable snapshots. This\nfeature is not currently available to most Cloud Bigtable customers. This\nfeature might be changed in backward-incompatible ways and is not recommended\nfor production use. It is not subject to any SLA or deprecation policy.\n\nGenerated from protobuf message `google.bigtable.admin.v2.Snapshot`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique name of the snapshot.\n\nValues are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.\n\n### setName\n\nThe unique name of the snapshot.\n\nValues are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.\n\n### getSourceTable\n\nOutput only. The source table at the time the snapshot was taken.\n\n### hasSourceTable\n\n### clearSourceTable\n\n### setSourceTable\n\nOutput only. The source table at the time the snapshot was taken.\n\n### getDataSizeBytes\n\nOutput only. The size of the data in the source table at the time the\nsnapshot was taken. In some cases, this value may be computed\nasynchronously via a background process and a placeholder of 0 will be used\nin the meantime.\n\n### setDataSizeBytes\n\nOutput only. The size of the data in the source table at the time the\nsnapshot was taken. In some cases, this value may be computed\nasynchronously via a background process and a placeholder of 0 will be used\nin the meantime.\n\n### getCreateTime\n\nOutput only. The time when the snapshot is created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time when the snapshot is created.\n\n### getDeleteTime\n\nThe time when the snapshot will be deleted. The maximum amount of time a\nsnapshot can stay active is 365 days. If 'ttl' is not specified,\nthe default maximum of 365 days will be used.\n\n### hasDeleteTime\n\n### clearDeleteTime\n\n### setDeleteTime\n\nThe time when the snapshot will be deleted. The maximum amount of time a\nsnapshot can stay active is 365 days. If 'ttl' is not specified,\nthe default maximum of 365 days will be used.\n\n### getState\n\nOutput only. The current state of the snapshot.\n\n### setState\n\nOutput only. The current state of the snapshot.\n\n### getDescription\n\nDescription of the snapshot.\n\n### setDescription\n\nDescription of the snapshot."]]
