Class AutocompleteResultItem

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

A result matching the input query text.

See Also:

  • Method Details

    • placeId

      public final String placeId()

      The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.

      Returns:
      The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.

    • placeType

      public final PlaceType placeType()

      PlaceType describes the type of result entry returned.

      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:
      PlaceType describes the type of result entry returned.
      See Also:

    • placeTypeAsString

      public final String placeTypeAsString()

      PlaceType describes the type of result entry returned.

      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:
      PlaceType describes the type of result entry returned.
      See Also:

    • title

      public final String title()

      A formatted string for display when presenting this result to an end user.

      Returns:
      A formatted string for display when presenting this result to an end user.

    • address

      public final Address address()

      The address associated with this result.

      Returns:
      The address associated with this result.

    • distance

      public final Long distance()

      The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.

      Returns:
      The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.

    • language

      public final String language()

      A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

      Returns:
      A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

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

    • highlights

      public final AutocompleteHighlights highlights()

      Indicates the starting and ending index of the place in the text query that match the found title.

      Returns:
      Indicates the starting and ending index of the place in the text query that match the found title.

    • toBuilder

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

    • builder

      public static AutocompleteResultItem.Builder builder()

    • serializableBuilderClass

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