Class GetTopPathStatisticsByTrafficRequest

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.GetTopPathStatisticsByTrafficRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTopPathStatisticsByTrafficRequest.Builder,GetTopPathStatisticsByTrafficRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetTopPathStatisticsByTrafficRequest extends Wafv2Request implements ToCopyableBuilder<GetTopPathStatisticsByTrafficRequest.Builder,GetTopPathStatisticsByTrafficRequest>

  • Method Details

    • webAclArn

      public final String webAclArn()

      The Amazon Resource Name (ARN) of the web ACL for which you want to retrieve path statistics.

      Returns:
      The Amazon Resource Name (ARN) of the web ACL for which you want to retrieve path statistics.

    • scope

      public final Scope scope()

      Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.

      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 the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.
      See Also:

    • scopeAsString

      public final String scopeAsString()

      Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.

      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 the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.
      See Also:

    • uriPathPrefix

      public final String uriPathPrefix()

      A URI path prefix to filter the results. When you specify this parameter, the operation returns statistics for individual URIs within the specified path prefix. For example, if you specify /api, the response includes statistics for paths like /api/v1/users and /api/v2/orders. If you don't specify this parameter, the operation returns top-level path statistics.

      Returns:
      A URI path prefix to filter the results. When you specify this parameter, the operation returns statistics for individual URIs within the specified path prefix. For example, if you specify /api, the response includes statistics for paths like /api/v1/users and /api/v2/orders. If you don't specify this parameter, the operation returns top-level path statistics.

    • timeWindow

      public final TimeWindow timeWindow()

      The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.

      Returns:
      The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.

    • botCategory

      public final String botCategory()

      Filters the results to include only traffic from bots in the specified category. For example, you can filter by ai to see only AI crawler traffic, or search_engine to see only search engine bot traffic. When you apply this filter, the Source field is populated in the response.

      Returns:
      Filters the results to include only traffic from bots in the specified category. For example, you can filter by ai to see only AI crawler traffic, or search_engine to see only search engine bot traffic. When you apply this filter, the Source field is populated in the response.

    • botOrganization

      public final String botOrganization()

      Filters the results to include only traffic from bots belonging to the specified organization. For example, you can filter by openai or google. When you apply this filter, the Source field is populated in the response.

      Returns:
      Filters the results to include only traffic from bots belonging to the specified organization. For example, you can filter by openai or google. When you apply this filter, the Source field is populated in the response.

    • botName

      public final String botName()

      Filters the results to include only traffic from the specified bot. For example, you can filter by gptbot or googlebot. When you apply this filter, the Source field is populated in the response.

      Returns:
      Filters the results to include only traffic from the specified bot. For example, you can filter by gptbot or googlebot. When you apply this filter, the Source field is populated in the response.

    • limit

      public final Integer limit()

      The maximum number of path statistics to return. Valid values are 1 to 100.

      Returns:
      The maximum number of path statistics to return. Valid values are 1 to 100.

    • numberOfTopTrafficBotsPerPath

      public final Integer numberOfTopTrafficBotsPerPath()

      The maximum number of top bots to include in the statistics for each path. Valid values are 1 to 10.

      Returns:
      The maximum number of top bots to include in the statistics for each path. Valid values are 1 to 10.

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

    • toBuilder

      public GetTopPathStatisticsByTrafficRequest.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<GetTopPathStatisticsByTrafficRequest.Builder,GetTopPathStatisticsByTrafficRequest>
      Specified by:
      toBuilder in class Wafv2Request
      Returns:
      a builder for type T

    • builder

      public static GetTopPathStatisticsByTrafficRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTopPathStatisticsByTrafficRequest.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.