org.apache.beam.sdk.metrics

Class DefaultMetricResult<T>

java.lang.Object

org.apache.beam.sdk.metrics.DefaultMetricResult<T>

All Implemented Interfaces:

MetricResult<T>

@Experimental(value=METRICS)
public abstract class DefaultMetricResult<T>
extends java.lang.Object
implements MetricResult<T>

The results of a single current metric.

Constructor Summary

Constructors

Constructor and Description
DefaultMetricResult()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMetricResult

public DefaultMetricResult()

Method Detail

getName

public abstract MetricName getName()

Description copied from interface: MetricResult

Return the name of the metric.

Specified by:

getName in interface MetricResult<T>

getStep

public abstract java.lang.String getStep()

Description copied from interface: MetricResult

Return the step context to which this metric result applies.

Specified by:

getStep in interface MetricResult<T>

getCommitted

public abstract T getCommitted()

Description copied from interface: MetricResult

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.

Specified by:

getCommitted in interface MetricResult<T>

getAttempted

public abstract T getAttempted()

Description copied from interface: MetricResult

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

Specified by:

getAttempted in interface MetricResult<T>

create

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

Specified by:

create in interface MetricResult<T>