Struct google_api_proto::google::cloud::timeseriesinsights::v1::ForecastParams

pub struct ForecastParams {
    pub noise_threshold: Option<f64>,
    pub seasonality_hint: i32,
    pub horizon_duration: Option<Duration>,
}

Parameters that control the sensitivity and other options for the time series forecast.

Fields

noise_threshold: Option<f64>

Optional. Penalize variations between the actual and forecasted values smaller than this. For more information about how this parameter affects the score, see the anomalyScore formula.

Intuitively, anomaly scores summarize how statistically significant the change between the actual and forecasted value is compared with what we expect the change to be (see expectedDeviation). However, in practice, depending on the application, changes smaller than certain absolute values, while statistically significant, may not be important.

This parameter allows us to penalize such low absolute value changes.

Must be in the (0.0, inf) range.

If unspecified, it defaults to 0.000001.

seasonality_hint: i32

Optional. Specifying any known seasonality/periodicity in the time series for the slices we will analyze can improve the quality of the results.

If unsure, simply leave it unspecified by not setting a value for this field.

If your time series has multiple seasonal patterns, then set it to the most granular one (e.g. if it has daily and weekly patterns, set this to DAILY).

horizon_duration: Option<Duration>

Optional. The length of the returned [forecasted timeseries][EvaluatedSlice.forecast].

This duration is currently capped at 100 x [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity].

Example: If the detection point is set to “2020-12-27T00:00:00Z”, the [granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] to “3600s” and the horizon_duration to “10800s”, then we will generate 3 time series points (from “2020-12-27T01:00:00Z” to “2020-12-27T04:00:00Z”), for which we will return their forecasted values.

Note: The horizon time is only used for forecasting not for anormaly detection. To detect anomalies for multiple points of time, simply send multiple queries with those as [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time].

Implementations

impl ForecastParams

pub fn seasonality_hint(&self) -> Period

Returns the enum value of seasonality_hint, or the default if the field is set to an invalid enum value.

pub fn set_seasonality_hint(&mut self, value: Period)

Sets seasonality_hint to the provided enum value.

pub fn noise_threshold(&self) -> f64

Returns the value of noise_threshold, or the default value if noise_threshold is unset.

Trait Implementations

impl Clone for ForecastParams

fn clone(&self) -> ForecastParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForecastParams

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

Formats the value using the given formatter.

impl Default for ForecastParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for ForecastParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ForecastParams

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

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

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 Copy for ForecastParams

impl StructuralPartialEq for ForecastParams