Class SdkDoubleUpDownCounter.SdkDoubleUpDownCounterBuilder

java.lang.Object

io.opentelemetry.sdk.metrics.SdkDoubleUpDownCounter.SdkDoubleUpDownCounterBuilder

All Implemented Interfaces:

ExtendedDoubleUpDownCounterBuilder, DoubleUpDownCounterBuilder

Enclosing class:

SdkDoubleUpDownCounter

static final class SdkDoubleUpDownCounter.SdkDoubleUpDownCounterBuilder
extends Object
implements ExtendedDoubleUpDownCounterBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private final InstrumentBuilder	builder

Constructor Summary

Constructors

Constructor	Description
SdkDoubleUpDownCounterBuilder(SdkMeter sdkMeter, String name, String description, String unit, Advice.AdviceBuilder adviceBuilder)

Method Summary

Modifier and Type	Method	Description
DoubleUpDownCounter	build()	Builds and returns an UpDownCounter instrument with the configuration.
ObservableDoubleMeasurement	buildObserver()	Build an observer for this instrument to observe values from a BatchCallback.
ObservableDoubleUpDownCounter	buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)	Builds an Asynchronous UpDownCounter instrument with the given callback.
ExtendedDoubleUpDownCounterBuilder	setAttributesAdvice(List<AttributeKey<?>> attributes)	Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this up down counter.
DoubleUpDownCounterBuilder	setDescription(String description)	Sets the description for this instrument.
DoubleUpDownCounterBuilder	setUnit(String unit)	Sets the unit of measure for this instrument.
String	toString()

Methods inherited from class Object

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

Field Details

builder

private final InstrumentBuilder builder

Constructor Details

SdkDoubleUpDownCounterBuilder

SdkDoubleUpDownCounterBuilder(SdkMeter sdkMeter,
 String name,
 String description,
 String unit,
 Advice.AdviceBuilder adviceBuilder)

Method Details

setDescription

public DoubleUpDownCounterBuilder setDescription(String description)

Description copied from interface: DoubleUpDownCounterBuilder

Sets the description for this instrument.

Specified by:

setDescription in interface DoubleUpDownCounterBuilder

Parameters:

description - The description.

See Also:

• Instrument Description

setUnit

public DoubleUpDownCounterBuilder setUnit(String unit)

Description copied from interface: DoubleUpDownCounterBuilder

Sets the unit of measure for this instrument.

Specified by:

setUnit in interface DoubleUpDownCounterBuilder

Parameters:

unit - The unit. Instrument units must be 63 or fewer ASCII characters.

See Also:

• Instrument Unit

build

public DoubleUpDownCounter build()

Description copied from interface: DoubleUpDownCounterBuilder

Builds and returns an UpDownCounter instrument with the configuration.

Specified by:

build in interface DoubleUpDownCounterBuilder

Returns:

The UpDownCounter instrument.

buildWithCallback

public ObservableDoubleUpDownCounter buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)

Description copied from interface: DoubleUpDownCounterBuilder

Builds an Asynchronous UpDownCounter instrument with the given callback.

The callback will be called when the instrument is being observed.

Callbacks are expected to abide by the following restrictions:

• Run in a finite amount of time.
• Safe to call repeatedly, across multiple threads.

Specified by:

buildWithCallback in interface DoubleUpDownCounterBuilder

Parameters:

callback - A callback which observes measurements when invoked.

buildObserver

public ObservableDoubleMeasurement buildObserver()

Description copied from interface: DoubleUpDownCounterBuilder

Build an observer for this instrument to observe values from a BatchCallback.

This observer MUST be registered when creating a batchCallback, which records to it. Values observed outside registered callbacks are ignored.

Specified by:

buildObserver in interface DoubleUpDownCounterBuilder

Returns:

an observable measurement that batch callbacks use to observe values.

setAttributesAdvice

public ExtendedDoubleUpDownCounterBuilder setAttributesAdvice(List<AttributeKey<?>> attributes)

Description copied from interface: ExtendedDoubleUpDownCounterBuilder

Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this up down counter.

Specified by:

setAttributesAdvice in interface ExtendedDoubleUpDownCounterBuilder

toString

public String toString()

Overrides:

toString in class Object