software.amazon.awssdk.services.xray.model

Class GetTraceSummariesResponse

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.GetTraceSummariesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTraceSummariesResponse.Builder,GetTraceSummariesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetTraceSummariesResponse.Builder

Method Summary

Modifier and Type	Method and Description
Instant	approximateTime() The start time of this page of results.
static GetTraceSummariesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTraceSummaries() For responses, this returns true if the service returned a value for the TraceSummaries property.
String	nextToken() If the requested time frame contained more than one page of results, you can use this token to retrieve the next page.
List<SdkField<?>>	sdkFields()
static Class<? extends GetTraceSummariesResponse.Builder>	serializableBuilderClass()
GetTraceSummariesResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Long	tracesProcessedCount() The total number of traces processed, including traces that did not match the specified filter expression.
List<TraceSummary>	traceSummaries() Trace IDs and annotations for traces that were found in the specified time frame.

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

hasTraceSummaries

public final boolean hasTraceSummaries()

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

traceSummaries

public final List<TraceSummary> traceSummaries()

Trace IDs and annotations for traces that were found in the specified time frame.

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

Returns:

Trace IDs and annotations for traces that were found in the specified time frame.

approximateTime

public final Instant approximateTime()

The start time of this page of results.

Returns:

The start time of this page of results.

tracesProcessedCount

public final Long tracesProcessedCount()

The total number of traces processed, including traces that did not match the specified filter expression.

Returns:

The total number of traces processed, including traces that did not match the specified filter expression.

nextToken

public final String nextToken()

If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.

Returns:

If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.

toBuilder

public GetTraceSummariesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTraceSummariesResponse.Builder,GetTraceSummariesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetTraceSummariesResponse.Builder builder()

serializableBuilderClass

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