Cloud Bigtable V2 Client - Class GcRule (1.29.2)

Version 1.29.2

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

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
Name	Description
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
Type	Description
int

hasMaxNumVersions

setMaxNumVersions

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

Parameter
Name	Description
var	int

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getIntersection

Delete cells that would be deleted by every nested rule.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\GcRule\Intersection|null

hasIntersection

setIntersection

Delete cells that would be deleted by every nested rule.

Parameter
Name	Description
var	Google\Cloud\Bigtable\Admin\V2\GcRule\Intersection

Returns
Type	Description
$this

getUnion

Delete cells that would be deleted by any nested rule.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\GcRule\Union|null

hasUnion

setUnion

Delete cells that would be deleted by any nested rule.

Parameter
Name	Description
var	Google\Cloud\Bigtable\Admin\V2\GcRule\Union

Returns
Type	Description
$this

getRule

Returns
Type	Description
string