Package org.opensearch.search.aggregations.bucket.sampler

Class UnmappedSampler

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.bucket.InternalSingleBucketAggregation

org.opensearch.search.aggregations.bucket.sampler.InternalSampler

org.opensearch.search.aggregations.bucket.sampler.UnmappedSampler

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, Sampler, SingleBucketAggregation, HasAggregations

public class UnmappedSampler
extends InternalSampler

Nested Class Summary

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.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

Modifier and Type	Field	Description
static java.lang.String	NAME

Fields inherited from class org.opensearch.search.aggregations.bucket.sampler.InternalSampler

PARSER_NAME

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
UnmappedSampler(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
java.lang.String	getWriteableName()	Returns the name of the writeable object
boolean	isMapped()	Return true if this aggregation is mapped, and can lead a reduction.
InternalAggregation	reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.

Methods inherited from class org.opensearch.search.aggregations.bucket.sampler.InternalSampler

getType, newAggregation

Methods inherited from class org.opensearch.search.aggregations.bucket.InternalSingleBucketAggregation

copyWithRewritenBuckets, create, doWriteTo, equals, forEachBucket, getAggregations, getDocCount, getProperty, hashCode, mustReduceOnSingleInternalAgg, reducePipelines, sortValue, sortValue

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

getMetadata, getName, getProperty, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, 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

Methods inherited from interface org.opensearch.search.aggregations.bucket.SingleBucketAggregation

getAggregations, getDocCount

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

toXContent

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

isFragment

Field Details

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Details

UnmappedSampler

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

Read from a stream.

Throws:

java.io.IOException

Method Details

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Overrides:

getWriteableName in class InternalSampler

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.

Overrides:

reduce in class InternalSingleBucketAggregation

See Also:

InternalAggregation.mustReduceOnSingleInternalAgg()

isMapped

public boolean isMapped()

Description copied from class: InternalAggregation

Return true if this aggregation is mapped, and can lead a reduction. If this agg returns false, it should return itself if asked to lead a reduction

Overrides:

isMapped in class InternalAggregation

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

Overrides:

doXContentBody in class InternalSingleBucketAggregation

Throws:

java.io.IOException