com.amazonaws.xray.entities

Interface Subsegment

All Superinterfaces:

AutoCloseable, Entity

All Known Implementing Classes:

DummySubsegment, SubsegmentImpl

public interface Subsegment
extends Entity

Method Summary

Modifier and Type	Method and Description
void	addPrecursorId(String precursorId)
void	close()
boolean	end() Ends the subsegment.
String	getNamespace()
Segment	getParentSegment()
Set<String>	getPrecursorIds()
String	prettyStreamSerialize() Pretty-serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.
void	setNamespace(String namespace)
void	setParentSegment(Segment parentSegment)
void	setPrecursorIds(Set<String> precursorIds)
String	streamSerialize() Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.

Methods inherited from interface com.amazonaws.xray.entities.Entity

addException, addSubsegment, decrementReferenceCount, generateId, getAnnotations, getAws, getCause, getCreator, getEndTime, getHttp, getId, getMetadata, getName, getParent, getParentId, getReferenceCount, getSql, getStartTime, getSubsegments, getSubsegmentsLock, getTotalSize, getTraceId, incrementReferenceCount, isEmitted, isError, isFault, isInProgress, isThrottle, prettySerialize, putAllAws, putAllHttp, putAllSql, putAnnotation, putAnnotation, putAnnotation, putAws, putHttp, putMetadata, putMetadata, putSql, removeSubsegment, serialize, setAnnotations, setAws, setCreator, setEmitted, setEndTime, setError, setFault, setHttp, setId, setInProgress, setMetadata, setParent, setParentId, setSql, setStartTime, setSubsegmentsLock, setThrottle, setTraceId

Method Detail

end

boolean end()

Ends the subsegment. Sets the end time to the current time. Sets inProgress to false. Decrements its parent segment's segment-reference counter.

Returns:

true if 1) the parent segment now has a ref. count of zero and 2) the parent segment is sampled

getNamespace

String getNamespace()

Specified by:

getNamespace in interface Entity

Returns:

the namespace

setNamespace

void setNamespace(String namespace)

Specified by:

setNamespace in interface Entity

Parameters:

namespace - the namespace to set

getParentSegment

Segment getParentSegment()

Specified by:

getParentSegment in interface Entity

Returns:

the parentSegment

setParentSegment

void setParentSegment(Segment parentSegment)

Parameters:

parentSegment - the parentSegment to set

getPrecursorIds

Set<String> getPrecursorIds()

Returns:

the precursorIds

setPrecursorIds

void setPrecursorIds(Set<String> precursorIds)

Parameters:

precursorIds - the precursorIds to set

addPrecursorId

void addPrecursorId(String precursorId)

Parameters:

precursorId - the precursor ID to add to the set

streamSerialize

String streamSerialize()

Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.

Returns:

the string representation of the subsegment with enouogh information for it to be streamed

prettyStreamSerialize

String prettyStreamSerialize()

Pretty-serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own. Only used for debugging.

Returns:

the pretty string representation of the subsegment with enouogh information for it to be streamed

close

void close()

Specified by:

close in interface AutoCloseable