org.apache.beam.sdk.metrics

Interface MetricResult<T>

@Experimental(value=METRICS)
public interface MetricResult<T>

The results of a single current metric.

Method Summary

Modifier and Type	Method and Description
T	attempted() Return the value of this metric across all attempts of executing all parts of the pipeline.
T	committed() Return the value of this metric across all successfully completed parts of the pipeline.
MetricName	name() Return the name of the metric.
java.lang.String	step() Return the step context to which this metric result applies.

Method Detail

name

MetricName name()

Return the name of the metric.

step

java.lang.String step()

Return the step context to which this metric result applies.

committed

T committed()

Return the value of this metric across all successfully completed parts of the pipeline.

Not all runners will support committed metrics. If they are not supported, the runner will throw an UnsupportedOperationException.

attempted

T attempted()

Return the value of this metric across all attempts of executing all parts of the pipeline.