Module org.elasticsearch.server
Class SamplerAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<SamplerAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.sampler.SamplerAggregationBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,Rewriteable<AggregationBuilder>,BaseAggregationBuilder,ToXContent,ToXContentFragment
public class SamplerAggregationBuilder
extends AbstractAggregationBuilder<SamplerAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFieldsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadataFields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
DEFAULT_PREALLOCATION, factoriesBuilder, nameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsModifierConstructorDescriptionRead from a stream.protectedSamplerAggregationBuilder(SamplerAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.protected SamplerAggregatorFactorydoBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) protected voiddoWriteTo(StreamOutput out) booleanThe minimal version of the recipient this object can be sent to.getType()The name of the type of aggregation built by this builder.inthashCode()protected XContentBuilderinternalXContent(XContentBuilder builder, ToXContent.Params params) static SamplerAggregationBuilderparse(String aggregationName, XContentParser parser) protected AggregationBuildershallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.shardSize(int shardSize) Set the max num docs to be returned from each shard.booleansupportsParallelCollection(ToLongFunction<String> fieldCardinalityResolver) Return false if this aggregation or any of the child aggregations does not support parallel collection.Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeToMethods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
buildPipelineTree, bytesToPreallocate, deepCopy, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, supportsSampling, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGapsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
NAME
- See Also:
-
DEFAULT_SHARD_SAMPLE_SIZE
public static final int DEFAULT_SHARD_SAMPLE_SIZE- See Also:
-
-
Constructor Details
-
SamplerAggregationBuilder
-
SamplerAggregationBuilder
protected SamplerAggregationBuilder(SamplerAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
SamplerAggregationBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Description copied from class:AggregationBuilderCreate a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.- Specified by:
shallowCopyin classAggregationBuilder
-
doWriteTo
- Specified by:
doWriteToin classAbstractAggregationBuilder<SamplerAggregationBuilder>- Throws:
IOException
-
shardSize
Set the max num docs to be returned from each shard. -
bucketCardinality
Description copied from class:AggregationBuilderA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinalityin classAggregationBuilder
-
doBuild
protected SamplerAggregatorFactory doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws IOException - Specified by:
doBuildin classAbstractAggregationBuilder<SamplerAggregationBuilder>- Throws:
IOException
-
internalXContent
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
internalXContentin classAbstractAggregationBuilder<SamplerAggregationBuilder>- Throws:
IOException
-
parse
public static SamplerAggregationBuilder parse(String aggregationName, XContentParser parser) throws IOException - Throws:
IOException
-
hashCode
public int hashCode()- Overrides:
hashCodein classAbstractAggregationBuilder<SamplerAggregationBuilder>
-
equals
- Overrides:
equalsin classAbstractAggregationBuilder<SamplerAggregationBuilder>
-
getType
Description copied from interface:BaseAggregationBuilderThe name of the type of aggregation built by this builder. -
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to. SeeVersionedNamedWriteable.supportsVersion(TransportVersion)for the default serialization check. -
supportsParallelCollection
Description copied from class:AggregationBuilderReturn false if this aggregation or any of the child aggregations does not support parallel collection. As a result, a request including such aggregation is always executed sequentially despite concurrency is enabled for the query phase.- Overrides:
supportsParallelCollectionin classAggregationBuilder
-