Struct TimeSeries 

#[non_exhaustive]
pub struct TimeSeries {
    pub metric: String,
    pub value_type: ValueType,
    pub metric_kind: MetricKind,
    pub points: Vec<Point>,
    /* private fields */
}

The metrics object for a SubTask.

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.

metric: String

Required. The name of the metric.

If the metric is not known by the service yet, it will be auto-created.

value_type: ValueType

Required. The value type of the time series.

metric_kind: MetricKind

Optional. The metric kind of the time series.

If present, it must be the same as the metric kind of the associated metric. If the associated metric’s descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

points: Vec<Point>

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point’s type must be the same as the value type of the associated metric. If the associated metric’s descriptor must be auto-created, then the value type of the descriptor is determined by the point’s type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

Implementations

impl TimeSeries

pub fn new() -> Self

pub fn set_metric<T: Into<String>>(self, v: T) -> Self

Sets the value of metric.

Example

let x = TimeSeries::new().set_metric("example");

pub fn set_value_type<T: Into<ValueType>>(self, v: T) -> Self

Sets the value of value_type.

Example

use api::model::metric_descriptor::ValueType;
let x0 = TimeSeries::new().set_value_type(ValueType::Bool);
let x1 = TimeSeries::new().set_value_type(ValueType::Int64);
let x2 = TimeSeries::new().set_value_type(ValueType::Double);

pub fn set_metric_kind<T: Into<MetricKind>>(self, v: T) -> Self

Sets the value of metric_kind.

Example

use api::model::metric_descriptor::MetricKind;
let x0 = TimeSeries::new().set_metric_kind(MetricKind::Gauge);
let x1 = TimeSeries::new().set_metric_kind(MetricKind::Delta);
let x2 = TimeSeries::new().set_metric_kind(MetricKind::Cumulative);

pub fn set_points<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Point>,

Sets the value of points.

Example

use google_cloud_bigquery_migration_v2::model::Point;
let x = TimeSeries::new()
    .set_points([
        Point::default()/* use setters */,
        Point::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for TimeSeries

fn clone(&self) -> TimeSeries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeSeries

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

Formats the value using the given formatter.

impl Default for TimeSeries

fn default() -> TimeSeries

Returns the “default value” for a type.

impl Message for TimeSeries

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TimeSeries

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