Class SuggestQueryResult

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

The suggested query results.

See Also:

  • Method Details

    • queryId

      public final String queryId()

      QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs.

      The fields QueryText, and QueryID are mutually exclusive.

      Returns:
      QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs.

      The fields QueryText, and QueryID are mutually exclusive.

    • queryType

      public final QueryType queryType()

      The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.

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

      Returns:
      The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.
      See Also:

    • queryTypeAsString

      public final String queryTypeAsString()

      The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.

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

      Returns:
      The query type. Category queries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.
      See Also:

    • toBuilder

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

    • builder

      public static SuggestQueryResult.Builder builder()

    • serializableBuilderClass

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