Class InstrumentDescriptor

java.lang.Object

io.opentelemetry.sdk.metrics.internal.descriptor.InstrumentDescriptor

@Immutable
public abstract class InstrumentDescriptor
extends Object

Describes an instrument that was registered to record data.

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Method Summary

Modifier and Type	Method	Description
static InstrumentDescriptor	create(String name, String description, String unit, InstrumentType type, InstrumentValueType valueType, Advice advice)
final boolean	equals(Object o)	Uses case-insensitive version of getName(), ignores getAdvice() (not part of instrument identity}, ignores getSourceInfo().
abstract Advice	getAdvice()	Not part of instrument identity.
abstract String	getDescription()
abstract String	getName()
final SourceInfo	getSourceInfo()	Debugging information for this instrument.
abstract InstrumentType	getType()
abstract String	getUnit()
abstract InstrumentValueType	getValueType()
final int	hashCode()	Uses case-insensitive version of getName(), ignores getAdvice() (not part of instrument identity}, ignores getSourceInfo().

Methods inherited from class Object

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

Method Details

create

public static InstrumentDescriptor create(String name,
 String description,
 String unit,
 InstrumentType type,
 InstrumentValueType valueType,
 Advice advice)

getName

public abstract String getName()

getDescription

public abstract String getDescription()

getUnit

public abstract String getUnit()

getType

public abstract InstrumentType getType()

getValueType

public abstract InstrumentValueType getValueType()

getAdvice

public abstract Advice getAdvice()

Not part of instrument identity. Ignored from hashCode() and equals(Object).

getSourceInfo

public final SourceInfo getSourceInfo()

Debugging information for this instrument. Ignored from equals(Object) and Object.toString().

hashCode

public final int hashCode()

Uses case-insensitive version of getName(), ignores getAdvice() (not part of instrument identity}, ignores getSourceInfo().

Overrides:

hashCode in class Object

equals

public final boolean equals(Object o)

Uses case-insensitive version of getName(), ignores getAdvice() (not part of instrument identity}, ignores getSourceInfo().

Overrides:

equals in class Object