org.apache.beam.sdk.metrics

Class DelegatingGauge

java.lang.Object

org.apache.beam.sdk.metrics.DelegatingGauge

All Implemented Interfaces:

java.io.Serializable, Gauge, Metric

@Internal
public class DelegatingGauge
extends java.lang.Object
implements Metric, Gauge, java.io.Serializable

Implementation of Gauge that delegates to the instance for the current context.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DelegatingGauge(MetricName name) Create a DelegatingGauge with perWorkerGauge and processWideContainer set to false.
DelegatingGauge(MetricName name, boolean processWideContainer) Create a DelegatingGauge with perWorkerGauge set to false.
DelegatingGauge(MetricName name, boolean processWideContainer, boolean perWorkerGauge)

Method Summary

Modifier and Type	Method and Description
MetricName	getName() The MetricName given to this metric.
void	set(long n) Set the gauge.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingGauge

public DelegatingGauge(MetricName name)

Create a DelegatingGauge with perWorkerGauge and processWideContainer set to false.

Parameters:

name - Metric name for this metric.

DelegatingGauge

public DelegatingGauge(MetricName name,
                       boolean processWideContainer)

Create a DelegatingGauge with perWorkerGauge set to false.

Parameters:

name - Metric name for this metric.

processWideContainer - Whether this Gauge is stored in the ProcessWide container or the current thread's container.

DelegatingGauge

public DelegatingGauge(MetricName name,
                       boolean processWideContainer,
                       boolean perWorkerGauge)

Parameters:

name - Metric name for this metric.

processWideContainer - Whether this gauge is stored in the ProcessWide container or the current thread's container.

perWorkerGauge - Whether this gauge refers to a perWorker metric or not.

Method Detail

set

public void set(long n)

Set the gauge.

Specified by:

set in interface Gauge

getName

public MetricName getName()

Description copied from interface: Metric

The MetricName given to this metric.

Specified by:

getName in interface Metric