Cloud Bigtable V2 Client - Class Family (1.27.0)

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

Specifies (some of) the contents of a single row/column family intersection of a table.

Generated from protobuf message google.bigtable.v2.Family

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field. Must match [-_.a-zA-Z0-9]+, except that AggregatingRowProcessors may produce cells in a sentinel family with an empty name. Must be no greater than 64 characters in length.

↳ columns array<Google\Cloud\Bigtable\V2\Column>

Must not be empty. Sorted in order of increasing "qualifier".

getName

The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field.

Must match [-_.a-zA-Z0-9]+, except that AggregatingRowProcessors may produce cells in a sentinel family with an empty name. Must be no greater than 64 characters in length.

Returns
TypeDescription
string

setName

The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field.

Must match [-_.a-zA-Z0-9]+, except that AggregatingRowProcessors may produce cells in a sentinel family with an empty name. Must be no greater than 64 characters in length.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getColumns

Must not be empty. Sorted in order of increasing "qualifier".

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setColumns

Must not be empty. Sorted in order of increasing "qualifier".

Parameter
NameDescription
var array<Google\Cloud\Bigtable\V2\Column>
Returns
TypeDescription
$this