Struct elasticsearch_dsl::search::aggregations::metrics::TopHitsAggregation

pub struct TopHitsAggregation { /* private fields */ }

A top_hits metric aggregation keeps track of the most relevant document being aggregated. This aggregation is intended to be used as a sub aggregation, so that the top matching documents can be aggregated per bucket.

We do not recommend using top_hits as a top-level aggregation. If you want to group search hits, use the collapse parameter instead.

The top_hits aggregation can effectively be used to group result sets by certain fields via a bucket aggregation. One or more bucket aggregations determines by which properties a result set get sliced into.

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html

Implementations

impl TopHitsAggregation

pub fn source(self, source: impl Into<SourceFilter>) -> Self

Indicates which source fields are returned for matching documents

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

The offset from the first result you want to fetch.

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

The maximum number of top matching hits to return per bucket.

By default the top three matching hits are returned.

pub fn sort(self, sort: impl Into<Vec<Sort>>) -> Self

A collection of sorting fields

Trait Implementations

impl Clone for TopHitsAggregation

fn clone(&self) -> TopHitsAggregation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopHitsAggregation

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

Formats the value using the given formatter.

impl From<TopHitsAggregation> for Aggregation

fn from(q: TopHitsAggregation) -> Self

Converts to this type from the input type.

impl PartialEq<TopHitsAggregation> for TopHitsAggregation

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

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

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

This method tests for !=.

impl Serialize for TopHitsAggregation

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 TopHitsAggregation