Class GetSampledRequestsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetSampledRequestsRequest.Builder,
GetSampledRequestsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
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.final String
ruleId()
RuleId
is one of three values:static Class
<? extends GetSampledRequestsRequest.Builder> final TimeWindow
The start date and time and the end date and time of the range for which you wantGetSampledRequests
to return a sample of requests.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
webAclId()
TheWebACLId
of theWebACL
for which you wantGetSampledRequests
to return a sample of requests.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
webAclId
The
WebACLId
of theWebACL
for which you wantGetSampledRequests
to return a sample of requests.- Returns:
- The
WebACLId
of theWebACL
for which you wantGetSampledRequests
to return a sample of requests.
-
ruleId
RuleId
is one of three values:-
The
RuleId
of theRule
or theRuleGroupId
of theRuleGroup
for which you wantGetSampledRequests
to return a sample of requests. -
Default_Action
, which causesGetSampledRequests
to return a sample of the requests that didn't match any of the rules in the specifiedWebACL
.
- Returns:
RuleId
is one of three values:-
The
RuleId
of theRule
or theRuleGroupId
of theRuleGroup
for which you wantGetSampledRequests
to return a sample of requests. -
Default_Action
, which causesGetSampledRequests
to return a sample of the requests that didn't match any of the rules in the specifiedWebACL
.
-
-
-
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
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
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 interfaceToCopyableBuilder<GetSampledRequestsRequest.Builder,
GetSampledRequestsRequest> - Specified by:
toBuilder
in classWafRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-