Struct google_api_proto::google::dataflow::v1beta3::MetricUpdate

pub struct MetricUpdate {
    pub name: Option<MetricStructuredName>,
    pub kind: String,
    pub cumulative: bool,
    pub scalar: Option<Value>,
    pub mean_sum: Option<Value>,
    pub mean_count: Option<Value>,
    pub set: Option<Value>,
    pub distribution: Option<Value>,
    pub gauge: Option<Value>,
    pub internal: Option<Value>,
    pub update_time: Option<Timestamp>,
}

Describes the state of a metric.

Fields

name: Option<MetricStructuredName>

Name of the metric.

kind: String

Metric aggregation kind. The possible metric aggregation kinds are “Sum”, “Max”, “Min”, “Mean”, “Set”, “And”, “Or”, and “Distribution”. The specified aggregation kind is case-insensitive.

If omitted, this is not an aggregated value but instead a single metric sample value.

cumulative: bool

True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.

scalar: Option<Value>

Worker-computed aggregate value for aggregation kinds “Sum”, “Max”, “Min”, “And”, and “Or”. The possible value types are Long, Double, and Boolean.

mean_sum: Option<Value>

Worker-computed aggregate value for the “Mean” aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

mean_count: Option<Value>

Worker-computed aggregate value for the “Mean” aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

set: Option<Value>

Worker-computed aggregate value for the “Set” aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric’s type. All Values in the list must be of the same type.

distribution: Option<Value>

A struct value describing properties of a distribution of numeric values.

gauge: Option<Value>

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

internal: Option<Value>

Worker-computed aggregate value for internal use by the Dataflow service.

update_time: Option<Timestamp>

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

Trait Implementations

impl Clone for MetricUpdate

fn clone(&self) -> MetricUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricUpdate

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

Formats the value using the given formatter.

impl Default for MetricUpdate

fn default() -> Self

Returns the “default value” for a type.

impl Message for MetricUpdate

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 MetricUpdate

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