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

Class StartTraceRetrievalRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.xray.model.XRayRequest

software.amazon.awssdk.services.xray.model.StartTraceRetrievalRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartTraceRetrievalRequest.Builder,StartTraceRetrievalRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartTraceRetrievalRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartTraceRetrievalRequest.Builder	builder()
Instant	endTime()	The end of the time range to retrieve traces.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTraceIds()	For responses, this returns true if the service returned a value for the TraceIds property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartTraceRetrievalRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The start of the time range to retrieve traces.
StartTraceRetrievalRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	traceIds()	Specify the trace IDs of the traces to be retrieved.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hasTraceIds

public final boolean hasTraceIds()

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

traceIds

public final List<String> traceIds()

Specify the trace IDs of the traces to be retrieved.

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

Returns:

Specify the trace IDs of the traces to be retrieved.

startTime

public final Instant startTime()

The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

endTime

public final Instant endTime()

The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

toBuilder

public StartTraceRetrievalRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartTraceRetrievalRequest.Builder,StartTraceRetrievalRequest>

Specified by:

toBuilder in class XRayRequest

builder

public static StartTraceRetrievalRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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