Google Cloud Bigtable Administration v2 API - Class SnapshotTableRequest (3.21.0)

public sealed class SnapshotTableRequest : IMessage<SnapshotTableRequest>, IEquatable<SnapshotTableRequest>, IDeepCloneable<SnapshotTableRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class SnapshotTableRequest.

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][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.

Inheritance

object > SnapshotTableRequest

Implements

IMessage SnapshotTableRequest, IEquatable SnapshotTableRequest, IDeepCloneable SnapshotTableRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

SnapshotTableRequest()

public SnapshotTableRequest()

SnapshotTableRequest(SnapshotTableRequest)

public SnapshotTableRequest(SnapshotTableRequest other)

Parameter
Name	Description
`other`	`SnapshotTableRequest`

Properties

Cluster

public string Cluster { get; set; }

Required. The name of the cluster where the snapshot will be created in. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Property Value
Type	Description
`string`

ClusterAsClusterName

public ClusterName ClusterAsClusterName { get; set; }

ClusterName-typed view over the Cluster resource name property.

Property Value
Type	Description
`ClusterName`

Description

public string Description { get; set; }

Description of the snapshot.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

Required. The unique name of the table to have the snapshot taken. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Property Value
Type	Description
`string`

SnapshotId

public string SnapshotId { get; set; }

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.

Property Value
Type	Description
`string`

TableName

public TableName TableName { get; set; }

TableName-typed view over the Name resource name property.

Property Value
Type	Description
`TableName`

Ttl

public Duration Ttl { get; set; }

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.

Property Value
Type	Description
`Duration`