Package io.opentelemetry.sdk.metrics.internal.descriptor

Class InstrumentDescriptor

java.lang.Object

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

Direct Known Subclasses:

AutoValue_InstrumentDescriptor

@Immutable
public abstract class InstrumentDescriptor
extends java.lang.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.

Field Summary

Fields

Modifier and Type	Field	Description
private int	hashcode
private SourceInfo	sourceInfo

Constructor Summary

Constructors

Constructor	Description
InstrumentDescriptor()

Method Summary

Modifier and Type	Method	Description
static InstrumentDescriptor	create(java.lang.String name, java.lang.String description, java.lang.String unit, InstrumentType type, InstrumentValueType valueType, Advice advice)
boolean	equals(java.lang.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 java.lang.String	getDescription()
abstract java.lang.String	getName()
SourceInfo	getSourceInfo()	Debugging information for this instrument.
abstract InstrumentType	getType()
abstract java.lang.String	getUnit()
abstract InstrumentValueType	getValueType()
int	hashCode()	Uses case-insensitive version of getName(), ignores getAdvice() (not part of instrument identity}, ignores getSourceInfo().

Methods inherited from class java.lang.Object

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

Field Detail

sourceInfo

private final SourceInfo sourceInfo

hashcode

private int hashcode

Constructor Detail

InstrumentDescriptor

InstrumentDescriptor()

Method Detail

create

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

getName

public abstract java.lang.String getName()

getDescription

public abstract java.lang.String getDescription()

getUnit

public abstract java.lang.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 java.lang.Object

equals

public final boolean equals(java.lang.Object o)

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

Overrides:

equals in class java.lang.Object