Elastica\Aggregation\DiversifiedSampler

Complexity

Total Complexity

3

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setShardSize()	0	4	1
A	setMaxDocsPerValue()	0	4	1
A	setExecutionHint()	0	4	1

<?php

namespace Elastica\Aggregation;

/**
 * Class DiversifiedSampler.
 *
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html
 */
class DiversifiedSampler extends AbstractSimpleAggregation
{
    /**
     * Set the number of top-scoring documents to be returned from each shard.
     *
     * @return $this
     */
    public function setShardSize(int $shardSize): self
    {
        return $this->setParam('shard_size', $shardSize);
    }

    /**
     * Set the maximum number of documents to be returned per value.
     *
     * @return $this
     */
    public function setMaxDocsPerValue(int $max): self
    {
        return $this->setParam('max_docs_per_value', $max);
    }

    /**
     * Instruct Elasticsearch to use direct field data or ordinals/hashes of the field values to execute this aggregation.
     * The execution hint will be ignored if it is not applicable.
     *
     * @return $this
     */
    public function setExecutionHint(string $hint): self
    {
        return $this->setParam('execution_hint', $hint);
    }
}