Cloud Bigtable V2 Client - Class GcRule (1.27.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class GcRule.

Rule for determining which cells to delete during garbage collection.

Generated from protobuf message google.bigtable.admin.v2.GcRule

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ max_num_versions int

Delete all cells in a column except the most recent N.

↳ max_age Google\Protobuf\Duration

Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.

↳ intersection Google\Cloud\Bigtable\Admin\V2\GcRule\Intersection

Delete cells that would be deleted by every nested rule.

↳ union Google\Cloud\Bigtable\Admin\V2\GcRule\Union

Delete cells that would be deleted by any nested rule.

getMaxNumVersions

Delete all cells in a column except the most recent N.

Returns
TypeDescription
int

hasMaxNumVersions

setMaxNumVersions

Delete all cells in a column except the most recent N.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMaxAge

Delete cells in a column older than the given age.

Values must be at least one millisecond, and will be truncated to microsecond granularity.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasMaxAge

setMaxAge

Delete cells in a column older than the given age.

Values must be at least one millisecond, and will be truncated to microsecond granularity.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getIntersection

Delete cells that would be deleted by every nested rule.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\GcRule\Intersection|null

hasIntersection

setIntersection

Delete cells that would be deleted by every nested rule.

Parameter
NameDescription
var Google\Cloud\Bigtable\Admin\V2\GcRule\Intersection
Returns
TypeDescription
$this

getUnion

Delete cells that would be deleted by any nested rule.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\GcRule\Union|null

hasUnion

setUnion

Delete cells that would be deleted by any nested rule.

Parameter
NameDescription
var Google\Cloud\Bigtable\Admin\V2\GcRule\Union
Returns
TypeDescription
$this

getRule

Returns
TypeDescription
string