UsernameField (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UsernameField
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The name of the field in the request payload that contains your customer's username.

This data type is used in the RequestInspection and RequestInspectionACFP data types.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UsernameField()

Constructors
Constructor and Description
`UsernameField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UsernameField`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getIdentifier()` The name of the username field.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIdentifier(String identifier)` The name of the username field.
`String`	`toString()` Returns a string representation of this object.
`UsernameField`	`withIdentifier(String identifier)` The name of the username field.

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

- Constructor Detail
  - UsernameField
```
public UsernameField()
```
- Method Detail
  - setIdentifier
```
public void setIdentifier(String identifier)
```
    The name of the username field.
    
    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
    Parameters:
    identifier - The name of the username field.
    
    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
  - getIdentifier
```
public String getIdentifier()
```
    The name of the username field.
    
    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 username field.
    
    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
  - withIdentifier
```
public UsernameField withIdentifier(String identifier)
```
    The name of the username field.
    
    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
    Parameters:
    identifier - The name of the username field.
    
    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:
    
    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 UsernameField clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.604

Class UsernameField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UsernameField

Method Detail

setIdentifier

getIdentifier

withIdentifier

toString

equals

hashCode

clone

marshall