Package com.oracle.bmc.apmtraces.model

Class TraceSpanSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public final class TraceSpanSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Summary of the information pertaining to the spans in the trace window that is being queried.
    Note: Objects should always be created or deserialized using the TraceSpanSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the TraceSpanSummary.Builder, which maintain a set of all explicitly set fields called TraceSpanSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Constructor Detail

      • TraceSpanSummary

        @Deprecated
@ConstructorProperties({"key","rootSpanOperationName","timeEarliestSpanStarted","timeLatestSpanEnded","spanCount","errorSpanCount","rootSpanServiceName","timeRootSpanStarted","timeRootSpanEnded","rootSpanDurationInMs","traceDurationInMs","isFault","traceStatus","traceErrorType","traceErrorCode","serviceSummaries"})
public TraceSpanSummary​(String key,
                        String rootSpanOperationName,
                        Date timeEarliestSpanStarted,
                        Date timeLatestSpanEnded,
                        Integer spanCount,
                        Integer errorSpanCount,
                        String rootSpanServiceName,
                        Date timeRootSpanStarted,
                        Date timeRootSpanEnded,
                        Integer rootSpanDurationInMs,
                        Integer traceDurationInMs,
                        Boolean isFault,
                        String traceStatus,
                        String traceErrorType,
                        String traceErrorCode,
                        List<TraceServiceSummary> serviceSummaries)
        Deprecated.

    • Method Detail

      • getKey

        public String getKey()
        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.

        Returns:
        the value

      • getRootSpanOperationName

        public String getRootSpanOperationName()
        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.

        Returns:
        the value

      • getTimeEarliestSpanStarted

        public Date getTimeEarliestSpanStarted()
        Start time of the earliest span in the span collection.
        Returns:
        the value

      • getTimeLatestSpanEnded

        public Date getTimeLatestSpanEnded()
        End time of the span that most recently ended in the span collection.
        Returns:
        the value

      • getSpanCount

        public Integer getSpanCount()
        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.

        Returns:
        the value

      • getErrorSpanCount

        public Integer getErrorSpanCount()
        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.

        Returns:
        the value

      • getRootSpanServiceName

        public String getRootSpanServiceName()
        Service associated with the trace.
        Returns:
        the value

      • getTimeRootSpanStarted

        public Date getTimeRootSpanStarted()
        Start time of the root span for the span collection.
        Returns:
        the value

      • getTimeRootSpanEnded

        public Date getTimeRootSpanEnded()
        End time of the root span for the span collection.
        Returns:
        the value

      • getRootSpanDurationInMs

        public Integer getRootSpanDurationInMs()
        Time taken for the root span operation to complete in milliseconds.
        Returns:
        the value

      • getTraceDurationInMs

        public Integer getTraceDurationInMs()
        Time between the start of the earliest span and the end of the most recent span in milliseconds.
        Returns:
        the value

      • getIsFault

        public Boolean getIsFault()
        Boolean flag that indicates whether the trace has an error.
        Returns:
        the value

      • getTraceStatus

        public String getTraceStatus()
        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.

        Returns:
        the value

      • getTraceErrorType

        public String getTraceErrorType()
        Error type of the trace.
        Returns:
        the value

      • getTraceErrorCode

        public String getTraceErrorCode()
        Error code of the trace.
        Returns:
        the value

      • getServiceSummaries

        public List<TraceServiceSummary> getServiceSummaries()
        A summary of the spans by service.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel