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

Class InternalSampler

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.bucket.InternalSingleBucketAggregation

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

All Implemented Interfaces:

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

Direct Known Subclasses:

UnmappedSampler

public class InternalSampler
extends InternalSingleBucketAggregation
implements Sampler

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
static java.lang.String	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
InternalSampler(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getType()
java.lang.String	getWriteableName()	Returns the name of the writeable object
protected InternalSingleBucketAggregation	newAggregation(java.lang.String name, long docCount, InternalAggregations subAggregations)	Create a new empty sub aggregation.

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

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

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

getMetadata, getName, getProperty, isMapped, 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

PARSER_NAME

public static final java.lang.String PARSER_NAME

See Also:

Constant Field Values

Constructor Details

InternalSampler

public InternalSampler(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

getType

public java.lang.String getType()

Specified by:

getType in interface Aggregation

Overrides:

getType in class InternalAggregation

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

newAggregation

protected InternalSingleBucketAggregation newAggregation(java.lang.String name, long docCount, InternalAggregations subAggregations)

Description copied from class: InternalSingleBucketAggregation

Create a new empty sub aggregation. This must be a new instance on each call.

Specified by:

newAggregation in class InternalSingleBucketAggregation