Class MetricUpdate

Describes the state of a metric.

Inheritance

object

MetricUpdate

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dataflow.v1b3.Data

Assembly: Google.Apis.Dataflow.v1b3.dll

Syntax

public class MetricUpdate : IDirectResponseSchema

Properties

BoundedTrie

Worker-computed aggregate value for the "Trie" aggregation kind. The only possible value type is a BoundedTrieNode. Introduced this field to avoid breaking older SDKs when Dataflow service starts to populate the bounded_trie field.

Declaration

[JsonProperty("boundedTrie")]
public virtual object BoundedTrie { get; set; }

Property Value

Type	Description
object

Cumulative

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.

Declaration

[JsonProperty("cumulative")]
public virtual bool? Cumulative { get; set; }

Property Value

Type	Description
bool?

Distribution

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

Declaration

[JsonProperty("distribution")]
public virtual object Distribution { get; set; }

Property Value

Type	Description
object

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Gauge

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.

Declaration

[JsonProperty("gauge")]
public virtual object Gauge { get; set; }

Property Value

Type	Description
object

Internal__

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

Declaration

[JsonProperty("internal")]
public virtual object Internal__ { get; set; }

Property Value

Type	Description
object

Kind

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.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

MeanCount

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.

Declaration

[JsonProperty("meanCount")]
public virtual object MeanCount { get; set; }

Property Value

Type	Description
object

MeanSum

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.

Declaration

[JsonProperty("meanSum")]
public virtual object MeanSum { get; set; }

Property Value

Type	Description
object

Name

Name of the metric.

Declaration

[JsonProperty("name")]
public virtual MetricStructuredName Name { get; set; }

Property Value

Type	Description
MetricStructuredName

Scalar

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

Declaration

[JsonProperty("scalar")]
public virtual object Scalar { get; set; }

Property Value

Type	Description
object

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, String, or BoundedTrie according to the metric's type. All Values in the list must be of the same type.

Declaration

[JsonProperty("set")]
public virtual object Set { get; set; }

Property Value

Type	Description
object

Trie

Worker-computed aggregate value for the "Trie" aggregation kind. The only possible value type is a BoundedTrieNode.

Declaration

[JsonProperty("trie")]
public virtual object Trie { get; set; }

Property Value

Type	Description
object

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema