# Cloud Bigtable V2 Client - Class Aggregate (2.25.0)

2.25.0 (latest) 2.24.0 2.23.0 2.22.0 2.21.1 2.20.2 2.19.2 2.18.0 2.17.1 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.1 2.9.1 2.8.0 2.7.0 2.6.3 2.5.0 2.4.0 2.3.0 2.2.1 2.1.0 2.0.1 1.32.1 1.31.1 1.30.0 1.29.2 1.28.3 1.27.0 1.26.2 1.25.0 1.24.1 1.23.0 1.22.2 1.21.1 1.20.3 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
provide either the `input_type` or `state_type`, and reads 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` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type` Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. |
| `↳ state_type` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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. |
| `↳ sum` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Sum` Sum aggregator. |
| `↳ hllpp_unique_count` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.HyperLogLogPlusPlusUniqueCount` HyperLogLogPlusPlusUniqueCount aggregator. |
| `↳ max` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Max` Max aggregator. |
| `↳ min` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Min` Min aggregator. |

### getInputType

Type of the inputs that are accumulated by this `Aggregate`.

Use `AddInput` mutations to accumulate new inputs.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type|null` |   |

### hasInputType

### clearInputType

### setInputType

Type of the inputs that are accumulated by this `Aggregate`.

Use `AddInput` mutations to accumulate new inputs.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSum

Sum aggregator.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Sum|null` |   |

### hasSum

### setSum

Sum aggregator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Sum` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getHllppUniqueCount

HyperLogLogPlusPlusUniqueCount aggregator.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.HyperLogLogPlusPlusUniqueCount|null` |   |

### hasHllppUniqueCount

### setHllppUniqueCount

HyperLogLogPlusPlusUniqueCount aggregator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.HyperLogLogPlusPlusUniqueCount` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMax

Max aggregator.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Max|null` |   |

### hasMax

### setMax

Max aggregator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Max` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMin

Min aggregator.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Min|null` |   |

### hasMin

### setMin

Min aggregator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/V2.Type.Aggregate.Min` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAggregator

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |