Struct elasticsearch_dsl::search::aggregations::metrics::RateAggregation

pub struct RateAggregation { /* private fields */ }

A rate metrics aggregation can be used only inside a date_histogram and calculates a rate of documents or a field in each date_histogram bucket. The field values can be generated extracted from specific numeric or histogram fields in the documents.

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

Implementations

impl RateAggregation

pub fn field<T>(self, field: T) -> Selfwhere
    T: ToString,

Calculate sum or number of values of the field

pub fn unit(self, unit: CalendarInterval) -> Self

The rate aggregation supports all rate that can be used calendar_intervals parameter of date_histogram aggregation. The specified rate should compatible with the date_histogram aggregation interval, i.e. it should be possible to convert the bucket size into the rate. By default the interval of the date_histogram is used.

There is also an additional limitations if the date histogram is not a direct parent of the rate histogram. In this case both rate interval and histogram interval have to be in the same group: [second, minute, hour, day, week] or [month, quarter, year]. For example, if the date histogram is month based, only rate intervals of month, quarter or year are supported. If the date histogram is day based, only second, minute, hour, day, and week` rate intervals are supported.

pub fn mode(self, mode: RateMode) -> Self

By default sum mode is used.

By adding the mode parameter with the value value_count, we can change the calculation from sum to the number of values of the field.

Trait Implementations

impl Clone for RateAggregation

fn clone(&self) -> RateAggregation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateAggregation

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

Formats the value using the given formatter.

impl From<RateAggregation> for Aggregation

fn from(q: RateAggregation) -> Self

Converts to this type from the input type.

impl PartialEq<RateAggregation> for RateAggregation

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RateAggregation

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 RateAggregation