Package io.opencensus.tags
Enum TagMetadata.TagTtl
- All Implemented Interfaces:
Serializable
,Comparable<TagMetadata.TagTtl>
- Enclosing class:
TagMetadata
TagMetadata.TagTtl
is an integer that represents number of hops a tag can propagate.
Anytime a sender serializes a tag, sends it over the wire and receiver deserializes the tag then the tag is considered to have travelled one hop.
There could be one or more proxy(ies) between sender and receiver. Proxies are treated as transparent entities and they are not counted as hops.
For now, only special values of TagMetadata.TagTtl
are supported.
- Since:
- 0.20
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionATag
withNO_PROPAGATION
is considered to have local scope and is used within the process where it's created.ATag
withUNLIMITED_PROPAGATION
can propagate unlimited hops. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic TagMetadata.TagTtl
Returns the enum constant of this type with the specified name.static TagMetadata.TagTtl[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
NO_PROPAGATION
ATag
withNO_PROPAGATION
is considered to have local scope and is used within the process where it's created.- Since:
- 0.20
-
UNLIMITED_PROPAGATION
ATag
withUNLIMITED_PROPAGATION
can propagate unlimited hops.However, it is still subject to outgoing and incoming (on remote side) filter criteria.
UNLIMITED_PROPAGATION
is typical used to track a request, which may be processed across multiple entities.- Since:
- 0.20
-
-
Field Details
-
hops
private final int hops
-
-
Constructor Details
-
TagTtl
private TagTtl(int hops)
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-