com.datadog.api.client.v2.model

Class SpansAttributes

java.lang.Object

com.datadog.api.client.v2.model.SpansAttributes

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

JSON object containing all span attributes and their associated values.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ATTRIBUTES
static String	JSON_PROPERTY_CUSTOM
static String	JSON_PROPERTY_END_TIMESTAMP
static String	JSON_PROPERTY_ENV
static String	JSON_PROPERTY_HOST
static String	JSON_PROPERTY_INGESTION_REASON
static String	JSON_PROPERTY_PARENT_ID
static String	JSON_PROPERTY_RESOURCE_HASH
static String	JSON_PROPERTY_RESOURCE_NAME
static String	JSON_PROPERTY_RETAINED_BY
static String	JSON_PROPERTY_SERVICE
static String	JSON_PROPERTY_SINGLE_SPAN
static String	JSON_PROPERTY_SPAN_ID
static String	JSON_PROPERTY_START_TIMESTAMP
static String	JSON_PROPERTY_TAGS
static String	JSON_PROPERTY_TRACE_ID
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SpansAttributes()

Method Summary

Modifier and Type	Method and Description
SpansAttributes	addTagsItem(String tagsItem)
SpansAttributes	attributes(Map<String,Object> attributes)
SpansAttributes	custom(Map<String,Object> custom)
SpansAttributes	endTimestamp(OffsetDateTime endTimestamp)
SpansAttributes	env(String env)
boolean	equals(Object o) Return true if this SpansAttributes object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Map<String,Object>	getAttributes() JSON object of attributes from your span.
Map<String,Object>	getCustom() JSON object of custom spans data.
OffsetDateTime	getEndTimestamp() End timestamp of your span.
String	getEnv() Name of the environment from where the spans are being sent.
String	getHost() Name of the machine from where the spans are being sent.
String	getIngestionReason() The reason why the span was ingested.
String	getParentId() Id of the span that's parent of this span.
String	getResourceHash() Unique identifier of the resource.
String	getResourceName() The name of the resource.
String	getRetainedBy() The reason why the span was indexed.
String	getService() The name of the application or service generating the span events.
Boolean	getSingleSpan() Whether or not the span was collected as a stand-alone span.
String	getSpanId() Id of the span.
OffsetDateTime	getStartTimestamp() Start timestamp of your span.
List<String>	getTags() Array of tags associated with your span.
String	getTraceId() Id of the trace to which the span belongs.
String	getType() The type of the span.
int	hashCode()
SpansAttributes	host(String host)
SpansAttributes	ingestionReason(String ingestionReason)
SpansAttributes	parentId(String parentId)
SpansAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SpansAttributes	putAttributesItem(String key, Object attributesItem)
SpansAttributes	putCustomItem(String key, Object customItem)
SpansAttributes	resourceHash(String resourceHash)
SpansAttributes	resourceName(String resourceName)
SpansAttributes	retainedBy(String retainedBy)
SpansAttributes	service(String service)
void	setAttributes(Map<String,Object> attributes)
void	setCustom(Map<String,Object> custom)
void	setEndTimestamp(OffsetDateTime endTimestamp)
void	setEnv(String env)
void	setHost(String host)
void	setIngestionReason(String ingestionReason)
void	setParentId(String parentId)
void	setResourceHash(String resourceHash)
void	setResourceName(String resourceName)
void	setRetainedBy(String retainedBy)
void	setService(String service)
void	setSingleSpan(Boolean singleSpan)
void	setSpanId(String spanId)
void	setStartTimestamp(OffsetDateTime startTimestamp)
void	setTags(List<String> tags)
void	setTraceId(String traceId)
void	setType(String type)
SpansAttributes	singleSpan(Boolean singleSpan)
SpansAttributes	spanId(String spanId)
SpansAttributes	startTimestamp(OffsetDateTime startTimestamp)
SpansAttributes	tags(List<String> tags)
String	toString()
SpansAttributes	traceId(String traceId)
SpansAttributes	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_ATTRIBUTES

public static final String JSON_PROPERTY_ATTRIBUTES

See Also:

Constant Field Values

JSON_PROPERTY_CUSTOM

public static final String JSON_PROPERTY_CUSTOM

See Also:

Constant Field Values

JSON_PROPERTY_END_TIMESTAMP

public static final String JSON_PROPERTY_END_TIMESTAMP

See Also:

Constant Field Values

JSON_PROPERTY_ENV

public static final String JSON_PROPERTY_ENV

See Also:

Constant Field Values

JSON_PROPERTY_HOST

public static final String JSON_PROPERTY_HOST

See Also:

Constant Field Values

JSON_PROPERTY_INGESTION_REASON

public static final String JSON_PROPERTY_INGESTION_REASON

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_HASH

public static final String JSON_PROPERTY_RESOURCE_HASH

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE_NAME

public static final String JSON_PROPERTY_RESOURCE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_RETAINED_BY

public static final String JSON_PROPERTY_RETAINED_BY

See Also:

Constant Field Values

JSON_PROPERTY_SERVICE

public static final String JSON_PROPERTY_SERVICE

See Also:

Constant Field Values

JSON_PROPERTY_SINGLE_SPAN

public static final String JSON_PROPERTY_SINGLE_SPAN

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_TIMESTAMP

public static final String JSON_PROPERTY_START_TIMESTAMP

See Also:

Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

Constant Field Values

JSON_PROPERTY_TRACE_ID

public static final String JSON_PROPERTY_TRACE_ID

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

SpansAttributes

public SpansAttributes()

Method Detail

attributes

public SpansAttributes attributes(Map<String,Object> attributes)

putAttributesItem

public SpansAttributes putAttributesItem(String key,
                                         Object attributesItem)

getAttributes

@Nullable
public Map<String,Object> getAttributes()

JSON object of attributes from your span.

Returns:

attributes

setAttributes

public void setAttributes(Map<String,Object> attributes)

custom

public SpansAttributes custom(Map<String,Object> custom)

putCustomItem

public SpansAttributes putCustomItem(String key,
                                     Object customItem)

getCustom

@Nullable
public Map<String,Object> getCustom()

JSON object of custom spans data.

Returns:

custom

setCustom

public void setCustom(Map<String,Object> custom)

endTimestamp

public SpansAttributes endTimestamp(OffsetDateTime endTimestamp)

getEndTimestamp

@Nullable
public OffsetDateTime getEndTimestamp()

End timestamp of your span.

Returns:

endTimestamp

setEndTimestamp

public void setEndTimestamp(OffsetDateTime endTimestamp)

env

public SpansAttributes env(String env)

getEnv

@Nullable
public String getEnv()

Name of the environment from where the spans are being sent.

Returns:

env

setEnv

public void setEnv(String env)

host

public SpansAttributes host(String host)

getHost

@Nullable
public String getHost()

Name of the machine from where the spans are being sent.

Returns:

host

setHost

public void setHost(String host)

ingestionReason

public SpansAttributes ingestionReason(String ingestionReason)

getIngestionReason

@Nullable
public String getIngestionReason()

The reason why the span was ingested.

Returns:

ingestionReason

setIngestionReason

public void setIngestionReason(String ingestionReason)

parentId

public SpansAttributes parentId(String parentId)

getParentId

@Nullable
public String getParentId()

Id of the span that's parent of this span.

Returns:

parentId

setParentId

public void setParentId(String parentId)

resourceHash

public SpansAttributes resourceHash(String resourceHash)

getResourceHash

@Nullable
public String getResourceHash()

Unique identifier of the resource.

Returns:

resourceHash

setResourceHash

public void setResourceHash(String resourceHash)

resourceName

public SpansAttributes resourceName(String resourceName)

getResourceName

@Nullable
public String getResourceName()

The name of the resource.

Returns:

resourceName

setResourceName

public void setResourceName(String resourceName)

retainedBy

public SpansAttributes retainedBy(String retainedBy)

getRetainedBy

@Nullable
public String getRetainedBy()

The reason why the span was indexed.

Returns:

retainedBy

setRetainedBy

public void setRetainedBy(String retainedBy)

service

public SpansAttributes service(String service)

getService

@Nullable
public String getService()

The name of the application or service generating the span events. It is used to switch from APM to Logs, so make sure you define the same value when you use both products.

Returns:

service

setService

public void setService(String service)

singleSpan

public SpansAttributes singleSpan(Boolean singleSpan)

getSingleSpan

@Nullable
public Boolean getSingleSpan()

Whether or not the span was collected as a stand-alone span. Always associated to "single_span" ingestion_reason if true.

Returns:

singleSpan

setSingleSpan

public void setSingleSpan(Boolean singleSpan)

spanId

public SpansAttributes spanId(String spanId)

getSpanId

@Nullable
public String getSpanId()

Id of the span.

Returns:

spanId

setSpanId

public void setSpanId(String spanId)

startTimestamp

public SpansAttributes startTimestamp(OffsetDateTime startTimestamp)

getStartTimestamp

@Nullable
public OffsetDateTime getStartTimestamp()

Start timestamp of your span.

Returns:

startTimestamp

setStartTimestamp

public void setStartTimestamp(OffsetDateTime startTimestamp)

tags

public SpansAttributes tags(List<String> tags)

addTagsItem

public SpansAttributes addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

Array of tags associated with your span.

Returns:

tags

setTags

public void setTags(List<String> tags)

traceId

public SpansAttributes traceId(String traceId)

getTraceId

@Nullable
public String getTraceId()

Id of the trace to which the span belongs.

Returns:

traceId

setTraceId

public void setTraceId(String traceId)

type

public SpansAttributes type(String type)

getType

@Nullable
public String getType()

The type of the span.

Returns:

type

setType

public void setType(String type)

putAdditionalProperty

public SpansAttributes 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:

SpansAttributes

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 SpansAttributes 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