Cloud Bigtable V2 Client - Class MergeToCell (2.2.1)

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

A Mutation which merges accumulated state into a cell in an Aggregate family.

Generated from protobuf message google.bigtable.v2.Mutation.MergeToCell

Namespace

Google \ Cloud \ Bigtable \ V2 \ Mutation

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ family_name string

The name of the Aggregate family into which new data should be added. This must be a family with a value_type of Aggregate. Format: [-_.a-zA-Z0-9]+

↳ column_qualifier Google\Cloud\Bigtable\V2\Value

The qualifier of the column into which new data should be added. This must be a raw_value.

↳ timestamp Google\Cloud\Bigtable\V2\Value

The timestamp of the cell to which new data should be added. This must be a raw_timestamp_micros that matches the table's granularity.

↳ input Google\Cloud\Bigtable\V2\Value

The input value to be merged into the specified cell. This must be compatible with the family's value_type.state_type. Merging NULL is allowed, but has no effect.

getFamilyName

The name of the Aggregate family into which new data should be added.

This must be a family with a value_type of Aggregate. Format: [-_.a-zA-Z0-9]+

Returns
Type Description
string

setFamilyName

The name of the Aggregate family into which new data should be added.

This must be a family with a value_type of Aggregate. Format: [-_.a-zA-Z0-9]+

Parameter
Name Description
var string
Returns
Type Description
$this

getColumnQualifier

The qualifier of the column into which new data should be added. This must be a raw_value.

Returns
Type Description
Google\Cloud\Bigtable\V2\Value|null

hasColumnQualifier

clearColumnQualifier

setColumnQualifier

The qualifier of the column into which new data should be added. This must be a raw_value.

Parameter
Name Description
var Google\Cloud\Bigtable\V2\Value
Returns
Type Description
$this

getTimestamp

The timestamp of the cell to which new data should be added. This must be a raw_timestamp_micros that matches the table's granularity.

Returns
Type Description
Google\Cloud\Bigtable\V2\Value|null

hasTimestamp

clearTimestamp

setTimestamp

The timestamp of the cell to which new data should be added. This must be a raw_timestamp_micros that matches the table's granularity.

Parameter
Name Description
var Google\Cloud\Bigtable\V2\Value
Returns
Type Description
$this

getInput

The input value to be merged into the specified cell. This must be compatible with the family's value_type.state_type. Merging NULL is allowed, but has no effect.

Returns
Type Description
Google\Cloud\Bigtable\V2\Value|null

hasInput

clearInput

setInput

The input value to be merged into the specified cell. This must be compatible with the family's value_type.state_type. Merging NULL is allowed, but has no effect.

Parameter
Name Description
var Google\Cloud\Bigtable\V2\Value
Returns
Type Description
$this