Google Cloud Bigtable C++ Client 2.13.0
A C++ Client Library for Google Cloud Bigtable
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
google::cloud::bigtable::TableResource Class Reference

This class identifies a Cloud Bigtable Table. More...

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

Public Member Functions

 TableResource (InstanceResource instance, std::string table_id)
 Constructs a TableResource object identified by the given instance and table_id. More...
 
 TableResource (std::string project_id, std::string instance_id, std::string table_id)
 Constructs a TableResource object identified by the given IDs. More...
 
InstanceResource const & instance () const
 Returns the InstanceResource containing this table. More...
 
std::string const & table_id () const
 Returns the Table ID. More...
 
std::string FullName () const
 Returns the fully qualified table name as a string of the form: "projects/<project-id>/instances/<instance-id>/tables/<table-id>". More...
 

Friends

std::ostream & operator<< (std::ostream &, TableResource const &)
 Output the FullName() format. More...
 
Equality operators
bool operator== (TableResource const &a, TableResource const &b)
 
bool operator!= (TableResource const &a, TableResource const &b)
 

Detailed Description

This class identifies a Cloud Bigtable Table.

Bigtable stores data in massively scalable tables, each of which is a sorted key/value map. A Cloud Bigtable table is identified by the instance it is contained in and its table_id.

Note
This class makes no effort to validate the components of the table name. It is the application's responsibility to provide valid project, instance, and table ids. Passing invalid values will not be checked until the table name is used in a RPC to Bigtable.
See also
https://cloud.google.com/bigtable/docs/overview for an overview of the Cloud Bigtable data model.

Constructor & Destructor Documentation

◆ TableResource() [1/2]

google::cloud::bigtable::TableResource::TableResource ( InstanceResource  instance,
std::string  table_id 
)

Constructs a TableResource object identified by the given instance and table_id.

◆ TableResource() [2/2]

google::cloud::bigtable::TableResource::TableResource ( std::string  project_id,
std::string  instance_id,
std::string  table_id 
)

Constructs a TableResource object identified by the given IDs.

This is equivalent to first constructing an InstanceResource from the given project_id and instance_id arguments and then calling the TableResource(InstanceResource, std::string) constructor.

Member Function Documentation

◆ FullName()

std::string google::cloud::bigtable::TableResource::FullName ( ) const

Returns the fully qualified table name as a string of the form: "projects/<project-id>/instances/<instance-id>/tables/<table-id>".

◆ instance()

InstanceResource const & google::cloud::bigtable::TableResource::instance ( ) const
inline

Returns the InstanceResource containing this table.

◆ table_id()

std::string const & google::cloud::bigtable::TableResource::table_id ( ) const
inline

Returns the Table ID.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( TableResource const &  a,
TableResource const &  b 
)
friend

◆ operator<<

std::ostream & operator<< ( std::ostream &  ,
TableResource const &   
)
friend

Output the FullName() format.

◆ operator==

bool operator== ( TableResource const &  a,
TableResource const &  b 
)
friend