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

Class PhoneNumberField

java.lang.Object
software.amazon.awssdk.services.wafv2.model.PhoneNumberField
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PhoneNumberField.Builder,PhoneNumberField>
@Generated("software.amazon.awssdk:codegen") public final class PhoneNumberField extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PhoneNumberField.Builder,PhoneNumberField>

The name of a field in the request payload that contains part or all of your customer's primary phone number.

This data type is used in the RequestInspectionACFP data type.

See Also:

  • Method Details

    • identifier

      public final String identifier()

      The name of a single primary phone number field.

      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.

      Returns:
      The name of a single primary phone number field.

      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.

    • toBuilder

      public PhoneNumberField.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PhoneNumberField.Builder,PhoneNumberField>

    • builder

      public static PhoneNumberField.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo