RequestInspection (AWS Java SDK for AWS WAFV2 1.12.433 API)

java.lang.Object
- com.amazonaws.services.wafv2.model.RequestInspection

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RequestInspection
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RequestInspection()

Constructors
Constructor and Description
`RequestInspection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestInspection`	`clone()`
`boolean`	`equals(Object obj)`
`PasswordField`	`getPasswordField()` Details about your login page password field.
`String`	`getPayloadType()` The payload type for your login endpoint, either JSON or form encoded.
`UsernameField`	`getUsernameField()` Details about your login page username field.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setPasswordField(PasswordField passwordField)` Details about your login page password field.
`void`	`setPayloadType(String payloadType)` The payload type for your login endpoint, either JSON or form encoded.
`void`	`setUsernameField(UsernameField usernameField)` Details about your login page username field.
`String`	`toString()` Returns a string representation of this object.
`RequestInspection`	`withPasswordField(PasswordField passwordField)` Details about your login page password field.
`RequestInspection`	`withPayloadType(PayloadType payloadType)` The payload type for your login endpoint, either JSON or form encoded.
`RequestInspection`	`withPayloadType(String payloadType)` The payload type for your login endpoint, either JSON or form encoded.
`RequestInspection`	`withUsernameField(UsernameField usernameField)` Details about your login page username field.

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

- Constructor Detail
  - RequestInspection
```
public RequestInspection()
```
- Method Detail
  - setPayloadType
```
public void setPayloadType(String payloadType)
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Parameters:
    
    payloadType - The payload type for your login endpoint, either JSON or form encoded.
    
    See Also:
    
    PayloadType
  - getPayloadType
```
public String getPayloadType()
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Returns:
    
    The payload type for your login endpoint, either JSON or form encoded.
    
    See Also:
    
    PayloadType
  - withPayloadType
```
public RequestInspection withPayloadType(String payloadType)
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Parameters:
    
    payloadType - The payload type for your login endpoint, either JSON or form encoded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PayloadType
  - withPayloadType
```
public RequestInspection withPayloadType(PayloadType payloadType)
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Parameters:
    
    payloadType - The payload type for your login endpoint, either JSON or form encoded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PayloadType
  - setUsernameField
```
public void setUsernameField(UsernameField usernameField)
```
    Details about your login page username field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    - For form encoded payload types, use the HTML form names.
      
      For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Parameters:
    usernameField - Details about your login page username field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    
    For form encoded payload types, use the HTML form names.
    
    For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
  - getUsernameField
```
public UsernameField getUsernameField()
```
    Details about your login page username field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    - For form encoded payload types, use the HTML form names.
      
      For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Returns:
    Details about your login page username field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    
    For form encoded payload types, use the HTML form names.
    
    For example, for an HTML form with input elements named username1 and password1 , the username field specification is username1 and the password field specification is password1.
  - withUsernameField
```
public RequestInspection withUsernameField(UsernameField usernameField)
```
    Details about your login page username field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    - For form encoded payload types, use the HTML form names.
      
      For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Parameters:
    usernameField - Details about your login page username field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    
    For form encoded payload types, use the HTML form names.
    
    For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPasswordField
```
public void setPasswordField(PasswordField passwordField)
```
    Details about your login page password field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    - For form encoded payload types, use the HTML form names.
      
      For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Parameters:
    passwordField - Details about your login page password field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    
    For form encoded payload types, use the HTML form names.
    
    For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
  - getPasswordField
```
public PasswordField getPasswordField()
```
    Details about your login page password field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    - For form encoded payload types, use the HTML form names.
      
      For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Returns:
    Details about your login page password field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    
    For form encoded payload types, use the HTML form names.
    
    For example, for an HTML form with input elements named username1 and password1 , the username field specification is username1 and the password field specification is password1.
  - withPasswordField
```
public RequestInspection withPasswordField(PasswordField passwordField)
```
    Details about your login page password field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    - For form encoded payload types, use the HTML form names.
      
      For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Parameters:
    passwordField - Details about your login page password field.
    
    How you specify this depends on the 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 { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the username field specification is /login/username and the password field specification is /login/password.
    
    For form encoded payload types, use the HTML form names.
    
    For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RequestInspection clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class RequestInspection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestInspection

Method Detail

setPayloadType

getPayloadType

withPayloadType

withPayloadType

setUsernameField

getUsernameField

withUsernameField

setPasswordField

getPasswordField

withPasswordField

toString

equals

hashCode

clone

marshall