Interface GetTopPathStatisticsByTrafficRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetTopPathStatisticsByTrafficRequest.Builder,GetTopPathStatisticsByTrafficRequest>, SdkBuilder<GetTopPathStatisticsByTrafficRequest.Builder,GetTopPathStatisticsByTrafficRequest>, SdkPojo, SdkRequest.Builder, Wafv2Request.Builder
Enclosing class:
GetTopPathStatisticsByTrafficRequest
@Mutable @NotThreadSafe public static interface GetTopPathStatisticsByTrafficRequest.Builder extends Wafv2Request.Builder, SdkPojo, CopyableBuilder<GetTopPathStatisticsByTrafficRequest.Builder,GetTopPathStatisticsByTrafficRequest>

  • Method Details

    • webAclArn

      GetTopPathStatisticsByTrafficRequest.Builder webAclArn(String webAclArn)

      The Amazon Resource Name (ARN) of the web ACL for which you want to retrieve path statistics.

      Parameters:
      webAclArn - The Amazon Resource Name (ARN) of the web ACL for which you want to retrieve path statistics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      GetTopPathStatisticsByTrafficRequest.Builder scope(String scope)

      Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.

      Parameters:
      scope - Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scope

      GetTopPathStatisticsByTrafficRequest.Builder scope(Scope scope)

      Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.

      Parameters:
      scope - Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • uriPathPrefix

      GetTopPathStatisticsByTrafficRequest.Builder uriPathPrefix(String uriPathPrefix)

      A URI path prefix to filter the results. When you specify this parameter, the operation returns statistics for individual URIs within the specified path prefix. For example, if you specify /api, the response includes statistics for paths like /api/v1/users and /api/v2/orders. If you don't specify this parameter, the operation returns top-level path statistics.

      Parameters:
      uriPathPrefix - A URI path prefix to filter the results. When you specify this parameter, the operation returns statistics for individual URIs within the specified path prefix. For example, if you specify /api, the response includes statistics for paths like /api/v1/users and /api/v2/orders. If you don't specify this parameter, the operation returns top-level path statistics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeWindow

      GetTopPathStatisticsByTrafficRequest.Builder timeWindow(TimeWindow timeWindow)

      The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.

      Parameters:
      timeWindow - The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeWindow

      default GetTopPathStatisticsByTrafficRequest.Builder timeWindow(Consumer<TimeWindow.Builder> timeWindow)

      The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.

      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:

    • botCategory

      GetTopPathStatisticsByTrafficRequest.Builder botCategory(String botCategory)

      Filters the results to include only traffic from bots in the specified category. For example, you can filter by ai to see only AI crawler traffic, or search_engine to see only search engine bot traffic. When you apply this filter, the Source field is populated in the response.

      Parameters:
      botCategory - Filters the results to include only traffic from bots in the specified category. For example, you can filter by ai to see only AI crawler traffic, or search_engine to see only search engine bot traffic. When you apply this filter, the Source field is populated in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • botOrganization

      GetTopPathStatisticsByTrafficRequest.Builder botOrganization(String botOrganization)

      Filters the results to include only traffic from bots belonging to the specified organization. For example, you can filter by openai or google. When you apply this filter, the Source field is populated in the response.

      Parameters:
      botOrganization - Filters the results to include only traffic from bots belonging to the specified organization. For example, you can filter by openai or google. When you apply this filter, the Source field is populated in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • botName

      GetTopPathStatisticsByTrafficRequest.Builder botName(String botName)

      Filters the results to include only traffic from the specified bot. For example, you can filter by gptbot or googlebot. When you apply this filter, the Source field is populated in the response.

      Parameters:
      botName - Filters the results to include only traffic from the specified bot. For example, you can filter by gptbot or googlebot. When you apply this filter, the Source field is populated in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      GetTopPathStatisticsByTrafficRequest.Builder limit(Integer limit)

      The maximum number of path statistics to return. Valid values are 1 to 100.

      Parameters:
      limit - The maximum number of path statistics to return. Valid values are 1 to 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfTopTrafficBotsPerPath

      GetTopPathStatisticsByTrafficRequest.Builder numberOfTopTrafficBotsPerPath(Integer numberOfTopTrafficBotsPerPath)

      The maximum number of top bots to include in the statistics for each path. Valid values are 1 to 10.

      Parameters:
      numberOfTopTrafficBotsPerPath - The maximum number of top bots to include in the statistics for each path. Valid values are 1 to 10.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextMarker

      GetTopPathStatisticsByTrafficRequest.Builder nextMarker(String nextMarker)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

      Parameters:
      nextMarker - When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetTopPathStatisticsByTrafficRequest.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

      GetTopPathStatisticsByTrafficRequest.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.