com.datadog.api.client.v2.model

Class APMTraceSpan

java.lang.Object

com.datadog.api.client.v2.model.APMTraceSpan

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class APMTraceSpan
extends Object

A single APM span returned as part of a trace.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DURATION
static String	JSON_PROPERTY_END_TIME
static String	JSON_PROPERTY_ERROR
static String	JSON_PROPERTY_META
static String	JSON_PROPERTY_METRICS
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_PARENT_ID
static String	JSON_PROPERTY_RESOURCE
static String	JSON_PROPERTY_RESOURCE_HASH
static String	JSON_PROPERTY_RESTRICTED
static String	JSON_PROPERTY_SELF_TIME
static String	JSON_PROPERTY_SERVICE
static String	JSON_PROPERTY_SPAN_ID
static String	JSON_PROPERTY_START_TIME
static String	JSON_PROPERTY_TRACE_ID
static String	JSON_PROPERTY_TRACE_ID_FULL
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
APMTraceSpan()
APMTraceSpan(Long duration, Long endTime, APMSpanErrorFlag error, Map<String,String> meta, Map<String,Double> metrics, String name, Long parentId, String resource, String service, Long spanId, Long startTime, Long traceId, String traceIdFull, String type)

Method Summary

Modifier and Type	Method and Description
APMTraceSpan	duration(Long duration)
APMTraceSpan	endTime(Long endTime)
boolean	equals(Object o) Return true if this APMTraceSpan object is equal to o.
APMTraceSpan	error(APMSpanErrorFlag error)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Long	getDuration() The duration of the span, in nanoseconds.
Long	getEndTime() The end time of the span, in Unix nanoseconds.
APMSpanErrorFlag	getError() Error flag for a span.
Map<String,String>	getMeta() String-valued tags attached to the span.
Map<String,Double>	getMetrics() Numeric metrics attached to the span.
String	getName() The operation name of the span.
Long	getParentId() The ID of the parent span, or 0 when the span is a trace root.
String	getResource() The resource that the span describes.
String	getResourceHash() A hash of the resource field.
Boolean	getRestricted() Whether access to the span is restricted by the organization's data access policies.
Double	getSelfTime() The time spent in the span itself, excluding time spent in child spans, in nanoseconds.
String	getService() The name of the service that emitted the span.
Long	getSpanId() The span ID, as an unsigned 64-bit integer.
Long	getStartTime() The start time of the span, in Unix nanoseconds.
Long	getTraceId() The lower 64 bits of the trace ID, as an unsigned 64-bit integer.
String	getTraceIdFull() The full 128-bit trace ID, encoded as a 32-character hexadecimal string.
String	getType() The type of the span (for example, web, db, or rpc).
int	hashCode()
APMTraceSpan	meta(Map<String,String> meta)
APMTraceSpan	metrics(Map<String,Double> metrics)
APMTraceSpan	name(String name)
APMTraceSpan	parentId(Long parentId)
APMTraceSpan	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
APMTraceSpan	putMetaItem(String key, String metaItem)
APMTraceSpan	putMetricsItem(String key, Double metricsItem)
APMTraceSpan	resource(String resource)
APMTraceSpan	resourceHash(String resourceHash)
APMTraceSpan	restricted(Boolean restricted)
APMTraceSpan	selfTime(Double selfTime)
APMTraceSpan	service(String service)
void	setDuration(Long duration)
void	setEndTime(Long endTime)
void	setError(APMSpanErrorFlag error)
void	setMeta(Map<String,String> meta)
void	setMetrics(Map<String,Double> metrics)
void	setName(String name)
void	setParentId(Long parentId)
void	setResource(String resource)
void	setResourceHash(String resourceHash)
void	setRestricted(Boolean restricted)
void	setSelfTime(Double selfTime)
void	setService(String service)
void	setSpanId(Long spanId)
void	setStartTime(Long startTime)
void	setTraceId(Long traceId)
void	setTraceIdFull(String traceIdFull)
void	setType(String type)
APMTraceSpan	spanId(Long spanId)
APMTraceSpan	startTime(Long startTime)
String	toString()
APMTraceSpan	traceId(Long traceId)
APMTraceSpan	traceIdFull(String traceIdFull)
APMTraceSpan	type(String type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_DURATION

public static final String JSON_PROPERTY_DURATION

See Also:

Constant Field Values

JSON_PROPERTY_END_TIME

public static final String JSON_PROPERTY_END_TIME

See Also:

Constant Field Values

JSON_PROPERTY_ERROR

public static final String JSON_PROPERTY_ERROR

See Also:

Constant Field Values

JSON_PROPERTY_META

public static final String JSON_PROPERTY_META

See Also:

Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_PARENT_ID

public static final String JSON_PROPERTY_PARENT_ID

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE

public static final String JSON_PROPERTY_RESOURCE

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE_HASH

public static final String JSON_PROPERTY_RESOURCE_HASH

See Also:

Constant Field Values

JSON_PROPERTY_RESTRICTED

public static final String JSON_PROPERTY_RESTRICTED

See Also:

Constant Field Values

JSON_PROPERTY_SELF_TIME

public static final String JSON_PROPERTY_SELF_TIME

See Also:

Constant Field Values

JSON_PROPERTY_SERVICE

public static final String JSON_PROPERTY_SERVICE

See Also:

Constant Field Values

JSON_PROPERTY_SPAN_ID

public static final String JSON_PROPERTY_SPAN_ID

See Also:

Constant Field Values

JSON_PROPERTY_START_TIME

public static final String JSON_PROPERTY_START_TIME

See Also:

Constant Field Values

JSON_PROPERTY_TRACE_ID

public static final String JSON_PROPERTY_TRACE_ID

See Also:

Constant Field Values

JSON_PROPERTY_TRACE_ID_FULL

public static final String JSON_PROPERTY_TRACE_ID_FULL

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

APMTraceSpan

public APMTraceSpan()

APMTraceSpan

public APMTraceSpan(Long duration,
                    Long endTime,
                    APMSpanErrorFlag error,
                    Map<String,String> meta,
                    Map<String,Double> metrics,
                    String name,
                    Long parentId,
                    String resource,
                    String service,
                    Long spanId,
                    Long startTime,
                    Long traceId,
                    String traceIdFull,
                    String type)

Method Detail

duration

public APMTraceSpan duration(Long duration)

getDuration

public Long getDuration()

The duration of the span, in nanoseconds.

Returns:

duration

setDuration

public void setDuration(Long duration)

endTime

public APMTraceSpan endTime(Long endTime)

getEndTime

public Long getEndTime()

The end time of the span, in Unix nanoseconds.

Returns:

endTime

setEndTime

public void setEndTime(Long endTime)

error

public APMTraceSpan error(APMSpanErrorFlag error)

getError

public APMSpanErrorFlag getError()

Error flag for a span. 1 when the span is in error, 0 otherwise.

Returns:

error

setError

public void setError(APMSpanErrorFlag error)

meta

public APMTraceSpan meta(Map<String,String> meta)

putMetaItem

public APMTraceSpan putMetaItem(String key,
                                String metaItem)

getMeta

public Map<String,String> getMeta()

String-valued tags attached to the span. Tag keys starting with _ are filtered out of the response.

Returns:

meta

setMeta

public void setMeta(Map<String,String> meta)

metrics

public APMTraceSpan metrics(Map<String,Double> metrics)

putMetricsItem

public APMTraceSpan putMetricsItem(String key,
                                   Double metricsItem)

getMetrics

public Map<String,Double> getMetrics()

Numeric metrics attached to the span. Metric keys starting with _ are filtered out of the response.

Returns:

metrics

setMetrics

public void setMetrics(Map<String,Double> metrics)

name

public APMTraceSpan name(String name)

getName

public String getName()

The operation name of the span.

Returns:

name

setName

public void setName(String name)

parentId

public APMTraceSpan parentId(Long parentId)

getParentId

public Long getParentId()

The ID of the parent span, or 0 when the span is a trace root.

Returns:

parentId

setParentId

public void setParentId(Long parentId)

resource

public APMTraceSpan resource(String resource)

getResource

public String getResource()

The resource that the span describes.

Returns:

resource

setResource

public void setResource(String resource)

resourceHash

public APMTraceSpan resourceHash(String resourceHash)

getResourceHash

@Nullable
public String getResourceHash()

A hash of the resource field.

Returns:

resourceHash

setResourceHash

public void setResourceHash(String resourceHash)

restricted

public APMTraceSpan restricted(Boolean restricted)

getRestricted

@Nullable
public Boolean getRestricted()

Whether access to the span is restricted by the organization's data access policies.

Returns:

restricted

setRestricted

public void setRestricted(Boolean restricted)

selfTime

public APMTraceSpan selfTime(Double selfTime)

getSelfTime

@Nullable
public Double getSelfTime()

The time spent in the span itself, excluding time spent in child spans, in nanoseconds.

Returns:

selfTime

setSelfTime

public void setSelfTime(Double selfTime)

service

public APMTraceSpan service(String service)

getService

public String getService()

The name of the service that emitted the span.

Returns:

service

setService

public void setService(String service)

spanId

public APMTraceSpan spanId(Long spanId)

getSpanId

public Long getSpanId()

The span ID, as an unsigned 64-bit integer.

Returns:

spanId

setSpanId

public void setSpanId(Long spanId)

startTime

public APMTraceSpan startTime(Long startTime)

getStartTime

public Long getStartTime()

The start time of the span, in Unix nanoseconds.

Returns:

startTime

setStartTime

public void setStartTime(Long startTime)

traceId

public APMTraceSpan traceId(Long traceId)

getTraceId

public Long getTraceId()

The lower 64 bits of the trace ID, as an unsigned 64-bit integer.

Returns:

traceId

setTraceId

public void setTraceId(Long traceId)

traceIdFull

public APMTraceSpan traceIdFull(String traceIdFull)

getTraceIdFull

public String getTraceIdFull()

The full 128-bit trace ID, encoded as a 32-character hexadecimal string.

Returns:

traceIdFull

setTraceIdFull

public void setTraceIdFull(String traceIdFull)

type

public APMTraceSpan type(String type)

getType

public String getType()

The type of the span (for example, web, db, or rpc).

Returns:

type

setType

public void setType(String type)

putAdditionalProperty

public APMTraceSpan putAdditionalProperty(String key,
                                          Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

APMTraceSpan

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this APMTraceSpan object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object