Package org.elasticsearch.search.aggregations.bucket.sampler.random

Class InternalRandomSampler

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.InternalSingleBucketAggregation

org.elasticsearch.search.aggregations.bucket.sampler.random.InternalRandomSampler

All Implemented Interfaces:

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

public class InternalRandomSampler
extends InternalSingleBucketAggregation
implements Sampler

Nested Class Summary

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

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final String	PARSER_NAME

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

metadata, name

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

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalRandomSampler(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
SamplingContext	buildContext()
protected void	doWriteTo(StreamOutput out)
org.elasticsearch.xcontent.XContentBuilder	doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
String	getType()
String	getWriteableName()	Returns the name of the writeable object
protected InternalSingleBucketAggregation	newAggregation(String name, long docCount, InternalAggregations subAggregations)	Create a new empty sub aggregation.
InternalAggregation	reduce(List<InternalAggregation> aggregations, AggregationReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.

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

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

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

finalizeSampling, getMetadata, getName, getProperty, isMapped, 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.elasticsearch.search.aggregations.Aggregation

getMetadata, getName

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

getAggregations, getDocCount

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PARSER_NAME

public static final String PARSER_NAME

See Also:

• Constant Field Values

Constructor Details

InternalRandomSampler

public InternalRandomSampler(StreamInput in)
                      throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Overrides:

doWriteTo in class InternalSingleBucketAggregation

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

getType

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

reduce

public InternalAggregation reduce(List<InternalAggregation> aggregations,
 AggregationReduceContext 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()

buildContext

public SamplingContext buildContext()

doXContentBody

public org.elasticsearch.xcontent.XContentBuilder doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                          throws IOException

Overrides:

doXContentBody in class InternalSingleBucketAggregation

Throws:

IOException