Cloud Bigtable V2 Client - Class Aggregate (2.6.1)

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.admin.v2.Type.Aggregate

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2 \ Type

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ input_type`	`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`	`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`	`Aggregate\Sum` Sum aggregator.
`↳ hllpp_unique_count`	`Aggregate\HyperLogLogPlusPlusUniqueCount` HyperLogLogPlusPlusUniqueCount aggregator.
`↳ max`	`Aggregate\Max` Max aggregator.
`↳ min`	`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
`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`	`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
`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`	`Type`

Returns
Type	Description
`$this`

getSum

Sum aggregator.

Returns
Type	Description
`Aggregate\Sum\|null`

hasSum

setSum

Sum aggregator.

Parameter
Name	Description
`var`	`Aggregate\Sum`

Returns
Type	Description
`$this`

getHllppUniqueCount

HyperLogLogPlusPlusUniqueCount aggregator.

Returns
Type	Description
`Aggregate\HyperLogLogPlusPlusUniqueCount\|null`

hasHllppUniqueCount

setHllppUniqueCount

HyperLogLogPlusPlusUniqueCount aggregator.

Parameter
Name	Description
`var`	`Aggregate\HyperLogLogPlusPlusUniqueCount`

Returns
Type	Description
`$this`

getMax

Max aggregator.

Returns
Type	Description
`Aggregate\Max\|null`

hasMax

setMax

Max aggregator.

Parameter
Name	Description
`var`	`Aggregate\Max`

Returns
Type	Description
`$this`

getMin

Min aggregator.

Returns
Type	Description
`Aggregate\Min\|null`

hasMin

setMin

Min aggregator.

Parameter
Name	Description
`var`	`Aggregate\Min`

Returns
Type	Description
`$this`

getAggregator

Returns
Type	Description
`string`