Package software.amazon.awssdk.services.wafv2.model

Class GetSampledRequestsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.wafv2.model.Wafv2Response

software.amazon.awssdk.services.wafv2.model.GetSampledRequestsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSampledRequestsResponse.Builder,GetSampledRequestsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSampledRequestsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetSampledRequestsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSampledRequests()	For responses, this returns true if the service returned a value for the SampledRequests property.
Long	populationSize()	The total number of requests from which GetSampledRequests got a sample of MaxItems requests.
List<SampledHTTPRequest>	sampledRequests()	A complex type that contains detailed information about each of the requests in the sample.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSampledRequestsResponse.Builder>	serializableBuilderClass()
TimeWindow	timeWindow()	Usually, TimeWindow is the time range that you specified in the GetSampledRequests request.
GetSampledRequestsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.wafv2.model.Wafv2Response

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

hasSampledRequests

public final boolean hasSampledRequests()

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

sampledRequests

public final List<SampledHTTPRequest> sampledRequests()

A complex type that contains detailed information about each of the requests in the sample.

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

Returns:

A complex type that contains detailed information about each of the requests in the sample.

populationSize

public final Long populationSize()

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.

Returns:

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.

timeWindow

public final TimeWindow timeWindow()

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

Returns:

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

toBuilder

public GetSampledRequestsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSampledRequestsResponse.Builder,GetSampledRequestsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetSampledRequestsResponse.Builder builder()

serializableBuilderClass

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