Package software.amazon.awssdk.services.geoplaces.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SuggestResultItem.Builder

Method Summary

Modifier and Type	Method	Description
static SuggestResultItem.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
SuggestPlaceResult	place()	The suggested place by its unique ID.
SuggestQueryResult	query()	Returns the value of the Query property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestResultItem.Builder>	serializableBuilderClass()
SuggestResultItemType	suggestResultItemType()	The result type.
String	suggestResultItemTypeAsString()	The result type.
String	title()	The display title that should be used when presenting this option to the end user.
SuggestResultItem.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SuggestResultItemType

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:

SuggestResultItemType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestResultItem.Builder,SuggestResultItem>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo