Class PathStatistics

java.lang.Object
software.amazon.awssdk.services.wafv2.model.PathStatistics
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PathStatistics.Builder,PathStatistics>
@Generated("software.amazon.awssdk:codegen") public final class PathStatistics extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PathStatistics.Builder,PathStatistics>

Statistics about bot traffic to a specific URI path, including the path, request count, percentage of total traffic, and the top bots accessing that path.

See Also:

  • Method Details

    • source

      public final FilterSource source()

      Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.

      Returns:
      Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.

    • path

      public final String path()

      The URI path. For example, /api/ or /api/v1/users.

      Returns:
      The URI path. For example, /api/ or /api/v1/users.

    • requestCount

      public final Long requestCount()

      The number of requests to this path within the specified time window.

      Returns:
      The number of requests to this path within the specified time window.

    • percentage

      public final Double percentage()

      The percentage of total requests that were made to this path.

      Returns:
      The percentage of total requests that were made to this path.

    • hasTopBots

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

    • topBots

      public final List<BotStatistics> topBots()

      The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.

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

      Returns:
      The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.

    • toBuilder

      public PathStatistics.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<PathStatistics.Builder,PathStatistics>
      Returns:
      a builder for type T

    • builder

      public static PathStatistics.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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