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

Class GetInsightSummariesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetInsightSummariesRequest.Builder,GetInsightSummariesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetInsightSummariesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetInsightSummariesRequest.Builder	builder()
Instant	endTime()	The end of the time frame in which the insights ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupARN()	The Amazon Resource Name (ARN) of the group.
String	groupName()	The name of the group.
int	hashCode()
boolean	hasStates()	For responses, this returns true if the service returned a value for the States property.
Integer	maxResults()	The maximum number of results to display.
String	nextToken()	Pagination token.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetInsightSummariesRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The beginning of the time frame in which the insights started.
List<InsightState>	states()	The list of insight states.
List<String>	statesAsStrings()	The list of insight states.
GetInsightSummariesRequest.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

states

public final List<InsightState> states()

The list of insight states.

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

Returns:

The list of insight states.

hasStates

public final boolean hasStates()

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

statesAsStrings

public final List<String> statesAsStrings()

The list of insight states.

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

Returns:

The list of insight states.

groupARN

public final String groupARN()

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

Returns:

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

groupName

public final String groupName()

The name of the group. Required if the GroupARN isn't provided.

Returns:

The name of the group. Required if the GroupARN isn't provided.

startTime

public final Instant startTime()

The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

Returns:

The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

endTime

public final Instant endTime()

The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

Returns:

The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

maxResults

public final Integer maxResults()

The maximum number of results to display.

Returns:

The maximum number of results to display.

nextToken

public final String nextToken()

Pagination token.

Returns:

Pagination token.

toBuilder

public GetInsightSummariesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetInsightSummariesRequest.Builder,GetInsightSummariesRequest>

Specified by:

toBuilder in class XRayRequest

builder

public static GetInsightSummariesRequest.Builder builder()

serializableBuilderClass

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