Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#cluster
def cluster() -> ::String
-
(::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}
.
#cluster=
def cluster=(value) -> ::String
-
value (::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}
.
-
(::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}
.
#description
def description() -> ::String
- (::String) — Description of the snapshot.
#description=
def description=(value) -> ::String
- value (::String) — Description of the snapshot.
- (::String) — Description of the snapshot.
#name
def name() -> ::String
-
(::String) — Required. The unique name of the table to have the snapshot taken.
Values are of the form
projects/{project}/instances/{instance}/tables/{table}
.
#name=
def name=(value) -> ::String
-
value (::String) — Required. The unique name of the table to have the snapshot taken.
Values are of the form
projects/{project}/instances/{instance}/tables/{table}
.
-
(::String) — Required. The unique name of the table to have the snapshot taken.
Values are of the form
projects/{project}/instances/{instance}/tables/{table}
.
#snapshot_id
def snapshot_id() -> ::String
-
(::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 thanprojects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot
.
#snapshot_id=
def snapshot_id=(value) -> ::String
-
value (::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 thanprojects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot
.
-
(::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 thanprojects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot
.
#ttl
def ttl() -> ::Google::Protobuf::Duration
- (::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.
#ttl=
def ttl=(value) -> ::Google::Protobuf::Duration
- value (::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.
- (::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.