org.apache.beam.sdk.metrics

Class DelegatingCounter

java.lang.Object

org.apache.beam.sdk.metrics.DelegatingCounter

All Implemented Interfaces:

java.io.Serializable, Counter, Metric

@Internal
public class DelegatingCounter
extends java.lang.Object
implements Metric, Counter, java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	dec()
void	dec(long n)
MetricName	getName() The MetricName given to this metric.
void	inc() Increment the counter.
void	inc(long n) Increment the counter by the given amount.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingCounter

public DelegatingCounter(MetricName name)

Create a DelegatingCounter with perWorkerCounter and processWideContainer set to false.

Parameters:

name - Metric name for this metric.

DelegatingCounter

public DelegatingCounter(MetricName name,
                         boolean processWideContainer)

Create a DelegatingCounter with perWorkerCounter set to false.

Parameters:

name - Metric name for this metric.

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

DelegatingCounter

public DelegatingCounter(MetricName name,
                         boolean processWideContainer,
                         boolean perWorkerCounter)

Parameters:

name - Metric name for this metric.

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

perWorkerCounter - Whether this Counter refers to a perWorker metric or not.

Method Detail

inc

public void inc()

Increment the counter.

Specified by:

inc in interface Counter

inc

public void inc(long n)

Increment the counter by the given amount.

Specified by:

inc in interface Counter

dec

public void dec()

Specified by:

dec in interface Counter

dec

public void dec(long n)

Specified by:

dec in interface Counter

getName

public MetricName getName()

Description copied from interface: Metric

The MetricName given to this metric.

Specified by:

getName in interface Metric