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

Class RequestInspectionACFP

java.lang.Object

software.amazon.awssdk.services.wafv2.model.RequestInspectionACFP

All Implemented Interfaces:

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

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

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig.

In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the fields within the request body where the username, password, email, and primary address and phone number fields are provided.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RequestInspectionACFP.Builder

Method Summary

Modifier and Type	Method	Description
List<AddressField>	addressFields()	The names of the fields in the request payload that contain your customer's primary physical address.
static RequestInspectionACFP.Builder	builder()
EmailField	emailField()	The name of the field in the request payload that contains your customer's email.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAddressFields()	For responses, this returns true if the service returned a value for the AddressFields property.
int	hashCode()
boolean	hasPhoneNumberFields()	For responses, this returns true if the service returned a value for the PhoneNumberFields property.
PasswordField	passwordField()	The name of the field in the request payload that contains your customer's password.
PayloadType	payloadType()	The payload type for your account creation endpoint, either JSON or form encoded.
String	payloadTypeAsString()	The payload type for your account creation endpoint, either JSON or form encoded.
List<PhoneNumberField>	phoneNumberFields()	The names of the fields in the request payload that contain your customer's primary phone number.
List<SdkField<?>>	sdkFields()
static Class<? extends RequestInspectionACFP.Builder>	serializableBuilderClass()
RequestInspectionACFP.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 account creation 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 account creation endpoint, either JSON or form encoded.

See Also:

PayloadType

payloadTypeAsString

public final String payloadTypeAsString()

The payload type for your account creation 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 account creation 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.

emailField

public final EmailField emailField()

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

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": { "email": "THE_EMAIL" } }, the email field specification is /form/email.

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

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

Returns:

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

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": { "email": "THE_EMAIL" } }, the email field specification is /form/email.

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

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

hasPhoneNumberFields

public final boolean hasPhoneNumberFields()

For responses, this returns true if the service returned a value for the PhoneNumberFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

phoneNumberFields

public final List<PhoneNumberField> phoneNumberFields()

The names of the fields in the request payload that contain your customer's primary phone number.

Order the phone number fields in the array exactly as they are ordered in the request payload.

How you specify the phone number fields depends on the request inspection payload type.

• For JSON payloads, specify the field identifiers 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": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

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

  For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPhoneNumberFields() method.

Returns:

The names of the fields in the request payload that contain your customer's primary phone number.

Order the phone number fields in the array exactly as they are ordered in the request payload.

How you specify the phone number fields depends on the request inspection payload type.

• For JSON payloads, specify the field identifiers 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": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.

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

  For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.

hasAddressFields

public final boolean hasAddressFields()

For responses, this returns true if the service returned a value for the AddressFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

addressFields

public final List<AddressField> addressFields()

The names of the fields in the request payload that contain your customer's primary physical address.

Order the address fields in the array exactly as they are ordered in the request payload.

How you specify the address fields depends on the request inspection payload type.

• For JSON payloads, specify the field identifiers 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": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

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

  For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAddressFields() method.

Returns:

The names of the fields in the request payload that contain your customer's primary physical address.

Order the address fields in the array exactly as they are ordered in the request payload.

How you specify the address fields depends on the request inspection payload type.

• For JSON payloads, specify the field identifiers 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": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.

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

  For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.

toBuilder

public RequestInspectionACFP.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RequestInspectionACFP.Builder,RequestInspectionACFP>

builder

public static RequestInspectionACFP.Builder builder()

serializableBuilderClass

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