Struct elastiql::aggregation::types::VariableWidthHistogram

pub struct VariableWidthHistogram {
    pub field: String,
    pub buckets: u64,
}

Variable width histogram is a multi-bucket aggregation similar to histogram. However, the width of each bucket is not specified. Rather, a target number of buckets is provided and bucket intervals are dynamically determined based on the document distribution. This is done using a simple one-pass document clustering algorithm that aims to obtain low distances between bucket centroids. Unlike other multi-bucket aggregations, the intervals will not necessarily have a uniform width.

Note: until GraphQL Union input types are supported, either calendarInterval or fixedInterval must be specified but not both.

Fields

field: String

The field to perform the aggregation over.

buckets: u64

The target number of buckets.

Implementations

impl VariableWidthHistogram

pub fn builder() -> VariableWidthHistogramBuilder<((), ())>

Create a builder for building VariableWidthHistogram. On the builder, call .field(...), .buckets(...) to set the values of the fields. Finally, call .build() to create the instance of VariableWidthHistogram.

Trait Implementations

impl Clone for VariableWidthHistogram

fn clone(&self) -> VariableWidthHistogram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariableWidthHistogram

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VariableWidthHistogram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for VariableWidthHistogram

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

Serialize this value into the given Serde serializer.