java.lang.Object
- software.amazon.awssdk.services.xray.model.Trace

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Trace.Builder,Trace>
```
@Generated("software.amazon.awssdk:codegen")
public final class Trace
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Trace.Builder,Trace>
```
A collection of segment documents with matching trace IDs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Trace.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Trace.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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSegments()`	For responses, this returns true if the service returned a value for the Segments property.
`String`	`id()`	The unique identifier for the request that generated the trace's segments and subsegments.
`Boolean`	`limitExceeded()`	LimitExceeded is set to true when the trace has exceeded the `Trace document size` limit.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<Segment>`	`segments()`	Segment documents for the segments and subsegments that comprise the trace.
`static Class<? extends Trace.Builder>`	`serializableBuilderClass()`
`Trace.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - id
```
public final 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 final 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.
  - limitExceeded
```
public final Boolean limitExceeded()
```
    LimitExceeded is set to true when the trace has exceeded the Trace document size limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.
    
    Returns:
    
    LimitExceeded is set to true when the trace has exceeded the Trace document size limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.
  - hasSegments
```
public final boolean hasSegments()
```
    For responses, this returns true if the service returned a value for the Segments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - segments
```
public final List<Segment> segments()
```
    Segment documents for the segments and subsegments that comprise the trace.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSegments() method.
    
    Returns:
    
    Segment documents for the segments and subsegments that comprise the trace.
  - toBuilder
```
public Trace.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Trace.Builder,Trace>
  - builder
```
public static Trace.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Trace.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Trace

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

duration

limitExceeded

hasSegments

segments

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField