Interface GetSampledRequestsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetSampledRequestsRequest.Builder,
,GetSampledRequestsRequest> SdkBuilder<GetSampledRequestsRequest.Builder,
,GetSampledRequestsRequest> SdkPojo
,SdkRequest.Builder
,WafRequest.Builder
- Enclosing class:
GetSampledRequestsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe 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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.RuleId
is one of three values:timeWindow
(Consumer<TimeWindow.Builder> 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.timeWindow
(TimeWindow 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.TheWebACLId
of theWebACL
for which you wantGetSampledRequests
to return a sample of requests.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.waf.model.WafRequest.Builder
build
-
Method Details
-
webAclId
The
WebACLId
of theWebACL
for which you wantGetSampledRequests
to return a sample of requests.- Parameters:
webAclId
- TheWebACLId
of theWebACL
for which you wantGetSampledRequests
to return a sample of requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.- Parameters:
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. 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:
- Returns a reference to this object so that method calls can be chained together.
-
timeWindow
The start date and time and the end date and time of the range for which you want
This is a convenience method that creates an instance of theGetSampledRequests
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.TimeWindow.Builder
avoiding the need to create one manually viaTimeWindow.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeWindow(TimeWindow)
.- Parameters:
timeWindow
- a consumer that will call methods onTimeWindow.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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 ofMaxItems
,GetSampledRequests
returns information about all of them.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetSampledRequestsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetSampledRequestsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-