Class NumberPreferenceItem

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

A single number preference — specifies a pattern type and filter value.

See Also:

  • Method Details

    • preferenceType

      public final List<PreferenceType> preferenceType()

      The type of match to apply to the filter values.

      • StartsWith: Returns numbers that begin with the filter value.

      • EndsWith: Returns numbers that end with the filter value.

      • Contains: Returns numbers that contain the filter value.

      • ExactMatch: Returns the number that exactly matches the filter value.

      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 hasPreferenceType() method.

      Returns:
      The type of match to apply to the filter values.

      • StartsWith: Returns numbers that begin with the filter value.

      • EndsWith: Returns numbers that end with the filter value.

      • Contains: Returns numbers that contain the filter value.

      • ExactMatch: Returns the number that exactly matches the filter value.

    • hasPreferenceType

      public final boolean hasPreferenceType()
      For responses, this returns true if the service returned a value for the PreferenceType 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.

    • preferenceTypeAsStrings

      public final List<String> preferenceTypeAsStrings()

      The type of match to apply to the filter values.

      • StartsWith: Returns numbers that begin with the filter value.

      • EndsWith: Returns numbers that end with the filter value.

      • Contains: Returns numbers that contain the filter value.

      • ExactMatch: Returns the number that exactly matches the filter value.

      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 hasPreferenceType() method.

      Returns:
      The type of match to apply to the filter values.

      • StartsWith: Returns numbers that begin with the filter value.

      • EndsWith: Returns numbers that end with the filter value.

      • Contains: Returns numbers that contain the filter value.

      • ExactMatch: Returns the number that exactly matches the filter value.

    • hasFilter

      public final boolean hasFilter()
      For responses, this returns true if the service returned a value for the Filter 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.

    • filter

      public final List<String> filter()

      The digit pattern values to match against available phone numbers, using the specified preference type.

      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 hasFilter() method.

      Returns:
      The digit pattern values to match against available phone numbers, using the specified preference type.

    • toBuilder

      public NumberPreferenceItem.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NumberPreferenceItem.Builder,NumberPreferenceItem>
      Returns:
      a builder for type T

    • builder

      public static NumberPreferenceItem.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NumberPreferenceItem.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.