Package software.amazon.awssdk.services.xray.model

Class RetrievedTrace

java.lang.Object

software.amazon.awssdk.services.xray.model.RetrievedTrace

All Implemented Interfaces:

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

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

Retrieved collection of spans with matching trace IDs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievedTrace.Builder

Method Summary

Modifier and Type	Method	Description
static RetrievedTrace.Builder	builder()
Double	duration()	The length of time in seconds between the start time of the root span and the end time of the last span that completed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSpans()	For responses, this returns true if the service returned a value for the Spans property.
String	id()	The unique identifier for the span.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RetrievedTrace.Builder>	serializableBuilderClass()
List<Span>	spans()	Spans that comprise the trace.
RetrievedTrace.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 span.

Returns:

The unique identifier for the span.

duration

public final Double duration()

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

Returns:

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

hasSpans

public final boolean hasSpans()

For responses, this returns true if the service returned a value for the Spans 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.

spans

public final List<Span> spans()

Spans 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 hasSpans() method.

Returns:

Spans that comprise the trace.

toBuilder

public RetrievedTrace.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrievedTrace.Builder,RetrievedTrace>

builder

public static RetrievedTrace.Builder builder()

serializableBuilderClass

public static Class<? extends RetrievedTrace.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