Package org.opensearch.search.aggregations.bucket.filter

Class InternalFilters

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.InternalMultiBucketAggregation<InternalFilters,InternalFilters.InternalBucket>

org.opensearch.search.aggregations.bucket.filter.InternalFilters

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, Filters, MultiBucketsAggregation

public class InternalFilters
extends InternalMultiBucketAggregation<InternalFilters,InternalFilters.InternalBucket>
implements Filters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalFilters.InternalBucket

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.filter.Filters

Filters.Bucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.MultiBucketsAggregation

MultiBucketsAggregation.Bucket

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalFilters(java.lang.String name, java.util.List<InternalFilters.InternalBucket> buckets, boolean keyed, java.util.Map<java.lang.String,java.lang.Object> metadata)
InternalFilters(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
InternalFilters	create(java.util.List<InternalFilters.InternalBucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
InternalFilters.InternalBucket	createBucket(InternalAggregations aggregations, InternalFilters.InternalBucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected void	doWriteTo(StreamOutput out)
org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean	equals(java.lang.Object obj)
InternalFilters.InternalBucket	getBucketByKey(java.lang.String key)
java.util.List<InternalFilters.InternalBucket>	getBuckets()	The buckets created by this aggregation.
java.lang.String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
InternalAggregation	reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected InternalFilters.InternalBucket	reduceBucket(java.util.List<InternalFilters.InternalBucket> buckets, InternalAggregation.ReduceContext context)	Reduce a list of same-keyed buckets (from multiple shards) to a single bucket.

Methods inherited from class org.opensearch.search.aggregations.InternalMultiBucketAggregation

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelines

Methods inherited from class org.opensearch.search.aggregations.InternalAggregation

getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, sortValue, sortValue, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.opensearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalFilters

public InternalFilters(java.lang.String name, java.util.List<InternalFilters.InternalBucket> buckets, boolean keyed, java.util.Map<java.lang.String,java.lang.Object> metadata)

InternalFilters

public InternalFilters(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out) throws java.io.IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

create

public InternalFilters create(java.util.List<InternalFilters.InternalBucket> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<InternalFilters,InternalFilters.InternalBucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public InternalFilters.InternalBucket createBucket(InternalAggregations aggregations, InternalFilters.InternalBucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<InternalFilters,InternalFilters.InternalBucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

getBuckets

public java.util.List<InternalFilters.InternalBucket> getBuckets()

Description copied from interface: Filters

The buckets created by this aggregation.

Specified by:

getBuckets in interface Filters

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in class InternalMultiBucketAggregation<InternalFilters,InternalFilters.InternalBucket>

Returns:

The buckets of this aggregation.

getBucketByKey

public InternalFilters.InternalBucket getBucketByKey(java.lang.String key)

Specified by:

getBucketByKey in interface Filters

reduce

public InternalAggregation reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

See Also:

InternalAggregation.mustReduceOnSingleInternalAgg()

reduceBucket

protected InternalFilters.InternalBucket reduceBucket(java.util.List<InternalFilters.InternalBucket> buckets, InternalAggregation.ReduceContext context)

Description copied from class: InternalMultiBucketAggregation

Reduce a list of same-keyed buckets (from multiple shards) to a single bucket. This requires all buckets to have the same key.

Specified by:

reduceBucket in class InternalMultiBucketAggregation<InternalFilters,InternalFilters.InternalBucket>

doXContentBody

public org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class InternalAggregation