Class PostalCodeDetails

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

Contains details about the postal code of the place or result.

See Also:

  • Method Details

    • postalCode

      public final String postalCode()

      An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.

      Returns:
      An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.

    • postalAuthority

      public final PostalAuthority postalAuthority()

      The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

      If the service returns an enum value that is not available in the current SDK version, postalAuthority will return PostalAuthority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalAuthorityAsString().

      Returns:
      The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.
      See Also:

    • postalAuthorityAsString

      public final String postalAuthorityAsString()

      The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

      If the service returns an enum value that is not available in the current SDK version, postalAuthority will return PostalAuthority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalAuthorityAsString().

      Returns:
      The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.
      See Also:

    • postalCodeType

      public final PostalCodeType postalCodeType()

      The postal code type.

      If the service returns an enum value that is not available in the current SDK version, postalCodeType will return PostalCodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalCodeTypeAsString().

      Returns:
      The postal code type.
      See Also:

    • postalCodeTypeAsString

      public final String postalCodeTypeAsString()

      The postal code type.

      If the service returns an enum value that is not available in the current SDK version, postalCodeType will return PostalCodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalCodeTypeAsString().

      Returns:
      The postal code type.
      See Also:

    • uspsZip

      public final UspsZip uspsZip()

      The ZIP Classification Code, or in other words what type of postal code is it.

      Returns:
      The ZIP Classification Code, or in other words what type of postal code is it.

    • uspsZipPlus4

      public final UspsZipPlus4 uspsZipPlus4()

      The USPS ZIP+4 Record Type Code.

      Returns:
      The USPS ZIP+4 Record Type Code.

    • toBuilder

      public PostalCodeDetails.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<PostalCodeDetails.Builder,PostalCodeDetails>
      Returns:
      a builder for type T

    • builder

      public static PostalCodeDetails.Builder builder()

    • serializableBuilderClass

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