/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RequestInspectionACFP implements Serializable, Cloneable, StructuredPojo { /** ** The payload type for your account creation endpoint, either JSON or form encoded. *
*/ private String payloadType; /** ** 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
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* The payload type for your account creation endpoint, either JSON or form encoded. *
* * @param payloadType * The payload type for your account creation endpoint, either JSON or form encoded. * @see PayloadType */ public void setPayloadType(String payloadType) { this.payloadType = payloadType; } /** ** The payload type for your account creation endpoint, either JSON or form encoded. *
* * @return The payload type for your account creation endpoint, either JSON or form encoded. * @see PayloadType */ public String getPayloadType() { return this.payloadType; } /** ** The payload type for your account creation endpoint, either JSON or form encoded. *
* * @param payloadType * The payload type for your account creation endpoint, either JSON or form encoded. * @return Returns a reference to this object so that method calls can be chained together. * @see PayloadType */ public RequestInspectionACFP withPayloadType(String payloadType) { setPayloadType(payloadType); return this; } /** ** The payload type for your account creation endpoint, either JSON or form encoded. *
* * @param payloadType * The payload type for your account creation endpoint, either JSON or form encoded. * @return Returns a reference to this object so that method calls can be chained together. * @see PayloadType */ public RequestInspectionACFP withPayloadType(PayloadType payloadType) { this.payloadType = payloadType.toString(); return this; } /** ** 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
*
* 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
*
* 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
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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 * {@link #setPhoneNumberFields(java.util.Collection)} or {@link #withPhoneNumberFields(java.util.Collection)} if * you want to override the existing values. *
* * @param 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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 * {@link #setAddressFields(java.util.Collection)} or {@link #withAddressFields(java.util.Collection)} if you want * to override the existing values. *
* * @param 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
.
*
* 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
.
*