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

Class ListRetrievedTracesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.xray.model.XRayResponse

software.amazon.awssdk.services.xray.model.ListRetrievedTracesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRetrievedTracesResponse.Builder,ListRetrievedTracesResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ListRetrievedTracesResponse
extends XRayResponse
implements ToCopyableBuilder<ListRetrievedTracesResponse.Builder,ListRetrievedTracesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListRetrievedTracesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ListRetrievedTracesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTraces()	For responses, this returns true if the service returned a value for the Traces property.
String	nextToken()	Specify the pagination token returned by a previous request to retrieve the next page of indexes.
RetrievalStatus	retrievalStatus()	Status of the retrieval.
String	retrievalStatusAsString()	Status of the retrieval.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListRetrievedTracesResponse.Builder>	serializableBuilderClass()
ListRetrievedTracesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TraceFormatType	traceFormat()	Format of the requested traces.
String	traceFormatAsString()	Format of the requested traces.
List<RetrievedTrace>	traces()	Full traces for the specified requests.

Methods inherited from class software.amazon.awssdk.services.xray.model.XRayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

retrievalStatus

public final RetrievalStatus retrievalStatus()

Status of the retrieval.

If the service returns an enum value that is not available in the current SDK version, retrievalStatus will return RetrievalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from retrievalStatusAsString().

Returns:

Status of the retrieval.

See Also:

RetrievalStatus

retrievalStatusAsString

public final String retrievalStatusAsString()

Status of the retrieval.

If the service returns an enum value that is not available in the current SDK version, retrievalStatus will return RetrievalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from retrievalStatusAsString().

Returns:

Status of the retrieval.

See Also:

RetrievalStatus

traceFormat

public final TraceFormatType traceFormat()

Format of the requested traces.

If the service returns an enum value that is not available in the current SDK version, traceFormat will return TraceFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceFormatAsString().

Returns:

Format of the requested traces.

See Also:

TraceFormatType

traceFormatAsString

public final String traceFormatAsString()

Format of the requested traces.

If the service returns an enum value that is not available in the current SDK version, traceFormat will return TraceFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceFormatAsString().

Returns:

Format of the requested traces.

See Also:

TraceFormatType

hasTraces

public final boolean hasTraces()

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

traces

public final List<RetrievedTrace> traces()

Full traces for the specified requests.

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

Returns:

Full traces for the specified requests.

nextToken

public final String nextToken()

Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Returns:

Specify the pagination token returned by a previous request to retrieve the next page of indexes.

toBuilder

public ListRetrievedTracesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRetrievedTracesResponse.Builder,ListRetrievedTracesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListRetrievedTracesResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

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