Class: FilteredAgg

FilteredAgg

Elastic Filtered Aggregation.

link

Constructor

new FilteredAgg(innerAgg, innerFilter, innerAggname)

Parameters:
Name Type Description
innerAgg Aggregation

Aggregation object to be filtered.

innerFilter Filter | obj

Filter object to apply to the innerAgg.

innerAggname string

innerAgg name. Defaults to filteredAggName.

Source:

Extends

Methods

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Defers to innerAgg object.

Type
string

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Defers to innerAgg object.

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:

FilteredAgg

Elastic Filtered Aggregation.

link

Constructor

new FilteredAgg(innerAgg, innerFilter, innerAggname)

Parameters:
Name Type Description
innerAgg Aggregation

Aggregation object to be filtered.

innerFilter Filter | obj

Filter object to apply to the innerAgg.

innerAggname string

innerAgg name. Defaults to filteredAggName.

Source:

Extends

Methods

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Defers to innerAgg object.

Type
string

getName() → {string}

Get the name of the aggregation object.

Overrides:
Source:
Returns:

Name of aggregation. Defers to innerAgg object.

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: