Cloud Bigtable V2 Client - Class Aggregate (1.31.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`	`Google\Cloud\Bigtable\Admin\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\Admin\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\Admin\V2\Type\Aggregate\Sum` Sum 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\Admin\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\Admin\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\Admin\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\Admin\V2\Type`

Returns
Type	Description
`$this`

getSum

Sum aggregator.

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

hasSum

setSum

Sum aggregator.

Parameter
Name	Description
`var`	`Google\Cloud\Bigtable\Admin\V2\Type\Aggregate\Sum`

Returns
Type	Description
`$this`

getAggregator

Returns
Type	Description
`string`