io.opencensus.trace

Enum Span.Options

java.lang.Object

java.lang.Enum<Span.Options>

io.opencensus.trace.Span.Options

All Implemented Interfaces:

Serializable, Comparable<Span.Options>

Enclosing class:

Span

public static enum Span.Options
extends Enum<Span.Options>

Span options. These options are NOT propagated to child spans. These options determine features such as whether a Span should record any annotations or events.

Since:

0.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECORD_EVENTS This option is set if the Span is part of a sampled distributed trace OR SpanBuilder.setRecordEvents(boolean) was called with true.

Method Summary

Modifier and Type	Method and Description
static Span.Options	valueOf(String name) Returns the enum constant of this type with the specified name.
static Span.Options[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECORD_EVENTS

public static final Span.Options RECORD_EVENTS

This option is set if the Span is part of a sampled distributed trace OR SpanBuilder.setRecordEvents(boolean) was called with true.

Since:

0.5

Method Detail

values

public static Span.Options[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Span.Options c : Span.Options.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Span.Options valueOf(String name)

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 name

NullPointerException - if the argument is null