org.apache.beam.sdk.metrics

Interface MetricResult<T>

All Known Implementing Classes:

DefaultMetricResult

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

The results of a single current metric. TODO(BEAM-6265): Decouple wire formats from internal formats, remove usage of MetricName.

Method Summary

Modifier and Type	Method and Description
static <T> DefaultMetricResult<T>	create(MetricName name, java.lang.String step, T committed, T attempted)
T	getAttempted() Return the value of this metric across all attempts of executing all parts of the pipeline.
T	getCommitted() Return the value of this metric across all successfully completed parts of the pipeline.
MetricName	getName() Return the name of the metric.
java.lang.String	getStep() Return the step context to which this metric result applies.

Method Detail

getName

MetricName getName()

Return the name of the metric.

getStep

java.lang.String getStep()

Return the step context to which this metric result applies.

getCommitted

T getCommitted()

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.

getAttempted

T getAttempted()

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

create

static <T> DefaultMetricResult<T> create(MetricName name,
                                         java.lang.String step,
                                         T committed,
                                         T attempted)