Struct ForecastComputation

#[non_exhaustive]
pub struct ForecastComputation {
    pub computation_id: String,
    pub name: Option<String>,
    pub time: Option<DimensionField>,
    pub value: Option<MeasureField>,
    pub periods_forward: Option<i32>,
    pub periods_backward: Option<i32>,
    pub upper_boundary: Option<f64>,
    pub lower_boundary: Option<f64>,
    pub prediction_interval: Option<i32>,
    pub seasonality: Option<ForecastComputationSeasonality>,
    pub custom_seasonality_value: Option<i32>,
}

The forecast computation configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

computation_id: String

The ID for a computation.

name: Option<String>

The name of a computation.

time: Option<DimensionField>

The time field that is used in a computation.

value: Option<MeasureField>

The value field that is used in a computation.

periods_forward: Option<i32>

The periods forward setup of a forecast computation.

periods_backward: Option<i32>

The periods backward setup of a forecast computation.

upper_boundary: Option<f64>

The upper boundary setup of a forecast computation.

lower_boundary: Option<f64>

The lower boundary setup of a forecast computation.

prediction_interval: Option<i32>

The prediction interval setup of a forecast computation.

seasonality: Option<ForecastComputationSeasonality>

The seasonality setup of a forecast computation. Choose one of the following options:

• AUTOMATIC

• CUSTOM: Checks the custom seasonality value.

custom_seasonality_value: Option<i32>

The custom seasonality value setup of a forecast computation.

Implementations

impl ForecastComputation

pub fn computation_id(&self) -> &str

The ID for a computation.

pub fn name(&self) -> Option<&str>

The name of a computation.

pub fn time(&self) -> Option<&DimensionField>

The time field that is used in a computation.

pub fn value(&self) -> Option<&MeasureField>

The value field that is used in a computation.

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

The periods forward setup of a forecast computation.

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

The periods backward setup of a forecast computation.

pub fn upper_boundary(&self) -> Option<f64>

The upper boundary setup of a forecast computation.

pub fn lower_boundary(&self) -> Option<f64>

The lower boundary setup of a forecast computation.

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

The prediction interval setup of a forecast computation.

pub fn seasonality(&self) -> Option<&ForecastComputationSeasonality>

The seasonality setup of a forecast computation. Choose one of the following options:

• AUTOMATIC

• CUSTOM: Checks the custom seasonality value.

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

The custom seasonality value setup of a forecast computation.

impl ForecastComputation

pub fn builder() -> ForecastComputationBuilder

Creates a new builder-style object to manufacture ForecastComputation.

Trait Implementations

impl Clone for ForecastComputation

fn clone(&self) -> ForecastComputation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForecastComputation

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

Formats the value using the given formatter.

impl PartialEq for ForecastComputation

fn eq(&self, other: &ForecastComputation) -> 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 StructuralPartialEq for ForecastComputation