Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Backup (v1.15.0)

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

A backup of a Cloud Bigtable table.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#backup_type

def backup_type() -> ::Google::Cloud::Bigtable::Admin::V2::Backup::BackupType
Returns

#backup_type=

def backup_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Backup::BackupType
Parameter
Returns

#encryption_info

def encryption_info() -> ::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo
Returns

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by:

    • At least 6 hours
    • At most 90 days

    Once the expire_time has passed, Cloud Bigtable will delete the backup.

#expire_time=

def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by:

    • At least 6 hours
    • At most 90 days

    Once the expire_time has passed, Cloud Bigtable will delete the backup.

Returns
  • (::Google::Protobuf::Timestamp) — Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by:

    • At least 6 hours
    • At most 90 days

    Once the expire_time has passed, Cloud Bigtable will delete the backup.

#hot_to_standard_time

def hot_to_standard_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by:

    • At least 24 hours

    This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.

#hot_to_standard_time=

def hot_to_standard_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by:

    • At least 24 hours

    This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.

Returns
  • (::Google::Protobuf::Timestamp) — The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by:

    • At least 24 hours

    This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.

#name

def name() -> ::String
Returns
  • (::String) — A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

    The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

    The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
  • (::String) — A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

    The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

#size_bytes

def size_bytes() -> ::Integer
Returns
  • (::Integer) — Output only. Size of the backup in bytes.

#source_backup

def source_backup() -> ::String
Returns
  • (::String) — Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/

#source_table

def source_table() -> ::String
Returns
  • (::String) — Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/tables/{source_table}.

#source_table=

def source_table=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/tables/{source_table}.
Returns
  • (::String) — Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/tables/{source_table}.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.

#state

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