Reference documentation and code samples for the Cloud Bigtable V2 Client class SnapshotTableRequest.
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable
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 message google.bigtable.admin.v2.SnapshotTableRequest
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The unique name of the table to have the snapshot taken. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
↳ cluster
string
Required. The name of the cluster where the snapshot will be created in. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
↳ snapshot_id
string
Required. The ID by which the new snapshot should be referred to within the parent cluster, e.g., mysnapshot of the form: [_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot.
The amount of time that the new snapshot can stay active after it is created. Once 'ttl' expires, the snapshot will get deleted. The maximum amount of time a snapshot can stay active is 7 days. If 'ttl' is not specified, the default value of 24 hours will be used.
↳ description
string
Description of the snapshot.
getName
Required. The unique name of the table to have the snapshot taken.
Values are of the form
projects/{project}/instances/{instance}/tables/{table}.
Returns
Type
Description
string
setName
Required. The unique name of the table to have the snapshot taken.
Values are of the form
projects/{project}/instances/{instance}/tables/{table}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCluster
Required. The name of the cluster where the snapshot will be created in.
Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}.
Returns
Type
Description
string
setCluster
Required. The name of the cluster where the snapshot will be created in.
Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSnapshotId
Required. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., mysnapshot of the form:
[_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than
projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot.
Returns
Type
Description
string
setSnapshotId
Required. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., mysnapshot of the form:
[_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than
projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTtl
The amount of time that the new snapshot can stay active after it is
created. Once 'ttl' expires, the snapshot will get deleted. The maximum
amount of time a snapshot can stay active is 7 days. If 'ttl' is not
specified, the default value of 24 hours will be used.
The amount of time that the new snapshot can stay active after it is
created. Once 'ttl' expires, the snapshot will get deleted. The maximum
amount of time a snapshot can stay active is 7 days. If 'ttl' is not
specified, the default value of 24 hours will be used.
Required. The unique name of the table to have the snapshot taken.
Values are of the form
projects/{project}/instances/{instance}/tables/{table}. Please see
BigtableTableAdminClient::tableName() for help formatting this field.
cluster
string
Required. The name of the cluster where the snapshot will be created in.
Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}. Please see
BigtableTableAdminClient::clusterName() for help formatting this field.
snapshotId
string
Required. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., mysnapshot of the form:
[_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than
projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot.
[[["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 SnapshotTableRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.SnapshotTableRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.SnapshotTableRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.SnapshotTableRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.SnapshotTableRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.SnapshotTableRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.SnapshotTableRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.SnapshotTableRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.SnapshotTableRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.SnapshotTableRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.SnapshotTableRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.SnapshotTableRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.SnapshotTableRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.SnapshotTableRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.SnapshotTableRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.SnapshotTableRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.SnapshotTableRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.SnapshotTableRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.SnapshotTableRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.SnapshotTableRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.SnapshotTableRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.SnapshotTableRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.SnapshotTableRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.SnapshotTableRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.SnapshotTableRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.SnapshotTableRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.SnapshotTableRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.SnapshotTableRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.SnapshotTableRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.SnapshotTableRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.SnapshotTableRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.SnapshotTableRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class SnapshotTableRequest.\n\nRequest message for\n[google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__snapshotTable__)\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.SnapshotTableRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The unique name of the table to have the snapshot taken.\n\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.\n\n### setName\n\nRequired. The unique name of the table to have the snapshot taken.\n\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.\n\n### getCluster\n\nRequired. The name of the cluster where the snapshot will be created in.\n\nValues are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.\n\n### setCluster\n\nRequired. The name of the cluster where the snapshot will be created in.\n\nValues are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.\n\n### getSnapshotId\n\nRequired. The ID by which the new snapshot should be referred to within the\nparent cluster, e.g., `mysnapshot` of the form:\n`[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than\n`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.\n\n### setSnapshotId\n\nRequired. The ID by which the new snapshot should be referred to within the\nparent cluster, e.g., `mysnapshot` of the form:\n`[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than\n`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.\n\n### getTtl\n\nThe amount of time that the new snapshot can stay active after it is\ncreated. Once 'ttl' expires, the snapshot will get deleted. The maximum\namount of time a snapshot can stay active is 7 days. If 'ttl' is not\nspecified, the default value of 24 hours will be used.\n\n### hasTtl\n\n### clearTtl\n\n### setTtl\n\nThe amount of time that the new snapshot can stay active after it is\ncreated. Once 'ttl' expires, the snapshot will get deleted. The maximum\namount of time a snapshot can stay active is 7 days. If 'ttl' is not\nspecified, the default value of 24 hours will be used.\n\n### getDescription\n\nDescription of the snapshot.\n\n### setDescription\n\nDescription of the snapshot.\n\n### static::build"]]
