2.2.0 (latest) 2.0.6 1.34.2 1.33.1 1.32.3 1.31.0 1.30.0 1.29.2 1.28.2 1.26.0 1.25.0 1.24.4 1.23.0 1.22.1 1.21.2 1.19.0 1.18.1 1.17.1 Reference documentation and code samples for the Cloud Datastore V1 Client class Aggregation.

Defines an aggregation that produces a single result.

Generated from protobuf message `google.datastore.v1.AggregationQuery.Aggregation`

## Namespace

Google \\ Cloud \\ Datastore \\ V1 \\ AggregationQuery

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ count` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Count` Count aggregator. |
| `↳ sum` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Sum` Sum aggregator. |
| `↳ avg` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Avg` Average aggregator. |
| `↳ alias` | `string` Optional. Optional name of the property to store the result of the aggregation. If not provided, Datastore will pick a default name following the format `property_<incremental_id++>`. For example: `AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) OVER ( ... );` becomes: `AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2 OVER ( ... );` Requires: \* \* Must be unique across all aggregation aliases. \* \* Conform to [entity property name](https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Entity#_Google_Cloud_Datastore_V1_Entity__getProperties__) limitations. |

### getCount

Count aggregator.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Count|null` |   |

### hasCount

### setCount

Count aggregator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Count` |

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

### getSum

Sum aggregator.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Sum|null` |   |

### hasSum

### setSum

Sum aggregator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Sum` |

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

### getAvg

Average aggregator.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Avg|null` |   |

### hasAvg

### setAvg

Average aggregator.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.AggregationQuery.Aggregation.Avg` |

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

### getAlias

Optional. Optional name of the property to store the result of the
aggregation.

If not provided, Datastore will pick a default name following the format
`property_<incremental_id++>`. For example:

    AGGREGATE
      COUNT_UP_TO(1) AS count_up_to_1,
      COUNT_UP_TO(2),
      COUNT_UP_TO(3) AS count_up_to_3,
      COUNT(*)
    OVER (
      ...
    );

becomes:

    AGGREGATE
      COUNT_UP_TO(1) AS count_up_to_1,
      COUNT_UP_TO(2) AS property_1,
      COUNT_UP_TO(3) AS count_up_to_3,
      COUNT(*) AS property_2
    OVER (
      ...
    );

Requires:

- Must be unique across all aggregation aliases.
- Conform to [entity property
  name](https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Entity#_Google_Cloud_Datastore_V1_Entity__getProperties__) limitations.

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

### setAlias

Optional. Optional name of the property to store the result of the
aggregation.

If not provided, Datastore will pick a default name following the format
`property_<incremental_id++>`. For example:

    AGGREGATE
      COUNT_UP_TO(1) AS count_up_to_1,
      COUNT_UP_TO(2),
      COUNT_UP_TO(3) AS count_up_to_3,
      COUNT(*)
    OVER (
      ...
    );

becomes:

    AGGREGATE
      COUNT_UP_TO(1) AS count_up_to_1,
      COUNT_UP_TO(2) AS property_1,
      COUNT_UP_TO(3) AS count_up_to_3,
      COUNT(*) AS property_2
    OVER (
      ...
    );

Requires:

- Must be unique across all aggregation aliases.
- Conform to [entity property
  name](https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Entity#_Google_Cloud_Datastore_V1_Entity__getProperties__) limitations.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getOperator

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