Span (brave-core 3.2.0 API)

java.lang.Object
- com.twitter.zipkin.gen.Span

All Implemented Interfaces:: Serializable, Cloneable, Comparable<Span>, org.apache.thrift.TBase<Span,Span._Fields>

@Generated(value="Autogenerated by Thrift Compiler (0.9.2)",
           date="2015-11-8")
public class Span
extends Object
implements org.apache.thrift.TBase<Span,Span._Fields>, Serializable, Cloneable, Comparable<Span>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Span._Fields
The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Span._Fields` The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Field Summary

Fields
Modifier and Type	Field and Description
`List<Annotation>`	`annotations`
`List<BinaryAnnotation>`	`binary_annotations`
`boolean`	`debug`
`long`	`duration` Measurement of duration in microseconds, used to support queries.
`long`	`id`
`static Map<Span._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`String`	`name` Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".
`long`	`parent_id`
`Long`	`startTick` Internal field, used for deriving duration with `System.nanoTime()`.
`long`	`timestamp` Microseconds from epoch of the creation of this span.
`long`	`trace_id`

Constructor Summary

Constructors
Constructor and Description
`Span()`
`Span(long trace_id, String name, long id, List<Annotation> annotations, List<BinaryAnnotation> binary_annotations)`
`Span(Span other)` Performs a deep copy on other.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToAnnotations(Annotation elem)`
`void`	`addToBinary_annotations(BinaryAnnotation elem)`
`void`	`clear()`
`int`	`compareTo(Span other)`
`Span`	`deepCopy()`
`boolean`	`equals(Object that)`
`boolean`	`equals(Span that)`
`Span._Fields`	`fieldForId(int fieldId)`
`List<Annotation>`	`getAnnotations()`
`Iterator<Annotation>`	`getAnnotationsIterator()`
`int`	`getAnnotationsSize()`
`List<BinaryAnnotation>`	`getBinary_annotations()`
`Iterator<BinaryAnnotation>`	`getBinary_annotationsIterator()`
`int`	`getBinary_annotationsSize()`
`long`	`getDuration()` Measurement of duration in microseconds, used to support queries.
`Object`	`getFieldValue(Span._Fields field)`
`long`	`getId()`
`String`	`getName()` Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".
`long`	`getParent_id()`
`long`	`getTimestamp()` Microseconds from epoch of the creation of this span.
`long`	`getTrace_id()`
`int`	`hashCode()`
`boolean`	`isDebug()`
`boolean`	`isSet(Span._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetAnnotations()` Returns true if field annotations is set (has been assigned a value) and false otherwise
`boolean`	`isSetBinary_annotations()` Returns true if field binary_annotations is set (has been assigned a value) and false otherwise
`boolean`	`isSetDebug()` Returns true if field debug is set (has been assigned a value) and false otherwise
`boolean`	`isSetDuration()` Returns true if field duration is set (has been assigned a value) and false otherwise
`boolean`	`isSetId()` Returns true if field id is set (has been assigned a value) and false otherwise
`boolean`	`isSetName()` Returns true if field name is set (has been assigned a value) and false otherwise
`boolean`	`isSetParent_id()` Returns true if field parent_id is set (has been assigned a value) and false otherwise
`boolean`	`isSetTimestamp()` Returns true if field timestamp is set (has been assigned a value) and false otherwise
`boolean`	`isSetTrace_id()` Returns true if field trace_id is set (has been assigned a value) and false otherwise
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`Span`	`setAnnotations(List<Annotation> annotations)`
`void`	`setAnnotationsIsSet(boolean value)`
`Span`	`setBinary_annotations(List<BinaryAnnotation> binary_annotations)`
`void`	`setBinary_annotationsIsSet(boolean value)`
`Span`	`setDebug(boolean debug)`
`void`	`setDebugIsSet(boolean value)`
`Span`	`setDuration(long duration)` Measurement of duration in microseconds, used to support queries.
`void`	`setDurationIsSet(boolean value)`
`void`	`setFieldValue(Span._Fields field, Object value)`
`Span`	`setId(long id)`
`void`	`setIdIsSet(boolean value)`
`Span`	`setName(String name)` Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".
`void`	`setNameIsSet(boolean value)`
`Span`	`setParent_id(long parent_id)`
`void`	`setParent_idIsSet(boolean value)`
`Span`	`setTimestamp(long timestamp)` Microseconds from epoch of the creation of this span.
`void`	`setTimestampIsSet(boolean value)`
`Span`	`setTrace_id(long trace_id)`
`void`	`setTrace_idIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetAnnotations()`
`void`	`unsetBinary_annotations()`
`void`	`unsetDebug()`
`void`	`unsetDuration()`
`void`	`unsetId()`
`void`	`unsetName()`
`void`	`unsetParent_id()`
`void`	`unsetTimestamp()`
`void`	`unsetTrace_id()`
`void`	`validate()`
`void`	`write(org.apache.thrift.protocol.TProtocol oprot)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - startTick
```
public volatile Long startTick
```
    Internal field, used for deriving duration with System.nanoTime().
  - trace_id
```
public long trace_id
```
  - name
```
public String name
```
    Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".
  - id
```
public long id
```
  - parent_id
```
public long parent_id
```
  - annotations
```
public List<Annotation> annotations
```
  - binary_annotations
```
public List<BinaryAnnotation> binary_annotations
```
  - debug
```
public boolean debug
```
  - timestamp
```
public long timestamp
```
    Microseconds from epoch of the creation of this span. This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or syncing nanoTime against a tick of currentTimeMillis. For compatibilty with instrumentation that precede this field, collectors or span stores can derive this via Annotation.timestamp. For example, SERVER_RECV.timestamp or CLIENT_SEND.timestamp. This field is optional for compatibility with old data: first-party span stores are expected to support this at time of introduction.
  - duration
```
public long duration
```
    Measurement of duration in microseconds, used to support queries. This value should be set directly, where possible. Doing so encourages precise measurement decoupled from problems of clocks, such as skew or NTP updates causing time to move backwards. For compatibilty with instrumentation that precede this field, collectors or span stores can derive this by subtracting Annotation.timestamp. For example, SERVER_SEND.timestamp - SERVER_RECV.timestamp. If this field is persisted as unset, zipkin will continue to work, except duration query support will be implementation-specific. Similarly, setting this field non-atomically is implementation-specific. This field is i64 vs i32 to support spans longer than 35 minutes.
  - metaDataMap
```
public static final Map<Span._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
```
- Constructor Detail
  - Span
```
public Span()
```
  - Span
```
public Span(long trace_id,
            String name,
            long id,
            List<Annotation> annotations,
            List<BinaryAnnotation> binary_annotations)
```
  - Span
```
public Span(Span other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public Span deepCopy()
```
    Specified by:
    
    deepCopy in interface org.apache.thrift.TBase<Span,Span._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface org.apache.thrift.TBase<Span,Span._Fields>
  - getTrace_id
```
public long getTrace_id()
```
  - setTrace_id
```
public Span setTrace_id(long trace_id)
```
  - unsetTrace_id
```
public void unsetTrace_id()
```
  - isSetTrace_id
```
public boolean isSetTrace_id()
```
    Returns true if field trace_id is set (has been assigned a value) and false otherwise
  - setTrace_idIsSet
```
public void setTrace_idIsSet(boolean value)
```
  - getName
```
public String getName()
```
    Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".
  - setName
```
public Span setName(String name)
```
    Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".
  - unsetName
```
public void unsetName()
```
  - isSetName
```
public boolean isSetName()
```
    Returns true if field name is set (has been assigned a value) and false otherwise
  - setNameIsSet
```
public void setNameIsSet(boolean value)
```
  - getId
```
public long getId()
```
  - setId
```
public Span setId(long id)
```
  - unsetId
```
public void unsetId()
```
  - isSetId
```
public boolean isSetId()
```
    Returns true if field id is set (has been assigned a value) and false otherwise
  - setIdIsSet
```
public void setIdIsSet(boolean value)
```
  - getParent_id
```
public long getParent_id()
```
  - setParent_id
```
public Span setParent_id(long parent_id)
```
  - unsetParent_id
```
public void unsetParent_id()
```
  - isSetParent_id
```
public boolean isSetParent_id()
```
    Returns true if field parent_id is set (has been assigned a value) and false otherwise
  - setParent_idIsSet
```
public void setParent_idIsSet(boolean value)
```
  - getAnnotationsSize
```
public int getAnnotationsSize()
```
  - getAnnotationsIterator
```
public Iterator<Annotation> getAnnotationsIterator()
```
  - addToAnnotations
```
public void addToAnnotations(Annotation elem)
```
  - getAnnotations
```
public List<Annotation> getAnnotations()
```
  - setAnnotations
```
public Span setAnnotations(List<Annotation> annotations)
```
  - unsetAnnotations
```
public void unsetAnnotations()
```
  - isSetAnnotations
```
public boolean isSetAnnotations()
```
    Returns true if field annotations is set (has been assigned a value) and false otherwise
  - setAnnotationsIsSet
```
public void setAnnotationsIsSet(boolean value)
```
  - getBinary_annotationsSize
```
public int getBinary_annotationsSize()
```
  - getBinary_annotationsIterator
```
public Iterator<BinaryAnnotation> getBinary_annotationsIterator()
```
  - addToBinary_annotations
```
public void addToBinary_annotations(BinaryAnnotation elem)
```
  - getBinary_annotations
```
public List<BinaryAnnotation> getBinary_annotations()
```
  - setBinary_annotations
```
public Span setBinary_annotations(List<BinaryAnnotation> binary_annotations)
```
  - unsetBinary_annotations
```
public void unsetBinary_annotations()
```
  - isSetBinary_annotations
```
public boolean isSetBinary_annotations()
```
    Returns true if field binary_annotations is set (has been assigned a value) and false otherwise
  - setBinary_annotationsIsSet
```
public void setBinary_annotationsIsSet(boolean value)
```
  - isDebug
```
public boolean isDebug()
```
  - setDebug
```
public Span setDebug(boolean debug)
```
  - unsetDebug
```
public void unsetDebug()
```
  - isSetDebug
```
public boolean isSetDebug()
```
    Returns true if field debug is set (has been assigned a value) and false otherwise
  - setDebugIsSet
```
public void setDebugIsSet(boolean value)
```
  - getTimestamp
```
public long getTimestamp()
```
    Microseconds from epoch of the creation of this span. This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or syncing nanoTime against a tick of currentTimeMillis. For compatibilty with instrumentation that precede this field, collectors or span stores can derive this via Annotation.timestamp. For example, SERVER_RECV.timestamp or CLIENT_SEND.timestamp. This field is optional for compatibility with old data: first-party span stores are expected to support this at time of introduction.
  - setTimestamp
```
public Span setTimestamp(long timestamp)
```
    Microseconds from epoch of the creation of this span. This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or syncing nanoTime against a tick of currentTimeMillis. For compatibilty with instrumentation that precede this field, collectors or span stores can derive this via Annotation.timestamp. For example, SERVER_RECV.timestamp or CLIENT_SEND.timestamp. This field is optional for compatibility with old data: first-party span stores are expected to support this at time of introduction.
  - unsetTimestamp
```
public void unsetTimestamp()
```
  - isSetTimestamp
```
public boolean isSetTimestamp()
```
    Returns true if field timestamp is set (has been assigned a value) and false otherwise
  - setTimestampIsSet
```
public void setTimestampIsSet(boolean value)
```
  - getDuration
```
public long getDuration()
```
    Measurement of duration in microseconds, used to support queries. This value should be set directly, where possible. Doing so encourages precise measurement decoupled from problems of clocks, such as skew or NTP updates causing time to move backwards. For compatibilty with instrumentation that precede this field, collectors or span stores can derive this by subtracting Annotation.timestamp. For example, SERVER_SEND.timestamp - SERVER_RECV.timestamp. If this field is persisted as unset, zipkin will continue to work, except duration query support will be implementation-specific. Similarly, setting this field non-atomically is implementation-specific. This field is i64 vs i32 to support spans longer than 35 minutes.
  - setDuration
```
public Span setDuration(long duration)
```
    Measurement of duration in microseconds, used to support queries. This value should be set directly, where possible. Doing so encourages precise measurement decoupled from problems of clocks, such as skew or NTP updates causing time to move backwards. For compatibilty with instrumentation that precede this field, collectors or span stores can derive this by subtracting Annotation.timestamp. For example, SERVER_SEND.timestamp - SERVER_RECV.timestamp. If this field is persisted as unset, zipkin will continue to work, except duration query support will be implementation-specific. Similarly, setting this field non-atomically is implementation-specific. This field is i64 vs i32 to support spans longer than 35 minutes.
  - unsetDuration
```
public void unsetDuration()
```
  - isSetDuration
```
public boolean isSetDuration()
```
    Returns true if field duration is set (has been assigned a value) and false otherwise
  - setDurationIsSet
```
public void setDurationIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(Span._Fields field,
                          Object value)
```
    Specified by:
    
    setFieldValue in interface org.apache.thrift.TBase<Span,Span._Fields>
  - getFieldValue
```
public Object getFieldValue(Span._Fields field)
```
    Specified by:
    
    getFieldValue in interface org.apache.thrift.TBase<Span,Span._Fields>
  - isSet
```
public boolean isSet(Span._Fields field)
```
    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
    
    Specified by:
    
    isSet in interface org.apache.thrift.TBase<Span,Span._Fields>
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(Span that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Span other)
```
    Specified by:
    
    compareTo in interface Comparable<Span>
  - fieldForId
```
public Span._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface org.apache.thrift.TBase<Span,Span._Fields>
  - read
```
public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
```
    Specified by:
    
    read in interface org.apache.thrift.TBase<Span,Span._Fields>
    
    Throws:
    
    org.apache.thrift.TException
  - write
```
public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException
```
    Specified by:
    
    write in interface org.apache.thrift.TBase<Span,Span._Fields>
    
    Throws:
    
    org.apache.thrift.TException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validate
```
public void validate()
              throws org.apache.thrift.TException
```
    Throws:
    
    org.apache.thrift.TException

Class Span

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startTick

trace_id

name

id

parent_id

annotations

binary_annotations

debug

timestamp

duration

metaDataMap

Constructor Detail

Span

Span

Span

Method Detail

deepCopy

clear

getTrace_id

setTrace_id

unsetTrace_id

isSetTrace_id

setTrace_idIsSet

getName

setName

unsetName

isSetName

setNameIsSet

getId

setId

unsetId

isSetId

setIdIsSet

getParent_id

setParent_id

unsetParent_id

isSetParent_id

setParent_idIsSet

getAnnotationsSize

getAnnotationsIterator

addToAnnotations

getAnnotations

setAnnotations

unsetAnnotations

isSetAnnotations

setAnnotationsIsSet

getBinary_annotationsSize

getBinary_annotationsIterator

addToBinary_annotations

getBinary_annotations

setBinary_annotations

unsetBinary_annotations

isSetBinary_annotations

setBinary_annotationsIsSet

isDebug

setDebug

unsetDebug

isSetDebug

setDebugIsSet

getTimestamp

setTimestamp

unsetTimestamp

isSetTimestamp

setTimestampIsSet

getDuration

setDuration

unsetDuration

isSetDuration

setDurationIsSet

setFieldValue

getFieldValue

isSet

equals