Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Snapshot (v1.3.0)

Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::Snapshot.

A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table.

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

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_size_bytes

def data_size_bytes() -> ::Integer
Returns
  • (::Integer) — Output only. The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

#delete_time=

def delete_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.
Returns
  • (::Google::Protobuf::Timestamp) — The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

#description

def description() -> ::String
Returns
  • (::String) — Description of the snapshot.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Description of the snapshot.
Returns
  • (::String) — Description of the snapshot.

#name

def name() -> ::String
Returns
  • (::String) — The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.
Returns
  • (::String) — The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

#source_table

def source_table() -> ::Google::Cloud::Bigtable::Admin::V2::Table
Returns

#state

def state() -> ::Google::Cloud::Bigtable::Admin::V2::Snapshot::State
Returns