Class: Google::Bigtable::Admin::V2::SnapshotTableRequest
- Inherits:
-
Object
- Object
- Google::Bigtable::Admin::V2::SnapshotTableRequest
- Defined in:
- lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb
Overview
Request message for 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.
Instance Attribute Summary collapse
-
#cluster ⇒ String
The name of the cluster where the snapshot will be created in.
-
#description ⇒ String
Description of the snapshot.
-
#name ⇒ String
The unique name of the table to have the snapshot taken.
-
#snapshot_id ⇒ String
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 thanprojects/<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.
Instance Attribute Details
#cluster ⇒ String
Returns The name of the cluster where the snapshot will be created in.
Values are of the form
projects/<project>/instances/<instance>/clusters/<cluster>
.
252 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 252 class SnapshotTableRequest; end |
#description ⇒ String
Returns Description of the snapshot.
252 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 252 class SnapshotTableRequest; end |
#name ⇒ String
Returns The unique name of the table to have the snapshot taken.
Values are of the form
projects/<project>/instances/<instance>/tables/<table>
.
252 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 252 class SnapshotTableRequest; end |
#snapshot_id ⇒ String
Returns 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
.
252 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 252 class SnapshotTableRequest; end |
#ttl ⇒ Google::Protobuf::Duration
Returns 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.
252 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 252 class SnapshotTableRequest; end |