Class RequestInspection

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

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.

See Also:

  • Method Details

    • payloadType

      public final PayloadType payloadType()

      The payload type for your login endpoint, either JSON or form encoded.

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

      Returns:
      The payload type for your login endpoint, either JSON or form encoded.
      See Also:

    • payloadTypeAsString

      public final String payloadTypeAsString()

      The payload type for your login endpoint, either JSON or form encoded.

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

      Returns:
      The payload type for your login endpoint, either JSON or form encoded.
      See Also:

    • usernameField

      public final UsernameField usernameField()

      The name of the field in the request payload that contains your customer's username.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named username1, the username field specification is username1

      Returns:
      The name of the field in the request payload that contains your customer's username.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named username1, the username field specification is username1

    • passwordField

      public final PasswordField passwordField()

      The name of the field in the request payload that contains your customer's password.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named password1, the password field specification is password1.

      Returns:
      The name of the field in the request payload that contains your customer's password.

      How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

      • For form encoded payload types, use the HTML form names.

        For example, for an HTML form with the input element named password1, the password field specification is password1.

    • toBuilder

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

    • builder

      public static RequestInspection.Builder builder()

    • serializableBuilderClass

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