Google Cloud Migration Center V1 Client - Class Aggregation (0.2.0)

Reference documentation and code samples for the Google Cloud Migration Center V1 Client class Aggregation.

Message describing an aggregation. The message includes the aggregation type, parameters, and the field on which to perform the aggregation.

Generated from protobuf message google.cloud.migrationcenter.v1.Aggregation

Namespace

Google \ Cloud \ MigrationCenter \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ field string

The name of the field on which to aggregate.

↳ count Google\Cloud\MigrationCenter\V1\Aggregation\Count

Count the number of matching objects.

↳ sum Google\Cloud\MigrationCenter\V1\Aggregation\Sum

Sum over a numeric field.

↳ histogram Google\Cloud\MigrationCenter\V1\Aggregation\Histogram

Creates a bucketed histogram of field values.

↳ frequency Google\Cloud\MigrationCenter\V1\Aggregation\Frequency

Creates a frequency distribution of all field values.

getField

The name of the field on which to aggregate.

Returns
TypeDescription
string

setField

The name of the field on which to aggregate.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCount

Count the number of matching objects.

Returns
TypeDescription
Google\Cloud\MigrationCenter\V1\Aggregation\Count|null

hasCount

setCount

Count the number of matching objects.

Parameter
NameDescription
var Google\Cloud\MigrationCenter\V1\Aggregation\Count
Returns
TypeDescription
$this

getSum

Sum over a numeric field.

Returns
TypeDescription
Google\Cloud\MigrationCenter\V1\Aggregation\Sum|null

hasSum

setSum

Sum over a numeric field.

Parameter
NameDescription
var Google\Cloud\MigrationCenter\V1\Aggregation\Sum
Returns
TypeDescription
$this

getHistogram

Creates a bucketed histogram of field values.

Returns
TypeDescription
Google\Cloud\MigrationCenter\V1\Aggregation\Histogram|null

hasHistogram

setHistogram

Creates a bucketed histogram of field values.

Parameter
NameDescription
var Google\Cloud\MigrationCenter\V1\Aggregation\Histogram
Returns
TypeDescription
$this

getFrequency

Creates a frequency distribution of all field values.

Returns
TypeDescription
Google\Cloud\MigrationCenter\V1\Aggregation\Frequency|null

hasFrequency

setFrequency

Creates a frequency distribution of all field values.

Parameter
NameDescription
var Google\Cloud\MigrationCenter\V1\Aggregation\Frequency
Returns
TypeDescription
$this

getAggregationFunction

Returns
TypeDescription
string