Struct SummarizeSeries 

pub struct SummarizeSeries { /* private fields */ }

Summarizes the output of a series node. The output can be a numeric, enum, log, or cartesian series. Summarization strategy should be specified.

Implementations

impl SummarizeSeries

pub fn builder() -> Builder<InputStage>

Returns a new builder.

impl SummarizeSeries

pub fn new(input: Series) -> Self

Constructs a new instance of the type.

pub fn input(&self) -> &Series

pub fn output_format(&self) -> Option<&OutputFormat>

The output format of the response. Defaults to LEGACY.

pub fn numeric_output_fields(&self) -> Option<&BTreeSet<NumericOutputField>>

The fields to output from the summarization. Applies only to Arrow format numeric series.

pub fn numeric_aggregations(&self) -> &BTreeMap<String, NumericAggregation>

Additional numeric aggregations per decimation bucket (e.g. percentiles). Map key is the name of the column in the result.

pub fn resolution(&self) -> Option<SafeLong>

👎Deprecated:

Use summarizationStrategy instead.

Resolution of the output series specifying time interval between decimated points. Picoseconds for picosecond-granularity dataset, nanoseconds otherwise.

pub fn buckets(&self) -> Option<i32>

👎Deprecated:

Use summarizationStrategy instead.

Number of points to generate in the output series.

pub fn summarization_strategy(&self) -> Option<&SummarizationStrategy>

The strategy to use when summarizing the series.

Trait Implementations

impl Clone for SummarizeSeries

fn clone(&self) -> SummarizeSeries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummarizeSeries

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SummarizeSeries

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SummarizeSeries> for Builder<Complete>

fn from(v: SummarizeSeries) -> Self

Converts to this type from the input type.

impl Hash for SummarizeSeries

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SummarizeSeries

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SummarizeSeries

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for SummarizeSeries

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SummarizeSeries

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SummarizeSeries