Struct google_api_proto::google::cloud::timeseriesinsights::v1::TimeseriesParams

pub struct TimeseriesParams {
    pub forecast_history: Option<Duration>,
    pub granularity: Option<Duration>,
    pub metric: Option<String>,
    pub metric_aggregation_method: i32,
}

Parameters that control how we construct the time series for each slice.

Fields

forecast_history: Option<Duration>

Required. How long should we go in the past when fetching the timeline used for forecasting each slice.

This is used in combination with the [detectionTime][google.cloud.timeseriesinsights.v1.QueryDataSetRequest.detection_time] parameter. The time series we construct will have the following time range: \[detectionTime - forecastHistory, detectionTime + granularity\].

The forecast history might be rounded up, so that a multiple of granularity is used to process the query.

Note: If there are not enough events in the \[detectionTime - forecastHistory, detectionTime + granularity\] time interval, the slice evaluation can fail. For more information, see [EvaluatedSlice.status][google.cloud.timeseriesinsights.v1.EvaluatedSlice.status].

granularity: Option<Duration>

Required. The time granularity of the time series (on the x-axis). Each time series point starting at time T will aggregate all events for a particular slice in [T, T + granularity) time windows.

Note: The aggregation is decided based on the [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] parameter.

This granularity defines the query-time aggregation windows and is not necessarily related to any event time granularity in the raw data (though we do recommend that the query-time granularity is not finer than the ingestion-time one).

Currently, the minimal supported granularity is 10 seconds.

metric: Option<String>

Optional. Denotes the [name][google.cloud.timeseriesinsights.v1.EventDimension.name] of a numerical dimension that will have its values aggregated to compute the y-axis of the time series.

The aggregation method must also be specified by setting the [metricAggregationMethod][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric_aggregation_method] field.

Note: Currently, if the aggregation method is unspecified, we will default to SUM for backward compatibility reasons, but new implementations should set the [metricAggregationMethod][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric_aggregation_method] explicitly.

If the metric is unspecified, we will use the number of events that each time series point contains as the point value.

Example: Let’s assume we have the following three events in our dataset:

{
   eventTime: "2020-12-27T00:00:00Z",
   dimensions: [
     { name: "d1" stringVal: "v1" },
     { name: "d2" stringVal: "v2" }
     { name: "m1" longVal: 100 }
     { name: "m2" longVal: 11 }
   ]
},
{
   eventTime: "2020-12-27T00:10:00Z",
   dimensions: [
     { name: "d1" stringVal: "v1" },
     { name: "d2" stringVal: "v2" }
     { name: "m1" longVal: 200 }
     { name: "m2" longVal: 22 }
   ]
},
{
   eventTime: "2020-12-27T00:20:00Z",
   dimensions: [
     { name: "d1" stringVal: "v1" },
     { name: "d2" stringVal: "v2" }
     { name: "m1" longVal: 300 }
     { name: "m2" longVal: 33 }
   ]
}

These events are all within the same hour, spaced 10 minutes between each of them. Assuming our [QueryDataSetRequest][google.cloud.timeseriesinsights.v1.QueryDataSetRequest] had set [slicingParams.dimensionNames][google.cloud.timeseriesinsights.v1.SlicingParams.dimension_names] to [“d1”, “d2”] and [timeseries_params.granularity][google.cloud.timeseriesinsights.v1.TimeseriesParams.granularity] to “3600s”, then all the previous events will be aggregated into the same [timeseries point][google.cloud.timeseriesinsights.v1.TimeseriesPoint].

The time series point that they’re all part of will have the [time][google.cloud.timeseriesinsights.v1.TimeseriesPoint.time] set to “2020-12-27T00:00:00Z” and the [value][google.cloud.timeseriesinsights.v1.TimeseriesPoint.value] populated based on this metric field:

• If the metric is set to “m1” and metric_aggregation_method to SUM, then the value of the point will be 600.
• If the metric is set to “m2” and metric_aggregation_method to SUM, then the value of the point will be 66.
• If the metric is set to “m1” and metric_aggregation_method to AVERAGE, then the value of the point will be 200.
• If the metric is set to “m2” and metric_aggregation_method to AVERAGE, then the value of the point will be 22.
• If the metric field is “” or unspecified, then the value of the point will be 3, as we will simply count the events.

metric_aggregation_method: i32

Optional. Together with the [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] field, specifies how we will aggregate multiple events to obtain the value of a time series point. See the [metric][google.cloud.timeseriesinsights.v1.TimeseriesParams.metric] documentation for more details.

If the metric is not specified or “”, then this field will be ignored.

Implementations

impl TimeseriesParams

pub fn metric(&self) -> &str

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

pub fn metric_aggregation_method(&self) -> AggregationMethod

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

pub fn set_metric_aggregation_method(&mut self, value: AggregationMethod)

Sets metric_aggregation_method to the provided enum value.

Trait Implementations

impl Clone for TimeseriesParams

fn clone(&self) -> TimeseriesParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeseriesParams

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

Formats the value using the given formatter.

impl Default for TimeseriesParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for TimeseriesParams

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 TimeseriesParams

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