Cloud Bigtable V2 Client - Class SnapshotTableRequest (1.27.0)

Version 1.27.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

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.
↳ 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}.

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.

Returns
Type	Description
Google\Protobuf\Duration|null

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.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getDescription

Description of the snapshot.

Returns
Type	Description
string

setDescription

Description of the snapshot.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
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 Google\Cloud\Bigtable\Admin\V2\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 Google\Cloud\Bigtable\Admin\V2\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.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\SnapshotTableRequest