Google Cloud Bigtable C++ Client  2.1.0
A C++ Client Library for Google Cloud Bigtable
Public Member Functions | Static Public Member Functions | List of all members
google::cloud::bigtable::ColumnFamilyModification Class Reference

Define the interfaces to create column family modifications. More...

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

Public Member Functions

::google::bigtable::admin::v2::ModifyColumnFamiliesRequest::Modification const & as_proto () const &
 Convert to the proto form. More...
 
::google::bigtable::admin::v2::ModifyColumnFamiliesRequest::Modification && as_proto () &&
 Move out the underlying proto contents. More...
 

Static Public Member Functions

static ColumnFamilyModification Create (std::string id, GcRule gc)
 Return a modification that creates a new column family. More...
 
static ColumnFamilyModification Update (std::string id, GcRule gc)
 Return a modification that creates a new column family. More...
 
static ColumnFamilyModification Drop (std::string id)
 Return a modification that drops the id column family. More...
 

Use default constructors and assignments.

 ColumnFamilyModification (ColumnFamilyModification &&)=default
 
ColumnFamilyModificationoperator= (ColumnFamilyModification &&)=default
 
 ColumnFamilyModification (ColumnFamilyModification const &)=default
 
ColumnFamilyModificationoperator= (ColumnFamilyModification const &)=default
 

Detailed Description

Define the interfaces to create column family modifications.

Applications can modify a Cloud Bigtable schema through a set of column family modifications. These modifications may include creating new column families, deleting existing column families, or changing the garbage collection rules for existing column families.

This class contain helper functions to create the different protos encapsulating these changes.

Definition at line 169 of file column_family.h.

Constructor & Destructor Documentation

◆ ColumnFamilyModification() [1/2]

google::cloud::bigtable::ColumnFamilyModification::ColumnFamilyModification ( ColumnFamilyModification &&  )
default

◆ ColumnFamilyModification() [2/2]

google::cloud::bigtable::ColumnFamilyModification::ColumnFamilyModification ( ColumnFamilyModification const &  )
default

Member Function Documentation

◆ as_proto() [1/2]

::google::bigtable::admin::v2::ModifyColumnFamiliesRequest::Modification&& google::cloud::bigtable::ColumnFamilyModification::as_proto ( ) &&
inline

Move out the underlying proto contents.

Definition at line 204 of file column_family.h.

◆ as_proto() [2/2]

::google::bigtable::admin::v2::ModifyColumnFamiliesRequest:: Modification const& google::cloud::bigtable::ColumnFamilyModification::as_proto ( ) const &
inline

Convert to the proto form.

Definition at line 198 of file column_family.h.

◆ Create()

static ColumnFamilyModification google::cloud::bigtable::ColumnFamilyModification::Create ( std::string  id,
GcRule  gc 
)
inlinestatic

Return a modification that creates a new column family.

Definition at line 172 of file column_family.h.

◆ Drop()

static ColumnFamilyModification google::cloud::bigtable::ColumnFamilyModification::Drop ( std::string  id)
inlinestatic

Return a modification that drops the id column family.

Definition at line 188 of file column_family.h.

◆ operator=() [1/2]

ColumnFamilyModification& google::cloud::bigtable::ColumnFamilyModification::operator= ( ColumnFamilyModification &&  )
default

◆ operator=() [2/2]

ColumnFamilyModification& google::cloud::bigtable::ColumnFamilyModification::operator= ( ColumnFamilyModification const &  )
default

◆ Update()

static ColumnFamilyModification google::cloud::bigtable::ColumnFamilyModification::Update ( std::string  id,
GcRule  gc 
)
inlinestatic

Return a modification that creates a new column family.

Definition at line 180 of file column_family.h.