Cloud Bigtable V2 Client - Class ColumnFamily (1.28.3)

Version 1.28.3

• 2.6.1 (latest)
• 2.6.0
• 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 ColumnFamily.

A set of columns within a table which share a common configuration.

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

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ gc_rule	Google\Cloud\Bigtable\Admin\V2\GcRule Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. 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.

getGcRule

Garbage collection rule specified as a protobuf.

Must serialize to at most 500 bytes. 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.

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

hasGcRule

clearGcRule

setGcRule

Garbage collection rule specified as a protobuf.

Must serialize to at most 500 bytes. 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.

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

Returns
Type	Description
$this