Google Cloud Bigtable C++ Client  0.11.0
A C++ Client Library for Google Cloud Bigtable
Public Member Functions | Static Public Member Functions | List of all members
google::cloud::bigtable::v0::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...
 
Use default constructors and assignments.
 ColumnFamilyModification (ColumnFamilyModification &&) noexcept=default
 
ColumnFamilyModificationoperator= (ColumnFamilyModification &&) noexcept=default
 
 ColumnFamilyModification (ColumnFamilyModification const &)=default
 
ColumnFamilyModificationoperator= (ColumnFamilyModification const &)=default
 

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...
 

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 170 of file column_family.h.

Constructor & Destructor Documentation

◆ ColumnFamilyModification() [1/2]

google::cloud::bigtable::v0::ColumnFamilyModification::ColumnFamilyModification ( ColumnFamilyModification &&  )
defaultnoexcept

◆ ColumnFamilyModification() [2/2]

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

Member Function Documentation

◆ as_proto() [1/2]

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

Convert to the proto form.

Definition at line 199 of file column_family.h.

◆ as_proto() [2/2]

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

Move out the underlying proto contents.

Definition at line 205 of file column_family.h.

◆ Create()

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

Return a modification that creates a new column family.

Definition at line 173 of file column_family.h.

◆ Drop()

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

Return a modification that drops the id column family.

Definition at line 189 of file column_family.h.

◆ operator=() [1/2]

ColumnFamilyModification& google::cloud::bigtable::v0::ColumnFamilyModification::operator= ( ColumnFamilyModification &&  )
defaultnoexcept

◆ operator=() [2/2]

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

◆ Update()

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

Return a modification that creates a new column family.

Definition at line 181 of file column_family.h.