Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::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.
(::Integer) — 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.
#delete_time
defdelete_time()->::Google::Protobuf::Timestamp
Returns
(::Google::Protobuf::Timestamp) — 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.
value (::Google::Protobuf::Timestamp) — 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.
Returns
(::Google::Protobuf::Timestamp) — 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.
(::String) — The unique name of the snapshot.
Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
#name=
defname=(value)->::String
Parameter
value (::String) — The unique name of the snapshot.
Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
Returns
(::String) — The unique name of the snapshot.
Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
[[["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 Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Snapshot (v1.13.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.13.0 (latest)](/ruby/docs/reference/google-cloud-bigtable-admin-v2/latest/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.12.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.12.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.11.1](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.11.1/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.10.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.10.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.9.1](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.9.1/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.8.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.8.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.7.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.7.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.6.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.6.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.5.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.5.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.4.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.4.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.3.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.3.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.2.1](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.2.1/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.1.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.1.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [1.0.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/1.0.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.27.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.27.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.26.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.26.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.25.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.25.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.24.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.24.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.23.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.23.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.22.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.22.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.21.3](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.21.3/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.20.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.20.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.19.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.19.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.18.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.18.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.17.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.17.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.16.3](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.16.3/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.15.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.15.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.14.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.14.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.13.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.13.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.12.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.12.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.11.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.11.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.10.0](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.10.0/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.9.1](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.9.1/Google-Cloud-Bigtable-Admin-V2-Snapshot)\n- [0.8.1](/ruby/docs/reference/google-cloud-bigtable-admin-v2/0.8.1/Google-Cloud-Bigtable-Admin-V2-Snapshot) \nReference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::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\n\n\u003cbr /\u003e\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\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time when the snapshot is created.\n\n### #data_size_bytes\n\n def data_size_bytes() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- 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.\n\n### #delete_time\n\n def delete_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- 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.\n\n### #delete_time=\n\n def delete_time=(value) -\u003e ::Google::Protobuf::Timestamp\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- 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. \n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- 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.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- ([::String](./Google-Cloud-Bigtable-Admin-V2-Type-String)) --- Description of the snapshot.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** ([::String](./Google-Cloud-Bigtable-Admin-V2-Type-String)) --- Description of the snapshot. \n**Returns**\n\n- ([::String](./Google-Cloud-Bigtable-Admin-V2-Type-String)) --- Description of the snapshot.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- ([::String](./Google-Cloud-Bigtable-Admin-V2-Type-String)) --- The unique name of the snapshot. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** ([::String](./Google-Cloud-Bigtable-Admin-V2-Type-String)) --- The unique name of the snapshot. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`. \n**Returns**\n\n- ([::String](./Google-Cloud-Bigtable-Admin-V2-Type-String)) --- The unique name of the snapshot. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.\n\n### #source_table\n\n def source_table() -\u003e ::Google::Cloud::Bigtable::Admin::V2::Table\n\n**Returns**\n\n- ([::Google::Cloud::Bigtable::Admin::V2::Table](./Google-Cloud-Bigtable-Admin-V2-Table)) --- Output only. The source table at the time the snapshot was taken.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Bigtable::Admin::V2::Snapshot::State\n\n**Returns**\n\n- ([::Google::Cloud::Bigtable::Admin::V2::Snapshot::State](./Google-Cloud-Bigtable-Admin-V2-Snapshot-State)) --- Output only. The current state of the snapshot."]]
