software.amazon.awssdk.services.xray.model

Class TraceSummary

java.lang.Object

software.amazon.awssdk.services.xray.model.TraceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TraceSummary.Builder,TraceSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class TraceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TraceSummary.Builder,TraceSummary>

Metadata generated from the segment documents in a trace.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TraceSummary.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,List<ValueWithServiceIds>>	annotations() Annotations from the trace's segment documents.
List<AvailabilityZoneDetail>	availabilityZones() A list of availability zones for any zone corresponding to the trace segments.
static TraceSummary.Builder	builder()
Double	duration() The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
ServiceId	entryPoint() The root of a trace.
boolean	equals(Object obj)
List<ErrorRootCause>	errorRootCauses() A collection of ErrorRootCause structures corresponding to the trace segments.
List<FaultRootCause>	faultRootCauses() A collection of FaultRootCause structures corresponding to the the trace segments.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Boolean	hasError() One or more of the segment documents has a 400 series error.
Boolean	hasFault() One or more of the segment documents has a 500 series error.
int	hashCode()
Boolean	hasThrottle() One or more of the segment documents has a 429 throttling error.
Http	http() Information about the HTTP request served by the trace.
String	id() The unique identifier for the request that generated the trace's segments and subsegments.
List<InstanceIdDetail>	instanceIds() A list of EC2 instance IDs for any instance corresponding to the trace segments.
Boolean	isPartial() One or more of the segment documents is in progress.
List<ResourceARNDetail>	resourceARNs() A list of resource ARNs for any resource corresponding to the trace segments.
Double	responseTime() The length of time in seconds between the start and end times of the root segment.
List<ResponseTimeRootCause>	responseTimeRootCauses() A collection of ResponseTimeRootCause structures corresponding to the trace segments.
Integer	revision() The revision number of a trace.
List<SdkField<?>>	sdkFields()
static Class<? extends TraceSummary.Builder>	serializableBuilderClass()
List<ServiceId>	serviceIds() Service IDs from the trace's segment documents.
TraceSummary.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<TraceUser>	users() Users from the trace's segment documents.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public String id()

The unique identifier for the request that generated the trace's segments and subsegments.

Returns:

The unique identifier for the request that generated the trace's segments and subsegments.

duration

public Double duration()

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

Returns:

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

responseTime

public Double responseTime()

The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

Returns:

The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

hasFault

public Boolean hasFault()

One or more of the segment documents has a 500 series error.

Returns:

One or more of the segment documents has a 500 series error.

hasError

public Boolean hasError()

One or more of the segment documents has a 400 series error.

Returns:

One or more of the segment documents has a 400 series error.

hasThrottle

public Boolean hasThrottle()

One or more of the segment documents has a 429 throttling error.

Returns:

One or more of the segment documents has a 429 throttling error.

isPartial

public Boolean isPartial()

One or more of the segment documents is in progress.

Returns:

One or more of the segment documents is in progress.

http

public Http http()

Information about the HTTP request served by the trace.

Returns:

Information about the HTTP request served by the trace.

annotations

public Map<String,List<ValueWithServiceIds>> annotations()

Annotations from the trace's segment documents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Annotations from the trace's segment documents.

users

public List<TraceUser> users()

Users from the trace's segment documents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Users from the trace's segment documents.

serviceIds

public List<ServiceId> serviceIds()

Service IDs from the trace's segment documents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Service IDs from the trace's segment documents.

resourceARNs

public List<ResourceARNDetail> resourceARNs()

A list of resource ARNs for any resource corresponding to the trace segments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of resource ARNs for any resource corresponding to the trace segments.

instanceIds

public List<InstanceIdDetail> instanceIds()

A list of EC2 instance IDs for any instance corresponding to the trace segments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of EC2 instance IDs for any instance corresponding to the trace segments.

availabilityZones

public List<AvailabilityZoneDetail> availabilityZones()

A list of availability zones for any zone corresponding to the trace segments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of availability zones for any zone corresponding to the trace segments.

entryPoint

public ServiceId entryPoint()

The root of a trace.

Returns:

The root of a trace.

faultRootCauses

public List<FaultRootCause> faultRootCauses()

A collection of FaultRootCause structures corresponding to the the trace segments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A collection of FaultRootCause structures corresponding to the the trace segments.

errorRootCauses

public List<ErrorRootCause> errorRootCauses()

A collection of ErrorRootCause structures corresponding to the trace segments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A collection of ErrorRootCause structures corresponding to the trace segments.

responseTimeRootCauses

public List<ResponseTimeRootCause> responseTimeRootCauses()

A collection of ResponseTimeRootCause structures corresponding to the trace segments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A collection of ResponseTimeRootCause structures corresponding to the trace segments.

revision

public Integer revision()

The revision number of a trace.

Returns:

The revision number of a trace.

toBuilder

public TraceSummary.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TraceSummary.Builder,TraceSummary>

Returns:

a builder for type T

builder

public static TraceSummary.Builder builder()

serializableBuilderClass

public static Class<? extends TraceSummary.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.