Struct gapi_grpc::google::monitoring::v3::TimeSeries

pub struct TimeSeries {
    pub metric: Option<Metric>,
    pub resource: Option<MonitoredResource>,
    pub metadata: Option<MonitoredResourceMetadata>,
    pub metric_kind: i32,
    pub value_type: i32,
    pub points: Vec<Point>,
    pub unit: 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

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.

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: i32

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: i32

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.

Implementations

impl TimeSeries

pub fn metric_kind(&self) -> MetricKind

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

pub fn set_metric_kind(&mut self, value: MetricKind)

Sets metric_kind to the provided enum value.

pub fn value_type(&self) -> ValueType

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

pub fn set_value_type(&mut self, value: ValueType)

Sets value_type to the provided enum value.

Trait Implementations

impl Clone for TimeSeries

fn clone(&self) -> TimeSeries

Returns a copy of the value.

pub 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 encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<TimeSeries> for TimeSeries

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

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

fn ne(&self, other: &TimeSeries) -> bool

This method tests for !=.

impl StructuralPartialEq for TimeSeries