Cloud Bigtable V2 Client - Class Family (1.24.1)

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
Name	Description
`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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getColumns

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setColumns

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

Parameter
Name	Description
`var`	`array<Google\Cloud\Bigtable\V2\Column>`

Returns
Type	Description
`$this`