Class GcRule (2.20.0)

Implement a thin wrapper around google::bigtable::admin::v2::GcRule.

Provides functions to create GcRules in a convenient form.

Constructors

GcRule(GcRule &&)

Use default constructors and assignments.

Parameter
Name Description
GcRule &&

GcRule(GcRule const &)

Use default constructors and assignments.

Parameter
Name Description
GcRule const &

Operators

operator=(GcRule &&)

Use default constructors and assignments.

Parameter
Name Description
GcRule &&
Returns
Type Description
GcRule &

operator=(GcRule const &)

Use default constructors and assignments.

Parameter
Name Description
GcRule const &
Returns
Type Description
GcRule &

Functions

static MaxNumVersions(std::int32_t)

Create a garbage collection rule that keeps the last n versions.

Parameter
Name Description
n std::int32_t
Returns
Type Description
GcRule

static MaxAge(std::chrono::duration< Rep, Period >)

Return a garbage collection rule that deletes cells in a column older than the given duration.

The function accepts any instantiation of std::chrono::duration<> for the duration parameter. For example:

auto rule1 = bigtable::GcRule::MaxAge(std::chrono::hours(48));
auto rule2 = bigtable::GcRule::MaxAge(std::chrono::seconds(48 * 3600));
See Also

std::chrono::duration<> for more details.

Parameters
Name Description
duration std::chrono::duration< Rep, Period >
typename Rep

a placeholder to match the Rep tparam for duration type, the semantics of this template parameter are documented in std::chrono::duration<> (in brief, the underlying arithmetic type used to store the number of ticks), for our purposes it is simply a formal parameter.

typename Period

a placeholder to match the Period tparam for duration type, the semantics of this template parameter are documented in std::chrono::duration<> (in brief, the length of the tick in seconds, expressed as a std::ratio<>), for our purposes it is simply a formal parameter.
Returns
Type Description
GcRule

static Intersection(GcRuleTypes &&...)

Return a GcRule that deletes cells if all the rules passed in would delete the cells.

Parameters
Name Description
gc_rules GcRuleTypes &&...

the set of GC rules.

typename...
Returns
Type Description
GcRule

static Union(GcRuleTypes &&...)

Return a GcRule that deletes cells if any the rules passed in would delete the cells.

Parameters
Name Description
gc_rules GcRuleTypes &&...

the set of GC rules.

typename...
Returns
Type Description
GcRule

as_proto() const &

Convert to the proto form.

Returns
Type Description
google::bigtable::admin::v2::GcRule const &

as_proto() &&

Move the internal proto out.

Returns
Type Description
google::bigtable::admin::v2::GcRule &&