io.opencensus.metrics

Class LabelKey

java.lang.Object

io.opencensus.metrics.LabelKey

@ExperimentalApi
 @Immutable
public abstract class LabelKey
extends Object

The key of a Label associated with a MetricDescriptor.

Since:

0.15

Method Summary

Modifier and Type	Method and Description
static LabelKey	create(String key, String description) Creates a LabelKey.
abstract String	getDescription() Returns the description of this LabelKey.
abstract String	getKey() Returns the key of this LabelKey.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LabelKey create(String key,
                              String description)

Creates a LabelKey.

Parameters:

key - the key of a Label.

description - a human-readable description of what this label key represents.

Returns:

a LabelKey.

Since:

0.17

getKey

public abstract String getKey()

Returns the key of this LabelKey.

Returns:

the key.

Since:

0.17

getDescription

public abstract String getDescription()

Returns the description of this LabelKey.

Returns:

the description.

Since:

0.17