Package org.elasticsearch.search.aggregations.metrics.cardinality

Class CardinalityAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<VS,AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<ValuesSource,CardinalityAggregationBuilder>

org.elasticsearch.search.aggregations.metrics.cardinality.CardinalityAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public final class CardinalityAggregationBuilder
extends ValuesSourceAggregationBuilder.LeafOnly<ValuesSource,CardinalityAggregationBuilder>

Nested Class Summary

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

AggregationBuilder.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>

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 java.lang.String	NAME
static ParseField	PRECISION_THRESHOLD_FIELD

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

metaData

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

factoriesBuilder, name

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

Constructor Summary

Constructors

Constructor	Description
CardinalityAggregationBuilder(java.lang.String name, ValueType targetValueType)
CardinalityAggregationBuilder(StreamInput in)	Read from a stream.
CardinalityAggregationBuilder(CardinalityAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String	getType()	The name of the type of aggregation built by this builder.
protected CardinalityAggregatorFactory	innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	innerEquals(java.lang.Object obj)
protected int	innerHashCode()
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
static AggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
java.lang.Long	precisionThreshold()	Get the precision threshold.
CardinalityAggregationBuilder	precisionThreshold(long precisionThreshold)	Set a precision threshold.
void	rehash(boolean rehash)	Deprecated. no replacement - values will always be rehashed
protected boolean	serializeTargetValueType()	Should this builder serialize its targetValueType? Defaults to false.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.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, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, toXContent, writeTo

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

doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, timeZone, timeZone, valueType, valueType

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly

subAggregations

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

PRECISION_THRESHOLD_FIELD

public static final ParseField PRECISION_THRESHOLD_FIELD

Constructor Detail

CardinalityAggregationBuilder

public CardinalityAggregationBuilder(java.lang.String name,
                                     ValueType targetValueType)

CardinalityAggregationBuilder

public CardinalityAggregationBuilder(CardinalityAggregationBuilder clone,
                                     AggregatorFactories.Builder factoriesBuilder,
                                     java.util.Map<java.lang.String,java.lang.Object> metaData)

CardinalityAggregationBuilder

public CardinalityAggregationBuilder(StreamInput in)
                              throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

parse

public static AggregationBuilder parse(java.lang.String aggregationName,
                                       XContentParser parser)
                                throws java.io.IOException

Throws:

java.io.IOException

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 replacing AggregationBuilder.factoriesBuilder and metaData. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws java.io.IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ValuesSource,CardinalityAggregationBuilder>

Throws:

java.io.IOException

serializeTargetValueType

protected boolean serializeTargetValueType()

Description copied from class: ValuesSourceAggregationBuilder

Should this builder serialize its targetValueType? Defaults to false. All subclasses that override this to true should use the three argument read constructor rather than the four argument version.

Overrides:

serializeTargetValueType in class ValuesSourceAggregationBuilder<ValuesSource,CardinalityAggregationBuilder>

precisionThreshold

public CardinalityAggregationBuilder precisionThreshold(long precisionThreshold)

Set a precision threshold. Higher values improve accuracy but also increase memory usage.

precisionThreshold

public java.lang.Long precisionThreshold()

Get the precision threshold. Higher values improve accuracy but also increase memory usage. Will return null if the precisionThreshold has not been set yet.

rehash

@Deprecated
public void rehash(boolean rehash)

Deprecated.

no replacement - values will always be rehashed

innerBuild

protected CardinalityAggregatorFactory innerBuild(SearchContext context,
                                                  ValuesSourceConfig<ValuesSource> config,
                                                  AggregatorFactory<?> parent,
                                                  AggregatorFactories.Builder subFactoriesBuilder)
                                           throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ValuesSource,CardinalityAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
                                      ToXContent.Params params)
                               throws java.io.IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ValuesSource,CardinalityAggregationBuilder>

Throws:

java.io.IOException

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class ValuesSourceAggregationBuilder<ValuesSource,CardinalityAggregationBuilder>

innerEquals

protected boolean innerEquals(java.lang.Object obj)

Specified by:

innerEquals in class ValuesSourceAggregationBuilder<ValuesSource,CardinalityAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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