Class GeocodeResultItem

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

The Geocoded result.

See Also:

  • Method Details

    • placeId

      public final String placeId()

      The PlaceId of the place result.

      Returns:
      The PlaceId of the place result.

    • placeType

      public final PlaceType placeType()

      A PlaceType is a category that the result place must belong to.

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

      Returns:
      A PlaceType is a category that the result place must belong to.
      See Also:

    • placeTypeAsString

      public final String placeTypeAsString()

      A PlaceType is a category that the result place must belong to.

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

      Returns:
      A PlaceType is a category that the result place must belong to.
      See Also:

    • title

      public final String title()

      The localized display name of this result item based on request parameter language.

      Returns:
      The localized display name of this result item based on request parameter language.

    • address

      public final Address address()

      The place's address.

      Returns:
      The place's address.

    • addressNumberCorrected

      public final Boolean addressNumberCorrected()

      Boolean indicating if the address provided has been corrected.

      Returns:
      Boolean indicating if the address provided has been corrected.

    • hasPostalCodeDetails

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

    • postalCodeDetails

      public final List<PostalCodeDetails> postalCodeDetails()

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

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

      Returns:
      Contains details about the postal code of the place/result.

    • hasPosition

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

    • position

      public final List<Double> position()

      The position in longitude and latitude.

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

      Returns:
      The position in longitude and latitude.

    • distance

      public final Long distance()

      The distance in meters from the QueryPosition.

      Returns:
      The distance in meters from the QueryPosition.

    • hasMapView

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

    • mapView

      public final List<Double> mapView()

      The bounding box enclosing the geometric shape (area or line) that an individual result covers.

      The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

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

      Returns:
      The bounding box enclosing the geometric shape (area or line) that an individual result covers.

      The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

    • hasCategories

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

    • categories

      public final List<Category> categories()

      Categories of results that results must belong to.

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

      Returns:
      Categories of results that results must belong to.

    • hasFoodTypes

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

    • foodTypes

      public final List<FoodType> foodTypes()

      List of food types offered by this result.

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

      Returns:
      List of food types offered by this result.

    • hasAccessPoints

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

    • accessPoints

      public final List<AccessPoint> accessPoints()

      Position of the access point represented by longitude and latitude.

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

      Returns:
      Position of the access point represented by longitude and latitude.

    • timeZone

      public final TimeZone timeZone()

      The time zone in which the place is located.

      Returns:
      The time zone in which the place is located.

    • politicalView

      public final String politicalView()

      The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

      Returns:
      The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

    • matchScores

      public final MatchScoreDetails matchScores()

      Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

      Returns:
      Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

    • parsedQuery

      public final GeocodeParsedQuery parsedQuery()

      Free-form text query.

      Returns:
      Free-form text query.

    • hasIntersections

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

    • intersections

      public final List<Intersection> intersections()

      All Intersections that are near the provided address.

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

      Returns:
      All Intersections that are near the provided address.

    • mainAddress

      public final RelatedPlace mainAddress()

      The main address corresponding to a place of type Secondary Address.

      Returns:
      The main address corresponding to a place of type Secondary Address.

    • hasSecondaryAddresses

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

    • secondaryAddresses

      public final List<RelatedPlace> secondaryAddresses()

      All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

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

      Returns:
      All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

    • toBuilder

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

    • builder

      public static GeocodeResultItem.Builder builder()

    • serializableBuilderClass

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