Class GetRevenueStatisticsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.wafv2.model.Wafv2Request
software.amazon.awssdk.services.wafv2.model.GetRevenueStatisticsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRevenueStatisticsRequest.Builder,GetRevenueStatisticsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetRevenueStatisticsRequest extends Wafv2Request implements ToCopyableBuilder<GetRevenueStatisticsRequest.Builder,GetRevenueStatisticsRequest>

  • Method Details

    • statisticType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, statisticType will return RankingStatisticType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticTypeAsString().

      Returns:
      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.
      See Also:

    • statisticTypeAsString

      public final String statisticTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, statisticType will return RankingStatisticType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticTypeAsString().

      Returns:
      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.
      See Also:

    • timeWindow

      public final TimeWindow timeWindow()

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

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

    • scope

      public final Scope scope()

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

      If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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

    • scopeAsString

      public final String scopeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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

    • currency

      public final Currency currency()

      The currency for the revenue amounts in the response.

      If the service returns an enum value that is not available in the current SDK version, currency will return Currency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyAsString().

      Returns:
      The currency for the revenue amounts in the response.
      See Also:

    • currencyAsString

      public final String currencyAsString()

      The currency for the revenue amounts in the response.

      If the service returns an enum value that is not available in the current SDK version, currency will return Currency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyAsString().

      Returns:
      The currency for the revenue amounts in the response.
      See Also:

    • groupBy

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, groupBy will return GroupByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().

      Returns:
      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 .
      See Also:

    • groupByAsString

      public final String groupByAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, groupBy will return GroupByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().

      Returns:
      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 .
      See Also:

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filters

      public final List<MonetizationFilter> filters()

      Optional filters to narrow the results.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

      Returns:
      Optional filters to narrow the results.

    • nextMarker

      public final 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.

      Returns:
      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.

    • limit

      public final Integer limit()

      The maximum number of results to return.

      Returns:
      The maximum number of results to return.

    • sortBy

      public final RankingSortBy sortBy()

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

      If the service returns an enum value that is not available in the current SDK version, sortBy will return RankingSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

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

    • sortByAsString

      public final String sortByAsString()

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

      If the service returns an enum value that is not available in the current SDK version, sortBy will return RankingSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

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

    • sortOrder

      public final SortOrder sortOrder()

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

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      The sort order: ASC for ascending or DESC for descending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

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

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      The sort order: ASC for ascending or DESC for descending.
      See Also:

    • toBuilder

      public GetRevenueStatisticsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetRevenueStatisticsRequest.Builder,GetRevenueStatisticsRequest>
      Specified by:
      toBuilder in class Wafv2Request
      Returns:
      a builder for type T

    • builder

      public static GetRevenueStatisticsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetRevenueStatisticsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.