Class Address

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

The place address.

See Also:

  • Method Details

    • label

      public final String label()

      Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.

      Returns:
      Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.

    • country

      public final Country country()

      The country component of the address.

      Returns:
      The country component of the address.

    • region

      public final Region region()

      The region or state results should be present in.

      Example: North Rhine-Westphalia.

      Returns:
      The region or state results should be present in.

      Example: North Rhine-Westphalia.

    • subRegion

      public final SubRegion subRegion()

      The sub-region or county for which results should be present in.

      Returns:
      The sub-region or county for which results should be present in.

    • locality

      public final String locality()

      The city or locality of the address.

      Example: Vancouver.

      Returns:
      The city or locality of the address.

      Example: Vancouver.

    • district

      public final String district()

      The district or division of a locality associated with this address.

      Returns:
      The district or division of a locality associated with this address.

    • subDistrict

      public final String subDistrict()

      A subdivision of a district.

      Example: Minden-Lübbecke.

      Returns:
      A subdivision of a district.

      Example: Minden-Lübbecke.

    • 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.

    • block

      public final String block()

      Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

      Returns:
      Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

    • subBlock

      public final String subBlock()

      Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

      Returns:
      Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

    • hasIntersection

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

    • intersection

      public final List<String> intersection()

      Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

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

      Returns:
      Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

    • street

      public final String street()

      The name of the street results should be present in.

      Returns:
      The name of the street results should be present in.

    • hasStreetComponents

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

    • streetComponents

      public final List<StreetComponents> streetComponents()

      Components of the street.

      Example: Younge from the "Younge street".

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

      Returns:
      Components of the street.

      Example: Younge from the "Younge street".

    • addressNumber

      public final String addressNumber()

      The number that identifies an address within a street.

      Returns:
      The number that identifies an address within a street.

    • building

      public final String building()

      The name of the building at the address.

      Returns:
      The name of the building at the address.

    • hasSecondaryAddressComponents

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

    • secondaryAddressComponents

      public final List<SecondaryAddressComponent> secondaryAddressComponents()

      Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.

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

      Returns:
      Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.

    • toBuilder

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

    • builder

      public static Address.Builder builder()

    • serializableBuilderClass

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