Cloud Bigtable V2 Client - Class Aggregate (2.3.0)

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

A value that combines incremental updates into a summarized value.

Data is never directly written or read using type Aggregate. Writes will provide either the input_type or state_type, and reads will always return the state_type .

Generated from protobuf message google.bigtable.v2.Type.Aggregate

Namespace

Google \ Cloud \ Bigtable \ V2 \ Type

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ input_type Google\Cloud\Bigtable\V2\Type

Type of the inputs that are accumulated by this Aggregate, which must specify a full encoding. Use AddInput mutations to accumulate new inputs.
↳ state_type Google\Cloud\Bigtable\V2\Type

Output only. Type that holds the internal accumulator state for the Aggregate. This is a function of the input_type and aggregator chosen, and will always specify a full encoding.
↳ sum Google\Cloud\Bigtable\V2\Type\Aggregate\Sum

Sum aggregator.
↳ hllpp_unique_count Google\Cloud\Bigtable\V2\Type\Aggregate\HyperLogLogPlusPlusUniqueCount

HyperLogLogPlusPlusUniqueCount aggregator.
↳ max Google\Cloud\Bigtable\V2\Type\Aggregate\Max

Max aggregator.
↳ min Google\Cloud\Bigtable\V2\Type\Aggregate\Min

Min aggregator.

getInputType

Type of the inputs that are accumulated by this Aggregate, which must specify a full encoding.

Use AddInput mutations to accumulate new inputs.

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

hasInputType

clearInputType

setInputType

Type of the inputs that are accumulated by this Aggregate, which must specify a full encoding.

Use AddInput mutations to accumulate new inputs.

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

getStateType

Output only. Type that holds the internal accumulator state for the Aggregate. This is a function of the input_type and aggregator chosen, and will always specify a full encoding.

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

hasStateType

clearStateType

setStateType

Output only. Type that holds the internal accumulator state for the Aggregate. This is a function of the input_type and aggregator chosen, and will always specify a full encoding.

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

getSum

Sum aggregator.

Returns
Type Description
Google\Cloud\Bigtable\V2\Type\Aggregate\Sum|null

hasSum

setSum

Sum aggregator.

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

getHllppUniqueCount

HyperLogLogPlusPlusUniqueCount aggregator.

Returns
Type Description
Google\Cloud\Bigtable\V2\Type\Aggregate\HyperLogLogPlusPlusUniqueCount|null

hasHllppUniqueCount

setHllppUniqueCount

HyperLogLogPlusPlusUniqueCount aggregator.

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

getMax

Max aggregator.

Returns
Type Description
Google\Cloud\Bigtable\V2\Type\Aggregate\Max|null

hasMax

setMax

Max aggregator.

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

getMin

Min aggregator.

Returns
Type Description
Google\Cloud\Bigtable\V2\Type\Aggregate\Min|null

hasMin

setMin

Min aggregator.

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

getAggregator

Returns
Type Description
string