Class SampledHTTPRequest

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.

See Also:

  • Method Details

    • request

      public final HTTPRequest request()

      A complex type that contains detailed information about the request.

      Returns:
      A complex type that contains detailed information about the request.

    • weight

      public final Long weight()

      A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

      Returns:
      A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

    • timestamp

      public final Instant timestamp()

      The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

      Returns:
      The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    • action

      public final String action()

      The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

      Returns:
      The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

    • ruleWithinRuleGroup

      public final String ruleWithinRuleGroup()

      This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

      Returns:
      This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

    • toBuilder

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

    • builder

      public static SampledHTTPRequest.Builder builder()

    • serializableBuilderClass

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