google::cloud::bigtable::InstanceResource Class Reference

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

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

Public Member Functions
	InstanceResource (Project project, std::string instance_id)
	Constructs an InstanceResource object identified by the given project and instance_id. More...
Project const &	project () const
	Returns the Project containing this instance. More...
std::string const &	project_id () const
std::string const &	instance_id () const
	Returns the Instance ID. More...
std::string	FullName () const
	Returns the fully qualified instance name as a string of the form: "projects/<project-id>/instances/<instance-id>". More...

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

Detailed Description

This class identifies a Cloud Bigtable Instance.

To use Cloud Bigtable, you create instances, which contain clusters that your applications can connect to. Each cluster contains nodes, the compute units that manage your data and perform maintenance tasks. A Cloud Bigtable instance is identified by its project_id and instance_id.

Note

This class makes no effort to validate the components of the instance name. It is the application's responsibility to provide valid project, and instance ids. Passing invalid values will not be checked until the instance name is used in an RPC to Bigtable.

See also

https://cloud.google.com/bigtable/docs/instances-clusters-nodes for an overview of Cloud Bigtable instances, clusters, and nodes.

Constructor & Destructor Documentation

InstanceResource()

google::cloud::bigtable::InstanceResource::InstanceResource	(	Project	project,
		std::string	instance_id
	)

Constructs an InstanceResource object identified by the given project and instance_id.

Member Function Documentation

FullName()

std::string google::cloud::bigtable::InstanceResource::FullName

(

)

const

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

instance_id()

std::string const & google::cloud::bigtable::InstanceResource::instance_id ( ) const

inline

Returns the Instance ID.

project()

Project const & google::cloud::bigtable::InstanceResource::project ( ) const

inline

Returns the Project containing this instance.

project_id()

std::string const & google::cloud::bigtable::InstanceResource::project_id ( ) const

inline

Friends And Related Function Documentation

operator!=

bool operator!= ( InstanceResource const &  a, InstanceResource const &  b  )

friend

operator<<

std::ostream & operator<< ( std::ostream &  , InstanceResource const &    )

friend

Output the FullName() format.

operator==

bool operator== ( InstanceResource const &  a, InstanceResource const &  b  )

friend