Package org.apache.beam.sdk.metrics

Class MetricKey

java.lang.Object

org.apache.beam.sdk.metrics.MetricKey

All Implemented Interfaces:

java.io.Serializable

@Experimental(METRICS)
public abstract class MetricKey
extends java.lang.Object
implements java.io.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 java.lang.String stepName, MetricName metricName)
abstract MetricName	metricName()	The name of the metric.
abstract @Nullable java.lang.String	stepName()	The step name that is associated with this metric or Null if none is associated.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricKey

public MetricKey()

Method Detail

stepName

public abstract @Nullable java.lang.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

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

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