Class SuggestResultItem

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

The resulting item from the suggested query.

See Also:

  • Method Details

    • title

      public final String title()

      The display title that should be used when presenting this option to the end user.

      Returns:
      The display title that should be used when presenting this option to the end user.

    • suggestResultItemType

      public final SuggestResultItemType suggestResultItemType()

      The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

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

      Returns:
      The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.
      See Also:

    • suggestResultItemTypeAsString

      public final String suggestResultItemTypeAsString()

      The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

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

      Returns:
      The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.
      See Also:

    • place

      public final SuggestPlaceResult place()

      The suggested place by its unique ID.

      Returns:
      The suggested place by its unique ID.

    • query

      public final SuggestQueryResult query()
      Returns the value of the Query property for this object.
      Returns:
      The value of the Query property for this object.

    • highlights

      public final SuggestHighlights highlights()

      Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

      Returns:
      Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

    • toBuilder

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

    • builder

      public static SuggestResultItem.Builder builder()

    • serializableBuilderClass

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