RequestInspection (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.wafv2.model.RequestInspection

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RequestInspection.Builder,RequestInspection>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RequestInspection.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RequestInspection.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RequestInspection.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`PasswordField`	`passwordField()` The name of the field in the request payload that contains your customer's password.
`PayloadType`	`payloadType()` The payload type for your login endpoint, either JSON or form encoded.
`String`	`payloadTypeAsString()` The payload type for your login endpoint, either JSON or form encoded.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RequestInspection.Builder>`	`serializableBuilderClass()`
`RequestInspection.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`UsernameField`	`usernameField()` The name of the field in the request payload that contains your customer's username.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    PayloadType
  - 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:
    
    PayloadType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RequestInspection.Builder,RequestInspection>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RequestInspection

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

payloadType

payloadTypeAsString

usernameField

passwordField

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields