Dataflow v1beta3 API - Class MetricUpdate (2.0.0-beta06)

public sealed class MetricUpdate : IMessage<MetricUpdate>, IEquatable<MetricUpdate>, IDeepCloneable<MetricUpdate>, IBufferMessage, IMessage

Reference documentation and code samples for the Dataflow v1beta3 API class MetricUpdate.

Describes the state of a metric.

Inheritance

object > MetricUpdate

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

MetricUpdate()

public MetricUpdate()

MetricUpdate(MetricUpdate)

public MetricUpdate(MetricUpdate other)
Parameter
Name Description
other MetricUpdate

Properties

Cumulative

public bool Cumulative { get; set; }

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.

Property Value
Type Description
bool

Distribution

public Value Distribution { get; set; }

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

Property Value
Type Description
Value

Gauge

public Value Gauge { get; set; }

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.

Property Value
Type Description
Value

Internal

public Value Internal { get; set; }

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

Property Value
Type Description
Value

Kind

public string Kind { get; set; }

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.

Property Value
Type Description
string

MeanCount

public Value MeanCount { get; set; }

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.

Property Value
Type Description
Value

MeanSum

public Value MeanSum { get; set; }

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.

Property Value
Type Description
Value

Name

public MetricStructuredName Name { get; set; }

Name of the metric.

Property Value
Type Description
MetricStructuredName

Scalar

public Value Scalar { get; set; }

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

Property Value
Type Description
Value

Set

public Value Set { get; set; }

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.

Property Value
Type Description
Value

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp