Span (Cloud Trace API v2-rev20210325-1.31.5)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudtrace.v2.model.Span

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Span
extends GenericJson
```
A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Trace API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Span()

Constructors
Constructor and Description
`Span()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Span`	`clone()`
`Attributes`	`getAttributes()` A set of attributes on the span.
`Integer`	`getChildSpanCount()` Optional.
`TruncatableString`	`getDisplayName()` Required.
`String`	`getEndTime()` Required.
`Links`	`getLinks()` Links associated with the span.
`String`	`getName()` Required.
`String`	`getParentSpanId()` The [SPAN_ID] of this span's parent span.
`Boolean`	`getSameProcessAsParentSpan()` Optional.
`String`	`getSpanId()` Required.
`String`	`getSpanKind()` Optional.
`StackTrace`	`getStackTrace()` Stack trace captured at the start of the span.
`String`	`getStartTime()` Required.
`Status`	`getStatus()` Optional.
`TimeEvents`	`getTimeEvents()` A set of time events.
`Span`	`set(String fieldName, Object value)`
`Span`	`setAttributes(Attributes attributes)` A set of attributes on the span.
`Span`	`setChildSpanCount(Integer childSpanCount)` Optional.
`Span`	`setDisplayName(TruncatableString displayName)` Required.
`Span`	`setEndTime(String endTime)` Required.
`Span`	`setLinks(Links links)` Links associated with the span.
`Span`	`setName(String name)` Required.
`Span`	`setParentSpanId(String parentSpanId)` The [SPAN_ID] of this span's parent span.
`Span`	`setSameProcessAsParentSpan(Boolean sameProcessAsParentSpan)` Optional.
`Span`	`setSpanId(String spanId)` Required.
`Span`	`setSpanKind(String spanKind)` Optional.
`Span`	`setStackTrace(StackTrace stackTrace)` Stack trace captured at the start of the span.
`Span`	`setStartTime(String startTime)` Required.
`Span`	`setStatus(Status status)` Optional.
`Span`	`setTimeEvents(TimeEvents timeEvents)` A set of time events.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Span
```
public Span()
```
- Method Detail
  - getAttributes
```
public Attributes getAttributes()
```
    A set of attributes on the span. You can have up to 32 attributes per span.
    
    Returns:
    
    value or null for none
  - setAttributes
```
public Span setAttributes(Attributes attributes)
```
    A set of attributes on the span. You can have up to 32 attributes per span.
    
    Parameters:
    
    attributes - attributes or null for none
  - getChildSpanCount
```
public Integer getChildSpanCount()
```
    Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
    
    Returns:
    
    value or null for none
  - setChildSpanCount
```
public Span setChildSpanCount(Integer childSpanCount)
```
    Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
    
    Parameters:
    
    childSpanCount - childSpanCount or null for none
  - getDisplayName
```
public TruncatableString getDisplayName()
```
    Required. A description of the span's operation (up to 128 bytes). Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Span setDisplayName(TruncatableString displayName)
```
    Required. A description of the span's operation (up to 128 bytes). Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEndTime
```
public String getEndTime()
```
    Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
    
    Returns:
    
    value or null for none
  - setEndTime
```
public Span setEndTime(String endTime)
```
    Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
    
    Parameters:
    
    endTime - endTime or null for none
  - getLinks
```
public Links getLinks()
```
    Links associated with the span. You can have up to 128 links per Span.
    
    Returns:
    
    value or null for none
  - setLinks
```
public Span setLinks(Links links)
```
    Links associated with the span. You can have up to 128 links per Span.
    
    Parameters:
    
    links - links or null for none
  - getName
```
public String getName()
```
    Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero.
    
    Returns:
    
    value or null for none
  - setName
```
public Span setName(String name)
```
    Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero.
    
    Parameters:
    
    name - name or null for none
  - getParentSpanId
```
public String getParentSpanId()
```
    The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
    
    Returns:
    
    value or null for none
  - setParentSpanId
```
public Span setParentSpanId(String parentSpanId)
```
    The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
    
    Parameters:
    
    parentSpanId - parentSpanId or null for none
  - getSameProcessAsParentSpan
```
public Boolean getSameProcessAsParentSpan()
```
    Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.
    
    Returns:
    
    value or null for none
  - setSameProcessAsParentSpan
```
public Span setSameProcessAsParentSpan(Boolean sameProcessAsParentSpan)
```
    Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.
    
    Parameters:
    
    sameProcessAsParentSpan - sameProcessAsParentSpan or null for none
  - getSpanId
```
public String getSpanId()
```
    Required. The [SPAN_ID] portion of the span's resource name.
    
    Returns:
    
    value or null for none
  - setSpanId
```
public Span setSpanId(String spanId)
```
    Required. The [SPAN_ID] portion of the span's resource name.
    
    Parameters:
    
    spanId - spanId or null for none
  - getSpanKind
```
public String getSpanKind()
```
    Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
    
    Returns:
    
    value or null for none
  - setSpanKind
```
public Span setSpanKind(String spanKind)
```
    Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
    
    Parameters:
    
    spanKind - spanKind or null for none
  - getStackTrace
```
public StackTrace getStackTrace()
```
    Stack trace captured at the start of the span.
    
    Returns:
    
    value or null for none
  - setStackTrace
```
public Span setStackTrace(StackTrace stackTrace)
```
    Stack trace captured at the start of the span.
    
    Parameters:
    
    stackTrace - stackTrace or null for none
  - getStartTime
```
public String getStartTime()
```
    Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public Span setStartTime(String startTime)
```
    Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
    
    Parameters:
    
    startTime - startTime or null for none
  - getStatus
```
public Status getStatus()
```
    Optional. The final status for this span.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Span setStatus(Status status)
```
    Optional. The final status for this span.
    
    Parameters:
    
    status - status or null for none
  - getTimeEvents
```
public TimeEvents getTimeEvents()
```
    A set of time events. You can have up to 32 annotations and 128 message events per span.
    
    Returns:
    
    value or null for none
  - setTimeEvents
```
public Span setTimeEvents(TimeEvents timeEvents)
```
    A set of time events. You can have up to 32 annotations and 128 message events per span.
    
    Parameters:
    
    timeEvents - timeEvents or null for none
  - set
```
public Span set(String fieldName,
                Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Span clone()
```
    Overrides:
    
    clone in class GenericJson

Class Span

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Span

Method Detail

getAttributes

setAttributes

getChildSpanCount

setChildSpanCount

getDisplayName

setDisplayName

getEndTime

setEndTime

getLinks

setLinks

getName

setName

getParentSpanId

setParentSpanId

getSameProcessAsParentSpan

setSameProcessAsParentSpan

getSpanId

setSpanId

getSpanKind

setSpanKind

getStackTrace

setStackTrace

getStartTime

setStartTime

getStatus

setStatus

getTimeEvents

setTimeEvents

set

clone