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.
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eMetricUpdate\u003c/code\u003e class in the Dataflow v1beta3 API describes the state of a metric, implementing interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, and \u003ccode\u003eIDeepCloneable\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eMetricUpdate\u003c/code\u003e objects can be constructed using a default constructor or by providing another \u003ccode\u003eMetricUpdate\u003c/code\u003e object as a parameter for a copy.\u003c/p\u003e\n"],["\u003cp\u003eThe class contains properties like \u003ccode\u003eCumulative\u003c/code\u003e, \u003ccode\u003eDistribution\u003c/code\u003e, \u003ccode\u003eGauge\u003c/code\u003e, \u003ccode\u003eInternal\u003c/code\u003e, \u003ccode\u003eKind\u003c/code\u003e, \u003ccode\u003eMeanCount\u003c/code\u003e, \u003ccode\u003eMeanSum\u003c/code\u003e, \u003ccode\u003eName\u003c/code\u003e, \u003ccode\u003eScalar\u003c/code\u003e, \u003ccode\u003eSet\u003c/code\u003e, and \u003ccode\u003eUpdateTime\u003c/code\u003e, each providing specific information about the metric's value and aggregation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eKind\u003c/code\u003e property specifies the aggregation type, allowing for options like "Sum," "Max," "Min," "Mean," "Set," "And," "Or," and "Distribution," and if omitted, it indicates a single metric sample value.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eMetricUpdate\u003c/code\u003e class includes worker-computed aggregate values for various aggregation kinds, such as \u003ccode\u003eMeanSum\u003c/code\u003e and \u003ccode\u003eMeanCount\u003c/code\u003e for "Mean" aggregation, and \u003ccode\u003eScalar\u003c/code\u003e for "Sum," "Max," "Min," "And," and "Or" aggregations.\u003c/p\u003e\n"]]],[],null,["# Dataflow v1beta3 API - Class MetricUpdate (2.0.0-beta07)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0-beta07 (latest)](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.MetricUpdate)\n- [2.0.0-beta06](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/2.0.0-beta06/Google.Cloud.Dataflow.V1Beta3.MetricUpdate)\n- [1.0.0-beta03](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/1.0.0-beta03/Google.Cloud.Dataflow.V1Beta3.MetricUpdate) \n\n public sealed class MetricUpdate : IMessage\u003cMetricUpdate\u003e, IEquatable\u003cMetricUpdate\u003e, IDeepCloneable\u003cMetricUpdate\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Dataflow v1beta3 API class MetricUpdate.\n\nDescribes the state of a metric. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e MetricUpdate \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[MetricUpdate](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.MetricUpdate), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[MetricUpdate](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.MetricUpdate), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[MetricUpdate](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.MetricUpdate), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Dataflow.V1Beta3](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3)\n\nAssembly\n--------\n\nGoogle.Cloud.Dataflow.V1Beta3.dll\n\nConstructors\n------------\n\n### MetricUpdate()\n\n public MetricUpdate()\n\n### MetricUpdate(MetricUpdate)\n\n public MetricUpdate(MetricUpdate other)\n\nProperties\n----------\n\n### Cumulative\n\n public bool Cumulative { get; set; }\n\nTrue if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.\n\n### Distribution\n\n public Value Distribution { get; set; }\n\nA struct value describing properties of a distribution of numeric values.\n\n### Gauge\n\n public Value Gauge { get; set; }\n\nA struct value describing properties of a Gauge.\nMetrics of gauge type show the value of a metric across time, and is\naggregated based on the newest value.\n\n### Internal\n\n public Value Internal { get; set; }\n\nWorker-computed aggregate value for internal use by the Dataflow\nservice.\n\n### Kind\n\n public string Kind { get; set; }\n\nMetric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.\n\n### MeanCount\n\n public Value MeanCount { get; set; }\n\nWorker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.\n\n### MeanSum\n\n public Value MeanSum { get; set; }\n\nWorker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double.\n\n### Name\n\n public MetricStructuredName Name { get; set; }\n\nName of the metric.\n\n### Scalar\n\n public Value Scalar { get; set; }\n\nWorker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean.\n\n### Set\n\n public Value Set { get; set; }\n\nWorker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.\n\n### UpdateTime\n\n public Timestamp UpdateTime { get; set; }\n\nTimestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API."]]
