Struct elasticsearch_dsl::search::aggregations::bucket::DiversifiedSamplerAggregation

pub struct DiversifiedSamplerAggregation { /* private fields */ }

Like the sampler aggregation this is a filtering aggregation used to limit any sub aggregations’ processing to a sample of the top-scoring documents. The diversified_sampler aggregation adds the ability to limit the number of matches that share a common value such as an “author”.

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html

Implementations

impl DiversifiedSamplerAggregation

pub fn shard_size(self, shard_size: impl TryInto<u64>) -> Self

The shard_size parameter limits how many top-scoring documents are collected in the sample processed on each shard. The default value is 100.

pub fn max_docs_per_value(self, max_docs_per_value: impl TryInto<u64>) -> Self

The max_docs_per_value is an optional parameter and limits how many documents are permitted per choice of de-duplicating value. The default setting is “1”.

pub fn execution_hint(self, execution_hint: ExecutionHint) -> Self

The optional execution_hint setting can influence the management of the values used for de-duplication. Each option will hold up to shard_size values in memory while performing de-duplication but the type of value held can be controlled as follows:

• hold field values directly (map)
• hold ordinals of the field as determined by the Lucene index (global_ordinals)
• hold hashes of the field values - with potential for hash collisions (bytes_hash)

pub fn aggregate<N, A>(self, aggregation_name: N, aggregation: A) -> Self where
    N: Into<AggregationName>,
    A: Into<Aggregation>, 

Pushes aggregation

Trait Implementations

impl Clone for DiversifiedSamplerAggregation

fn clone(&self) -> DiversifiedSamplerAggregation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DiversifiedSamplerAggregation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<DiversifiedSamplerAggregation> for Aggregation

fn from(q: DiversifiedSamplerAggregation) -> Self

Converts to this type from the input type.

impl PartialEq<DiversifiedSamplerAggregation> for DiversifiedSamplerAggregation

fn eq(&self, other: &DiversifiedSamplerAggregation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DiversifiedSamplerAggregation) -> bool

This method tests for !=.

impl Serialize for DiversifiedSamplerAggregation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DiversifiedSamplerAggregation