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
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 | |