Dataflow v1beta3 API - Class MetricStructuredName (2.0.0-beta06)

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

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

Identifies a metric, by describing the source which generated the metric.

Inheritance

object > MetricStructuredName

Implements

IMessage MetricStructuredName, IEquatable MetricStructuredName, IDeepCloneable MetricStructuredName, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

MetricStructuredName()

public MetricStructuredName()

MetricStructuredName(MetricStructuredName)

public MetricStructuredName(MetricStructuredName other)

Parameter
Name	Description
`other`	`MetricStructuredName`

Properties

Context

public MapField<string, string> Context { get; }

Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection.

For example, built-in counters associated with steps will have context['step'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

Worker-defined metric name.

Property Value
Type	Description
`string`

Origin

public string Origin { get; set; }

Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.

Property Value
Type	Description
`string`