Interface GetTopPathStatisticsByTrafficResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetTopPathStatisticsByTrafficResponse.Builder,GetTopPathStatisticsByTrafficResponse>, SdkBuilder<GetTopPathStatisticsByTrafficResponse.Builder,GetTopPathStatisticsByTrafficResponse>, SdkPojo, SdkResponse.Builder, Wafv2Response.Builder
Enclosing class:
GetTopPathStatisticsByTrafficResponse
@Mutable @NotThreadSafe public static interface GetTopPathStatisticsByTrafficResponse.Builder extends Wafv2Response.Builder, SdkPojo, CopyableBuilder<GetTopPathStatisticsByTrafficResponse.Builder,GetTopPathStatisticsByTrafficResponse>

  • Method Details

    • pathStatistics

      GetTopPathStatisticsByTrafficResponse.Builder pathStatistics(Collection<PathStatistics> pathStatistics)

      The list of path statistics, ordered by request count. Each entry includes the path, request count, percentage of total traffic, and the top bots accessing that path.

      Parameters:
      pathStatistics - The list of path statistics, ordered by request count. Each entry includes the path, request count, percentage of total traffic, and the top bots accessing that path.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pathStatistics

      GetTopPathStatisticsByTrafficResponse.Builder pathStatistics(PathStatistics... pathStatistics)

      The list of path statistics, ordered by request count. Each entry includes the path, request count, percentage of total traffic, and the top bots accessing that path.

      Parameters:
      pathStatistics - The list of path statistics, ordered by request count. Each entry includes the path, request count, percentage of total traffic, and the top bots accessing that path.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pathStatistics

      GetTopPathStatisticsByTrafficResponse.Builder pathStatistics(Consumer<PathStatistics.Builder>... pathStatistics)

      The list of path statistics, ordered by request count. Each entry includes the path, request count, percentage of total traffic, and the top bots accessing that path.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pathStatistics(List<PathStatistics>).

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

    • totalRequestCount

      GetTopPathStatisticsByTrafficResponse.Builder totalRequestCount(Long totalRequestCount)

      The total number of requests that match the query criteria within the specified time window.

      Parameters:
      totalRequestCount - The total number of requests that match the query criteria within the specified time window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextMarker

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

    • topCategories

      GetTopPathStatisticsByTrafficResponse.Builder topCategories(Collection<PathStatistics> topCategories)

      Category-level aggregations for visualizing bot category to path relationships. This field is only populated when no bot filters are applied to the request. Each entry includes the bot category and the paths accessed by bots in that category.

      Parameters:
      topCategories - Category-level aggregations for visualizing bot category to path relationships. This field is only populated when no bot filters are applied to the request. Each entry includes the bot category and the paths accessed by bots in that category.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topCategories

      GetTopPathStatisticsByTrafficResponse.Builder topCategories(PathStatistics... topCategories)

      Category-level aggregations for visualizing bot category to path relationships. This field is only populated when no bot filters are applied to the request. Each entry includes the bot category and the paths accessed by bots in that category.

      Parameters:
      topCategories - Category-level aggregations for visualizing bot category to path relationships. This field is only populated when no bot filters are applied to the request. Each entry includes the bot category and the paths accessed by bots in that category.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topCategories

      GetTopPathStatisticsByTrafficResponse.Builder topCategories(Consumer<PathStatistics.Builder>... topCategories)

      Category-level aggregations for visualizing bot category to path relationships. This field is only populated when no bot filters are applied to the request. Each entry includes the bot category and the paths accessed by bots in that category.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to topCategories(List<PathStatistics>).

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