Module org.elasticsearch.server
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
Modifier and TypeFieldDescriptionstatic final ParseField
static final String
static final InstantiatingObjectParser<TimeSeriesAggregationBuilder,
String> 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
ModifierConstructorDescriptionTimeSeriesAggregationBuilder
(String name, Boolean keyed) protected
TimeSeriesAggregationBuilder
(TimeSeriesAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionA rough count of the number of buckets thatAggregator
s 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
The minimal version of the recipient this object can be sent togetType()
The name of the type of aggregation built by this builder.int
hashCode()
protected XContentBuilder
internalXContent
(XContentBuilder builder, ToXContent.Params params) boolean
Return true if any of the child aggregations is a time-series aggregation that requires an in-order executionboolean
isKeyed()
void
setKeyed
(boolean keyed) protected AggregationBuilder
shallowCopy
(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetadata
.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
- See Also:
-
KEYED_FIELD
-
PARSER
-
-
Constructor Details
-
TimeSeriesAggregationBuilder
-
TimeSeriesAggregationBuilder
-
TimeSeriesAggregationBuilder
protected TimeSeriesAggregationBuilder(TimeSeriesAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
TimeSeriesAggregationBuilder
- Throws:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractAggregationBuilder<TimeSeriesAggregationBuilder>
- Throws:
IOException
-
doBuild
protected AggregatorFactory doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws IOException - Specified by:
doBuild
in classAbstractAggregationBuilder<TimeSeriesAggregationBuilder>
- Throws:
IOException
-
internalXContent
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
internalXContent
in classAbstractAggregationBuilder<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 replacingAggregationBuilder.factoriesBuilder
andmetadata
. Used byAggregationBuilder.rewrite(QueryRewriteContext)
.- Specified by:
shallowCopy
in classAggregationBuilder
-
bucketCardinality
Description copied from class:AggregationBuilder
A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinality
in classAggregationBuilder
-
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 classAggregationBuilder
-
isKeyed
public boolean isKeyed() -
setKeyed
public void setKeyed(boolean keyed) -
equals
- Overrides:
equals
in classAbstractAggregationBuilder<TimeSeriesAggregationBuilder>
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractAggregationBuilder<TimeSeriesAggregationBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteable
The minimal version of the recipient this object can be sent to
-