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

Class GetTraceSummariesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTraceSummariesRequest.Builder,GetTraceSummariesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetTraceSummariesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetTraceSummariesRequest.Builder	builder()
Instant	endTime()	The end of the time frame for which to retrieve traces.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterExpression()	Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	nextToken()	Specify the pagination token returned by a previous request to retrieve the next page of results.
Boolean	sampling()	Set to true to get summaries for only a subset of available traces.
SamplingStrategy	samplingStrategy()	A parameter to indicate whether to enable sampling on trace summaries.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetTraceSummariesRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The start of the time frame for which to retrieve traces.
TimeRangeType	timeRangeType()	Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).
String	timeRangeTypeAsString()	Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).
GetTraceSummariesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

startTime

public final Instant startTime()

The start of the time frame for which to retrieve traces.

Returns:

The start of the time frame for which to retrieve traces.

endTime

public final Instant endTime()

The end of the time frame for which to retrieve traces.

Returns:

The end of the time frame for which to retrieve traces.

timeRangeType

public final TimeRangeType timeRangeType()

Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).

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

Returns:

Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).

See Also:

TimeRangeType

timeRangeTypeAsString

public final String timeRangeTypeAsString()

Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).

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

Returns:

Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).

See Also:

TimeRangeType

sampling

public final Boolean sampling()

Set to true to get summaries for only a subset of available traces.

Returns:

Set to true to get summaries for only a subset of available traces.

samplingStrategy

public final SamplingStrategy samplingStrategy()

A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

Returns:

A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

filterExpression

public final String filterExpression()

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

Returns:

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

nextToken

public final String nextToken()

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

Returns:

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

toBuilder

public GetTraceSummariesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTraceSummariesRequest.Builder,GetTraceSummariesRequest>

Specified by:

toBuilder in class XRayRequest

builder

public static GetTraceSummariesRequest.Builder builder()

serializableBuilderClass

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