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 message google.bigtable.admin.v2.Snapshot
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The unique name of the snapshot. Values are of the form |
↳ source_table |
Google\Cloud\Bigtable\Admin\V2\Table
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. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the snapshot is created. |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. 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
Output only. Description of the snapshot. |
getName
Output only. The unique name of the snapshot.
Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The unique name of the snapshot.
Values are of the form
projects/{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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\Table|null | |
hasSourceTable
clearSourceTable
setSourceTable
Output only. The source table at the time the snapshot was taken.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\Table
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataSizeBytes
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the snapshot is created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeleteTime
Output only. 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 | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the snapshot.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the snapshot.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Output only. Description of the snapshot.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Output only. Description of the snapshot.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |