Package software.amazon.awssdk.services.wafv2.model

Class GetTopPathStatisticsByTrafficResponse

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

  • Method Details

    • hasPathStatistics

      public final boolean hasPathStatistics()
      For responses, this returns true if the service returned a value for the PathStatistics 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.

    • pathStatistics

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

      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 hasPathStatistics() method.

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

    • totalRequestCount

      public final Long totalRequestCount()

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

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

    • nextMarker

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

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

    • hasTopCategories

      public final boolean hasTopCategories()
      For responses, this returns true if the service returned a value for the TopCategories 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.

    • topCategories

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

      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 hasTopCategories() method.

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

    • toBuilder

      public GetTopPathStatisticsByTrafficResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetTopPathStatisticsByTrafficResponse.Builder,GetTopPathStatisticsByTrafficResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetTopPathStatisticsByTrafficResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo