All Superinterfaces:
Aggregation, HasAggregations, SingleBucketAggregation, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
All Known Implementing Classes:
InternalSampler, ParsedSampler, UnmappedSampler

public interface Sampler extends SingleBucketAggregation
A filter aggregation that defines a single bucket to hold a sample of top-matching documents. Computation of child aggregations is deferred until the top-matching documents on a shard have been determined.
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

    Aggregation.CommonFields

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

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
  • Field Summary

    Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS
  • Method Summary

    Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

    getMetadata, getName, getType

    Methods inherited from interface org.elasticsearch.search.aggregations.bucket.SingleBucketAggregation

    getAggregations, getDocCount

    Methods inherited from interface org.elasticsearch.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

    isFragment