Class: MaxAgg

MaxAgg

Elastic metrics aggregation that calculates the max value for the field.

link

Constructor

new MaxAgg(field)

Parameters:
Name Type Description
field string

Name of field to aggregate on.

Source:

Extends

Methods

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Default to '{{field}}Max'

Type
string

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Default to '{{field}}Max'

Type
string

setName(name)

Attach a name to the aggregation object. Can be used when attaching the aggregation to a query. Convenience method to allow responsibility of the name to be given to the creator of the aggregation object. Can be accessed directly but won't show up during serialization.

Parameters:
Name Type Description
name string

Name of aggregation.

Overrides:
Source:

MaxAgg

Elastic metrics aggregation that calculates the max value for the field.

link

Constructor

new MaxAgg(field)

Parameters:
Name Type Description
field string

Name of field to aggregate on.

Source:

Extends

Methods

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Default to '{{field}}Max'

Type
string

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Default to '{{field}}Max'

Type
string

setName(name)

Attach a name to the aggregation object. Can be used when attaching the aggregation to a query. Convenience method to allow responsibility of the name to be given to the creator of the aggregation object. Can be accessed directly but won't show up during serialization.

Parameters:
Name Type Description
name string

Name of aggregation.

Overrides:
Source: