Google Cloud Bigtable C++ Client  2.1.0
A C++ Client Library for Google Cloud Bigtable
Public Member Functions | Public Attributes | List of all members
google::cloud::bigtable::TableAdmin::CreateBackupParams Struct Reference

Parameters for CreateBackup. More...

#include <google/cloud/bigtable/table_admin.h>

Public Member Functions

 CreateBackupParams ()=default
 
 CreateBackupParams (std::string cluster_id, std::string backup_id, std::string table_id, std::chrono::system_clock::time_point expire_time)
 
google::bigtable::admin::v2::CreateBackupRequest AsProto (std::string instance_name) const
 

Public Attributes

std::string cluster_id
 
std::string backup_id
 
std::string table_name
 
std::chrono::system_clock::time_point expire_time
 

Detailed Description

Parameters for CreateBackup.

Parameters
cluster_idthe name of the cluster relative to the instance managed by the TableAdmin object. The full cluster name is projects/<PROJECT_ID>/instances/<INSTANCE_ID>/clusters/<cluster_id> where PROJECT_ID is obtained from the associated AdminClient and INSTANCE_ID is the instance_id() of the TableAdmin object.
backup_idthe name of the backup relative to the cluster specified. The full backup name is projects/<PROJECT_ID>/instances/<INSTANCE_ID>/clusters/<CLUSTER_ID>/backups/<backup_id> where PROJECT_ID is obtained from the associated AdminClient, INSTANCE_ID is the instance_id() of the TableAdmin object, and CLUSTER_ID is the cluster_id specified for this object.
table_idthe id of the table within the instance to be backed up. The full name of the table is projects/<PROJECT_ID>/instances/<INSTANCE_ID>/tables/<table_id> where PROJECT_ID is obtained from the associated AdminClient and INSTANCE_ID is the instance_id() of the TableAdmin object.
expire_timethe date and time when the created backup will expire.

Definition at line 376 of file table_admin.h.

Constructor & Destructor Documentation

◆ CreateBackupParams() [1/2]

google::cloud::bigtable::TableAdmin::CreateBackupParams::CreateBackupParams ( )
default

◆ CreateBackupParams() [2/2]

google::cloud::bigtable::TableAdmin::CreateBackupParams::CreateBackupParams ( std::string  cluster_id,
std::string  backup_id,
std::string  table_id,
std::chrono::system_clock::time_point  expire_time 
)
inline

Definition at line 378 of file table_admin.h.

Member Function Documentation

◆ AsProto()

google::bigtable::admin::v2::CreateBackupRequest google::cloud::bigtable::TableAdmin::CreateBackupParams::AsProto ( std::string  instance_name) const

Member Data Documentation

◆ backup_id

std::string google::cloud::bigtable::TableAdmin::CreateBackupParams::backup_id

Definition at line 390 of file table_admin.h.

◆ cluster_id

std::string google::cloud::bigtable::TableAdmin::CreateBackupParams::cluster_id

Definition at line 389 of file table_admin.h.

◆ expire_time

std::chrono::system_clock::time_point google::cloud::bigtable::TableAdmin::CreateBackupParams::expire_time

Definition at line 392 of file table_admin.h.

◆ table_name

std::string google::cloud::bigtable::TableAdmin::CreateBackupParams::table_name

Definition at line 391 of file table_admin.h.