Package com.google.cloud.bigtable.admin.v2.models

Class GCRules

java.lang.Object

com.google.cloud.bigtable.admin.v2.models.GCRules

@BetaApi
public final class GCRules
extends Object

Wraps GcRule protocol buffer object and exposes a friendly API.

Note: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family. Please use appropriate filters in your reads to exclude cells which are eligible for garbage collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GCRules.DefaultRule	Wrapper for building a empty rule
static final class	GCRules.DurationRule	Wrapper for building max duration rule
static interface	GCRules.GCRule	interface for fluent GcRule wrappers
static final class	GCRules.IntersectionRule	Fluent wrapper for GcRule.Intersection rule.
static final class	GCRules.UnionRule	Fluent wrapper for GcRule.Union rule.
static final class	GCRules.VersionRule	Wrapper for building max versions rule

Field Summary

Fields

Modifier and Type	Field	Description
static final GCRules	GCRULES	Factory method to create GCRules - entry point into the DSL.

Method Summary

Modifier and Type	Method	Description
GCRules.DefaultRule	defaultRule()	Creates an empty default rule
GCRules.GCRule	fromProto(com.google.bigtable.admin.v2.GcRule source)
GCRules.IntersectionRule	intersection()	Creates a new instance of the IntersectionRule
GCRules.DurationRule	maxAge(long maxAge, TimeUnit timeUnit)	Creates a new instance of the DurationRule
GCRules.DurationRule	maxAge(org.threeten.bp.Duration duration)	Creates a new instance of the DurationRule
GCRules.VersionRule	maxVersions(int maxVersion)	Creates a new instance of the VersionRule
GCRules.UnionRule	union()	Creates a new instance of the IntersectionRule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GCRULES

public static final GCRules GCRULES

Factory method to create GCRules - entry point into the DSL.

Method Details

intersection

public GCRules.IntersectionRule intersection()

Creates a new instance of the IntersectionRule

union

public GCRules.UnionRule union()

Creates a new instance of the IntersectionRule

maxVersions

public GCRules.VersionRule maxVersions(int maxVersion)

Creates a new instance of the VersionRule

Parameters:

maxVersion - - maximum number of cell versions to keep

maxAge

public GCRules.DurationRule maxAge(long maxAge,
 TimeUnit timeUnit)

Creates a new instance of the DurationRule

Parameters:

maxAge - - maximum age of the cell to keep

timeUnit - - timeunit for the age

maxAge

public GCRules.DurationRule maxAge(org.threeten.bp.Duration duration)

Creates a new instance of the DurationRule

Parameters:

duration - - age expressed as duration

defaultRule

public GCRules.DefaultRule defaultRule()

Creates an empty default rule

fromProto

@InternalApi
public GCRules.GCRule fromProto(com.google.bigtable.admin.v2.GcRule source)