Interface GetRevenueStatisticsRequest.Builder

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

  • Method Details

    • statisticType

      GetRevenueStatisticsRequest.Builder statisticType(String statisticType)

      TOP_SOURCES_BY_REVENUE ranks revenue from AI bot traffic, grouped by the dimension you specify in the GroupBy parameter (NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL); GroupBy is required for this statistic type. TOP_PATHS_BY_REVENUE ranks revenue by path.

      Parameters:
      statisticType - TOP_SOURCES_BY_REVENUE ranks revenue from AI bot traffic, grouped by the dimension you specify in the GroupBy parameter (NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL); GroupBy is required for this statistic type. TOP_PATHS_BY_REVENUE ranks revenue by path.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statisticType

      GetRevenueStatisticsRequest.Builder statisticType(RankingStatisticType statisticType)

      TOP_SOURCES_BY_REVENUE ranks revenue from AI bot traffic, grouped by the dimension you specify in the GroupBy parameter (NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL); GroupBy is required for this statistic type. TOP_PATHS_BY_REVENUE ranks revenue by path.

      Parameters:
      statisticType - TOP_SOURCES_BY_REVENUE ranks revenue from AI bot traffic, grouped by the dimension you specify in the GroupBy parameter (NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL); GroupBy is required for this statistic type. TOP_PATHS_BY_REVENUE ranks revenue by path.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeWindow

      GetRevenueStatisticsRequest.Builder timeWindow(TimeWindow timeWindow)

      The time range for the query. Specify start and end timestamps.

      Parameters:
      timeWindow - The time range for the query. Specify start and end timestamps.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeWindow

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

      The time range for the query. Specify start and end timestamps.

      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:

    • scope

      GetRevenueStatisticsRequest.Builder scope(String scope)

      Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

      Parameters:
      scope - Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scope

      GetRevenueStatisticsRequest.Builder scope(Scope scope)

      Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

      Parameters:
      scope - Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • currency

      GetRevenueStatisticsRequest.Builder currency(String currency)

      The currency for the revenue amounts in the response.

      Parameters:
      currency - The currency for the revenue amounts in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • currency

      GetRevenueStatisticsRequest.Builder currency(Currency currency)

      The currency for the revenue amounts in the response.

      Parameters:
      currency - The currency for the revenue amounts in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupBy

      GetRevenueStatisticsRequest.Builder groupBy(String groupBy)

      The dimension to group results by: NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL. Required when StatisticType is TOP_SOURCES_BY_REVENUE. Not required for TOP_PATHS_BY_REVENUE, where results are grouped by content path. If StatisticType is TOP_SOURCES_BY_REVENUE and GroupBy is omitted, the request is rejected with a WAFInvalidParameterException.

      Parameters:
      groupBy - The dimension to group results by: NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL. Required when StatisticType is TOP_SOURCES_BY_REVENUE. Not required for TOP_PATHS_BY_REVENUE, where results are grouped by content path. If StatisticType is TOP_SOURCES_BY_REVENUE and GroupBy is omitted, the request is rejected with a WAFInvalidParameterException.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupBy

      GetRevenueStatisticsRequest.Builder groupBy(GroupByType groupBy)

      The dimension to group results by: NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL. Required when StatisticType is TOP_SOURCES_BY_REVENUE. Not required for TOP_PATHS_BY_REVENUE, where results are grouped by content path. If StatisticType is TOP_SOURCES_BY_REVENUE and GroupBy is omitted, the request is rejected with a WAFInvalidParameterException.

      Parameters:
      groupBy - The dimension to group results by: NAME, CATEGORY, INTENT, ORGANIZATION, or WEBACL. Required when StatisticType is TOP_SOURCES_BY_REVENUE. Not required for TOP_PATHS_BY_REVENUE, where results are grouped by content path. If StatisticType is TOP_SOURCES_BY_REVENUE and GroupBy is omitted, the request is rejected with a WAFInvalidParameterException.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filters

      GetRevenueStatisticsRequest.Builder filters(Collection<MonetizationFilter> filters)

      Optional filters to narrow the results.

      Parameters:
      filters - Optional filters to narrow the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      GetRevenueStatisticsRequest.Builder filters(MonetizationFilter... filters)

      Optional filters to narrow the results.

      Parameters:
      filters - Optional filters to narrow the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      GetRevenueStatisticsRequest.Builder filters(Consumer<MonetizationFilter.Builder>... filters)

      Optional filters to narrow the results.

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

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

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

    • nextMarker

      GetRevenueStatisticsRequest.Builder nextMarker(String nextMarker)

      When you get a paginated response, this marker indicates that additional results are available. Use it in a subsequent request to retrieve the next page of results.

      Parameters:
      nextMarker - When you get a paginated response, this marker indicates that additional results are available. Use it in a subsequent request to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      GetRevenueStatisticsRequest.Builder limit(Integer limit)

      The maximum number of results to return.

      Parameters:
      limit - The maximum number of results to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      GetRevenueStatisticsRequest.Builder sortBy(String sortBy)

      The field to sort results by: REVENUE, PERCENTAGE, or NAME.

      Parameters:
      sortBy - The field to sort results by: REVENUE, PERCENTAGE, or NAME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      GetRevenueStatisticsRequest.Builder sortBy(RankingSortBy sortBy)

      The field to sort results by: REVENUE, PERCENTAGE, or NAME.

      Parameters:
      sortBy - The field to sort results by: REVENUE, PERCENTAGE, or NAME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      GetRevenueStatisticsRequest.Builder sortOrder(String sortOrder)

      The sort order: ASC for ascending or DESC for descending.

      Parameters:
      sortOrder - The sort order: ASC for ascending or DESC for descending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      GetRevenueStatisticsRequest.Builder sortOrder(SortOrder sortOrder)

      The sort order: ASC for ascending or DESC for descending.

      Parameters:
      sortOrder - The sort order: ASC for ascending or DESC for descending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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