@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RequestInspectionACFP extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
RequestInspectionACFP() |
Modifier and Type | Method and Description |
---|---|
RequestInspectionACFP |
clone() |
boolean |
equals(Object obj) |
List<AddressField> |
getAddressFields()
The names of the fields in the request payload that contain your customer's primary physical address.
|
EmailField |
getEmailField()
The name of the field in the request payload that contains your customer's email.
|
PasswordField |
getPasswordField()
The name of the field in the request payload that contains your customer's password.
|
String |
getPayloadType()
The payload type for your account creation endpoint, either JSON or form encoded.
|
List<PhoneNumberField> |
getPhoneNumberFields()
The names of the fields in the request payload that contain your customer's primary phone number.
|
UsernameField |
getUsernameField()
The name of the field in the request payload that contains your customer's username.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAddressFields(Collection<AddressField> addressFields)
The names of the fields in the request payload that contain your customer's primary physical address.
|
void |
setEmailField(EmailField emailField)
The name of the field in the request payload that contains your customer's email.
|
void |
setPasswordField(PasswordField passwordField)
The name of the field in the request payload that contains your customer's password.
|
void |
setPayloadType(String payloadType)
The payload type for your account creation endpoint, either JSON or form encoded.
|
void |
setPhoneNumberFields(Collection<PhoneNumberField> phoneNumberFields)
The names of the fields in the request payload that contain your customer's primary phone number.
|
void |
setUsernameField(UsernameField usernameField)
The name of the field in the request payload that contains your customer's username.
|
String |
toString()
Returns a string representation of this object.
|
RequestInspectionACFP |
withAddressFields(AddressField... addressFields)
The names of the fields in the request payload that contain your customer's primary physical address.
|
RequestInspectionACFP |
withAddressFields(Collection<AddressField> addressFields)
The names of the fields in the request payload that contain your customer's primary physical address.
|
RequestInspectionACFP |
withEmailField(EmailField emailField)
The name of the field in the request payload that contains your customer's email.
|
RequestInspectionACFP |
withPasswordField(PasswordField passwordField)
The name of the field in the request payload that contains your customer's password.
|
RequestInspectionACFP |
withPayloadType(PayloadType payloadType)
The payload type for your account creation endpoint, either JSON or form encoded.
|
RequestInspectionACFP |
withPayloadType(String payloadType)
The payload type for your account creation endpoint, either JSON or form encoded.
|
RequestInspectionACFP |
withPhoneNumberFields(Collection<PhoneNumberField> phoneNumberFields)
The names of the fields in the request payload that contain your customer's primary phone number.
|
RequestInspectionACFP |
withPhoneNumberFields(PhoneNumberField... phoneNumberFields)
The names of the fields in the request payload that contain your customer's primary phone number.
|
RequestInspectionACFP |
withUsernameField(UsernameField usernameField)
The name of the field in the request payload that contains your customer's username.
|
public void setPayloadType(String payloadType)
The payload type for your account creation endpoint, either JSON or form encoded.
payloadType
- The payload type for your account creation endpoint, either JSON or form encoded.PayloadType
public String getPayloadType()
The payload type for your account creation endpoint, either JSON or form encoded.
PayloadType
public RequestInspectionACFP withPayloadType(String payloadType)
The payload type for your account creation endpoint, either JSON or form encoded.
payloadType
- The payload type for your account creation endpoint, either JSON or form encoded.PayloadType
public RequestInspectionACFP withPayloadType(PayloadType payloadType)
The payload type for your account creation endpoint, either JSON or form encoded.
payloadType
- The payload type for your account creation endpoint, either JSON or form encoded.PayloadType
public void setUsernameField(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
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
public UsernameField getUsernameField()
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
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
public RequestInspectionACFP withUsernameField(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
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
public void setPasswordField(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
.
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
.
public PasswordField getPasswordField()
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
.
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
.
public RequestInspectionACFP withPasswordField(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
.
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
.
public void setEmailField(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
.
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
.
public EmailField getEmailField()
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
.
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
.
public RequestInspectionACFP withEmailField(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
.
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
.
public List<PhoneNumberField> getPhoneNumberFields()
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
.
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
.
public void setPhoneNumberFields(Collection<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
.
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
.
public RequestInspectionACFP withPhoneNumberFields(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
.
NOTE: This method appends the values to the existing list (if any). Use
setPhoneNumberFields(java.util.Collection)
or withPhoneNumberFields(java.util.Collection)
if
you want to override the existing values.
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
.
public RequestInspectionACFP withPhoneNumberFields(Collection<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
.
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
.
public List<AddressField> getAddressFields()
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
.
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
.
public void setAddressFields(Collection<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
.
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
.
public RequestInspectionACFP withAddressFields(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
.
NOTE: This method appends the values to the existing list (if any). Use
setAddressFields(java.util.Collection)
or withAddressFields(java.util.Collection)
if you want
to override the existing values.
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
.
public RequestInspectionACFP withAddressFields(Collection<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
.
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
.
public String toString()
toString
in class Object
Object.toString()
public RequestInspectionACFP clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.