Interface GetSampledRequestsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>, SdkBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>, SdkPojo, SdkRequest.Builder, WafRequest.Builder
Enclosing class:
GetSampledRequestsRequest
public static interface GetSampledRequestsRequest.Builder extends WafRequest.Builder, SdkPojo, CopyableBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>

  • Method Details

    • webAclId

      GetSampledRequestsRequest.Builder webAclId(String webAclId)

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

      Parameters:
      webAclId - The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleId

      GetSampledRequestsRequest.Builder ruleId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • timeWindow

      GetSampledRequestsRequest.Builder timeWindow(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • timeWindow

      default GetSampledRequestsRequest.Builder timeWindow(Consumer<TimeWindow.Builder> 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.

      This is a convenience method that creates an instance of the TimeWindow.Builder avoiding the need to create one manually via TimeWindow.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeWindow(TimeWindow).

      Parameters:
      timeWindow - a consumer that will call methods on TimeWindow.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxItems

      GetSampledRequestsRequest.Builder maxItems(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.

      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 of MaxItems, 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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.