com.oracle.bmc.apmtraces.model

Class TraceSpanSummary.Builder

java.lang.Object

com.oracle.bmc.apmtraces.model.TraceSpanSummary.Builder

Enclosing class:

TraceSpanSummary

public static class TraceSpanSummary.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TraceSpanSummary	build()
TraceSpanSummary.Builder	copy(TraceSpanSummary model)
TraceSpanSummary.Builder	errorSpanCount(Integer errorSpanCount) The number of spans with errors that have been processed by the system for the trace.
TraceSpanSummary.Builder	isFault(Boolean isFault) Boolean flag that indicates whether the trace has an error.
TraceSpanSummary.Builder	key(String key) Unique identifier (traceId) for the trace that represents the span set.
TraceSpanSummary.Builder	rootSpanDurationInMs(Integer rootSpanDurationInMs) Time taken for the root span operation to complete in milliseconds.
TraceSpanSummary.Builder	rootSpanOperationName(String rootSpanOperationName) Root span name associated with the trace.
TraceSpanSummary.Builder	rootSpanServiceName(String rootSpanServiceName) Service associated with the trace.
TraceSpanSummary.Builder	serviceSummaries(List<TraceServiceSummary> serviceSummaries) A summary of the spans by service.
TraceSpanSummary.Builder	spanCount(Integer spanCount) The number of spans that have been processed by the system for the trace.
TraceSpanSummary.Builder	timeEarliestSpanStarted(Date timeEarliestSpanStarted) Start time of the earliest span in the span collection.
TraceSpanSummary.Builder	timeLatestSpanEnded(Date timeLatestSpanEnded) End time of the span that most recently ended in the span collection.
TraceSpanSummary.Builder	timeRootSpanEnded(Date timeRootSpanEnded) End time of the root span for the span collection.
TraceSpanSummary.Builder	timeRootSpanStarted(Date timeRootSpanStarted) Start time of the root span for the span collection.
TraceSpanSummary.Builder	traceDurationInMs(Integer traceDurationInMs) Time between the start of the earliest span and the end of the most recent span in milliseconds.
TraceSpanSummary.Builder	traceErrorCode(String traceErrorCode) Error code of the trace.
TraceSpanSummary.Builder	traceErrorType(String traceErrorType) Error type of the trace.
TraceSpanSummary.Builder	traceStatus(String traceStatus) The status of the trace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

key

public TraceSpanSummary.Builder key(String key)

Unique identifier (traceId) for the trace that represents the span set. Note that this field is defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance Monitoring.

Parameters:

key - the value to set

Returns:

this builder

rootSpanOperationName

public TraceSpanSummary.Builder rootSpanOperationName(String rootSpanOperationName)

Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.

Parameters:

rootSpanOperationName - the value to set

Returns:

this builder

timeEarliestSpanStarted

public TraceSpanSummary.Builder timeEarliestSpanStarted(Date timeEarliestSpanStarted)

Start time of the earliest span in the span collection.

Parameters:

timeEarliestSpanStarted - the value to set

Returns:

this builder

timeLatestSpanEnded

public TraceSpanSummary.Builder timeLatestSpanEnded(Date timeLatestSpanEnded)

End time of the span that most recently ended in the span collection.

Parameters:

timeLatestSpanEnded - the value to set

Returns:

this builder

spanCount

public TraceSpanSummary.Builder spanCount(Integer spanCount)

The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.

Parameters:

spanCount - the value to set

Returns:

this builder

errorSpanCount

public TraceSpanSummary.Builder errorSpanCount(Integer errorSpanCount)

The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.

Parameters:

errorSpanCount - the value to set

Returns:

this builder

rootSpanServiceName

public TraceSpanSummary.Builder rootSpanServiceName(String rootSpanServiceName)

Service associated with the trace.

Parameters:

rootSpanServiceName - the value to set

Returns:

this builder

timeRootSpanStarted

public TraceSpanSummary.Builder timeRootSpanStarted(Date timeRootSpanStarted)

Start time of the root span for the span collection.

Parameters:

timeRootSpanStarted - the value to set

Returns:

this builder

timeRootSpanEnded

public TraceSpanSummary.Builder timeRootSpanEnded(Date timeRootSpanEnded)

End time of the root span for the span collection.

Parameters:

timeRootSpanEnded - the value to set

Returns:

this builder

rootSpanDurationInMs

public TraceSpanSummary.Builder rootSpanDurationInMs(Integer rootSpanDurationInMs)

Time taken for the root span operation to complete in milliseconds.

Parameters:

rootSpanDurationInMs - the value to set

Returns:

this builder

traceDurationInMs

public TraceSpanSummary.Builder traceDurationInMs(Integer traceDurationInMs)

Time between the start of the earliest span and the end of the most recent span in milliseconds.

Parameters:

traceDurationInMs - the value to set

Returns:

this builder

isFault

public TraceSpanSummary.Builder isFault(Boolean isFault)

Boolean flag that indicates whether the trace has an error.

Parameters:

isFault - the value to set

Returns:

this builder

traceStatus

public TraceSpanSummary.Builder traceStatus(String traceStatus)

The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

Parameters:

traceStatus - the value to set

Returns:

this builder

traceErrorType

public TraceSpanSummary.Builder traceErrorType(String traceErrorType)

Error type of the trace.

Parameters:

traceErrorType - the value to set

Returns:

this builder

traceErrorCode

public TraceSpanSummary.Builder traceErrorCode(String traceErrorCode)

Error code of the trace.

Parameters:

traceErrorCode - the value to set

Returns:

this builder

serviceSummaries

public TraceSpanSummary.Builder serviceSummaries(List<TraceServiceSummary> serviceSummaries)

A summary of the spans by service.

Parameters:

serviceSummaries - the value to set

Returns:

this builder

build

public TraceSpanSummary build()

copy

public TraceSpanSummary.Builder copy(TraceSpanSummary model)