Package org.apache.beam.sdk.metrics

Class MetricKey

java.lang.Object

org.apache.beam.sdk.metrics.MetricKey

All Implemented Interfaces:

Serializable

public abstract class MetricKey
extends Object
implements Serializable

Metrics are keyed by the step name they are associated with and the name of the metric.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetricKey()

Method Summary

Modifier and Type	Method	Description
static MetricKey	create(@Nullable String stepName, MetricName metricName)
abstract MetricName	metricName()	The name of the metric.
abstract @Nullable String	stepName()	The step name that is associated with this metric or Null if none is associated.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MetricKey

public MetricKey()

Method Details

stepName

public abstract @Nullable String stepName()

The step name that is associated with this metric or Null if none is associated.

metricName

public abstract MetricName metricName()

The name of the metric.

toString

@Memoized
public String toString()

Overrides:

toString in class Object

create

public static MetricKey create(@Nullable String stepName,
 MetricName metricName)