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 \ V2Methods
__construct
Constructor.
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
.
↳ ttl
Google\Protobuf\Duration
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}
.
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}
.
var
string
$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}
.
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}
.
var
string
$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
.
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
.
var
string
$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.
hasTtl
clearTtl
setTtl
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.
$this
getDescription
Description of the snapshot.
string
setDescription
Description of the snapshot.
var
string
$this
static::build
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}
. 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
.
description
string
Description of the snapshot.
