Class CompositeAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<CompositeAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.composite.CompositeAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,BaseAggregationBuilder
public class CompositeAggregationBuilder extends AbstractAggregationBuilder<CompositeAggregationBuilder>
-
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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.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 org.elasticsearch.common.ParseField
AFTER_FIELD_NAME
static java.lang.String
NAME
static org.elasticsearch.common.xcontent.ConstructingObjectParser<CompositeAggregationBuilder,java.lang.String>
PARSER
static org.elasticsearch.common.ParseField
SIZE_FIELD_NAME
static org.elasticsearch.common.ParseField
SOURCES_FIELD_NAME
Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadata
Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
factoriesBuilder, name
-
Constructor Summary
Constructors Modifier Constructor Description CompositeAggregationBuilder(java.lang.String name, java.util.List<CompositeValuesSourceBuilder<?>> sources)
CompositeAggregationBuilder(StreamInput in)
protected
CompositeAggregationBuilder(CompositeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
Method Summary
Modifier and Type Method Description CompositeAggregationBuilder
aggregateAfter(java.util.Map<java.lang.String,java.lang.Object> afterKey)
Sets the values that indicates which composite bucket this request should "aggregate after".AggregationBuilder.BucketCardinality
bucketCardinality()
Do aggregations built by this builder contain buckets? If so, do they contain *always* contain a single bucket?protected AggregatorFactory
doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder)
protected void
doWriteTo(StreamOutput out)
boolean
equals(java.lang.Object obj)
java.lang.String
getType()
The name of the type of aggregation built by this builder.int
hashCode()
protected org.elasticsearch.common.xcontent.XContentBuilder
internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
protected AggregationBuilder
shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetadata
.int
size()
CompositeAggregationBuilder
size(int size)
The number of composite buckets to return.java.util.List<CompositeValuesSourceBuilder<?>>
sources()
Gets the list ofCompositeValuesSourceBuilder
for this aggregation.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, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
AFTER_FIELD_NAME
public static final org.elasticsearch.common.ParseField AFTER_FIELD_NAME -
SIZE_FIELD_NAME
public static final org.elasticsearch.common.ParseField SIZE_FIELD_NAME -
SOURCES_FIELD_NAME
public static final org.elasticsearch.common.ParseField SOURCES_FIELD_NAME -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<CompositeAggregationBuilder,java.lang.String> PARSER
-
-
Constructor Details
-
CompositeAggregationBuilder
public CompositeAggregationBuilder(java.lang.String name, java.util.List<CompositeValuesSourceBuilder<?>> sources) -
CompositeAggregationBuilder
protected CompositeAggregationBuilder(CompositeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata) -
CompositeAggregationBuilder
- Throws:
java.io.IOException
-
-
Method Details
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.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
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractAggregationBuilder<CompositeAggregationBuilder>
- Throws:
java.io.IOException
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder. -
sources
Gets the list ofCompositeValuesSourceBuilder
for this aggregation. -
aggregateAfter
public CompositeAggregationBuilder aggregateAfter(java.util.Map<java.lang.String,java.lang.Object> afterKey)Sets the values that indicates which composite bucket this request should "aggregate after". Defaults tonull
. -
size
The number of composite buckets to return. Defaults to10
. -
size
public int size()- Returns:
- the number of composite buckets. Defaults to
10
.
-
bucketCardinality
Description copied from class:AggregationBuilder
Do aggregations built by this builder contain buckets? If so, do they contain *always* contain a single bucket?- Specified by:
bucketCardinality
in classAggregationBuilder
-
doBuild
protected AggregatorFactory doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder) throws java.io.IOException- Specified by:
doBuild
in classAbstractAggregationBuilder<CompositeAggregationBuilder>
- Throws:
java.io.IOException
-
internalXContent
protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
internalXContent
in classAbstractAggregationBuilder<CompositeAggregationBuilder>
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractAggregationBuilder<CompositeAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classAbstractAggregationBuilder<CompositeAggregationBuilder>
-