Package io.opencensus.tags
Class TagKey
java.lang.Object
io.opencensus.tags.TagKey
- Direct Known Subclasses:
AutoValue_TagKey
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.
TagKey
s are designed to be used as constants. Declaring each key as a constant
prevents key names from being validated multiple times.
- Since:
- 0.8
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The maximum length for a tag key name. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
MAX_LENGTH
public static final int MAX_LENGTHThe maximum length for a tag key name. The value is 255.- Since:
- 0.8
- See Also:
-
-
Constructor Details
-
TagKey
TagKey()
-
-
Method Details
-
create
Constructs aTagKey
with the given name.The name must meet the following requirements:
- It cannot be longer than
MAX_LENGTH
. - 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.- Since:
- 0.8
- It cannot be longer than
-
getName
Returns the name of the key.- Returns:
- the name of the key.
- Since:
- 0.8
-
isValid
Determines whether the givenString
is a valid tag key.- Parameters:
name
- the tag key name to be validated.- Returns:
- whether the name is valid.
-