io.opencensus.tags

Class TagKey

java.lang.Object

io.opencensus.tags.TagKey

@Immutable
public abstract class TagKey
extends Object

A key to a value stored in a TagContext.

Each TagKey has a String name. Names have a maximum length of MAX_LENGTH and contain only printable ASCII characters.

TagKeys are designed to be used as constants. Declaring each key as a constant prevents key names from being validated multiple times.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LENGTH The maximum length for a tag key name.

Method Summary

Modifier and Type	Method and Description
static TagKey	create(String name) Constructs a TagKey with the given name.
abstract String	getName() Returns the name of the key.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_LENGTH

public static final int MAX_LENGTH

The maximum length for a tag key name. The value is 255.

See Also:

Constant Field Values

Method Detail

create

public static TagKey create(String name)

Constructs a TagKey with the given name.

The name must meet the following requirements:

1. It cannot be longer than MAX_LENGTH.
2. It can only contain printable ASCII characters.

Parameters:

name - the name of the key.

Returns:

a TagKey with the given name.

Throws:

IllegalArgumentException - if the name is not valid.

getName

public abstract String getName()

Returns the name of the key.

Returns:

the name of the key.