Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.timeseries

Class TimeSeriesAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<TimeSeriesAggregationBuilder>

org.elasticsearch.search.aggregations.timeseries.TimeSeriesAggregationBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class TimeSeriesAggregationBuilder
extends AbstractAggregationBuilder<TimeSeriesAggregationBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 ParseField	KEYED_FIELD
static final String	NAME
static final InstantiatingObjectParser<TimeSeriesAggregationBuilder,String>	PARSER

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	TimeSeriesAggregationBuilder(String name)
	TimeSeriesAggregationBuilder(String name, Boolean keyed)
	TimeSeriesAggregationBuilder(StreamInput in)
protected	TimeSeriesAggregationBuilder(TimeSeriesAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected AggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object o)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
boolean	isInSortOrderExecutionRequired()	Return true if any of the child aggregations is a time-series aggregation that requires an in-order execution
boolean	isKeyed()
void	setKeyed(boolean keyed)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, supportsSampling, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

KEYED_FIELD

public static final ParseField KEYED_FIELD

PARSER

public static final InstantiatingObjectParser<TimeSeriesAggregationBuilder,String> PARSER

Constructor Details

TimeSeriesAggregationBuilder

public TimeSeriesAggregationBuilder(String name)

TimeSeriesAggregationBuilder

public TimeSeriesAggregationBuilder(String name,
 Boolean keyed)

TimeSeriesAggregationBuilder

protected TimeSeriesAggregationBuilder(TimeSeriesAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

TimeSeriesAggregationBuilder

public TimeSeriesAggregationBuilder(StreamInput in)
                             throws IOException

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<TimeSeriesAggregationBuilder>

Throws:

IOException

doBuild

protected AggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                             throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<TimeSeriesAggregationBuilder>

Throws:

IOException

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
 ToXContent.Params params)
                                    throws IOException

Specified by:

internalXContent in class AbstractAggregationBuilder<TimeSeriesAggregationBuilder>

Throws:

IOException

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

isInSortOrderExecutionRequired

public boolean isInSortOrderExecutionRequired()

Description copied from class: AggregationBuilder

Return true if any of the child aggregations is a time-series aggregation that requires an in-order execution

Overrides:

isInSortOrderExecutionRequired in class AggregationBuilder

isKeyed

public boolean isKeyed()

setKeyed

public void setKeyed(boolean keyed)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractAggregationBuilder<TimeSeriesAggregationBuilder>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<TimeSeriesAggregationBuilder>

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to