Struct TimeSeries

#[non_exhaustive]
pub struct TimeSeries {
    pub metric: Option<Metric>,
    pub resource: Option<MonitoredResource>,
    pub metadata: Option<MonitoredResourceMetadata>,
    pub metric_kind: MetricKind,
    pub value_type: ValueType,
    pub points: Vec<Point>,
    pub unit: String,
    pub description: String,
}

A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.

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: Option<Metric>

The associated metric. A fully-specified metric used to identify the time series.

resource: Option<MonitoredResource>

The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics.

metadata: Option<MonitoredResourceMetadata>

Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.

metric_kind: MetricKind

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. 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.

value_type: ValueType

The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.

points: Vec<Point>

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.

unit: String

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.

description: String

Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.

Implementations

impl TimeSeries

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

Sets the value of metric.

pub fn set_resource<T: Into<Option<MonitoredResource>>>(self, v: T) -> Self

Sets the value of resource.

pub fn set_metadata<T: Into<Option<MonitoredResourceMetadata>>>( self, v: T, ) -> Self

Sets the value of metadata.

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

Sets the value of metric_kind.

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

Sets the value of value_type.

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

Sets the value of unit.

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

Sets the value of description.

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

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

Sets the value of points.

Trait Implementations

impl Clone for TimeSeries

fn clone(&self) -> TimeSeries

Returns a copy 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<'de> Deserialize<'de> for TimeSeries

where TimeSeries: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for TimeSeries

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimeSeries