software.amazon.awssdk.services.waf.model

Class GetSampledRequestsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.waf.model.WafRequest

software.amazon.awssdk.services.waf.model.GetSampledRequestsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSampledRequestsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetSampledRequestsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Long	maxItems() The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range.
String	ruleId() RuleId is one of three values:
List<SdkField<?>>	sdkFields()
static Class<? extends GetSampledRequestsRequest.Builder>	serializableBuilderClass()
TimeWindow	timeWindow() The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests.
GetSampledRequestsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	webAclId() The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

webAclId

public final String webAclId()

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

Returns:

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

ruleId

public final String ruleId()

RuleId is one of three values:

• The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

• Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

Returns:

RuleId is one of three values:

• The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

• Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

timeWindow

public final TimeWindow timeWindow()

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Returns:

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

maxItems

public final Long maxItems()

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

Returns:

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

toBuilder

public GetSampledRequestsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>

Specified by:

toBuilder in class WafRequest

Returns:

a builder for type T

builder

public static GetSampledRequestsRequest.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.