Package software.amazon.awssdk.services.wafv2.model

Class UsernameField

java.lang.Object

software.amazon.awssdk.services.wafv2.model.UsernameField

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UsernameField.Builder,UsernameField>

@Generated("software.amazon.awssdk:codegen")
public final class UsernameField
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UsernameField.Builder,UsernameField>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsernameField.Builder

Method Summary

Modifier and Type	Method	Description
static UsernameField.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identifier()	The name of the username field.
List<SdkField<?>>	sdkFields()
static Class<? extends UsernameField.Builder>	serializableBuilderClass()
UsernameField.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

identifier

public final 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

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

toBuilder

public UsernameField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsernameField.Builder,UsernameField>

builder

public static UsernameField.Builder builder()

serializableBuilderClass

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