software.amazon.awssdk.services.location.model

Class SearchForSuggestionsResult

java.lang.Object

software.amazon.awssdk.services.location.model.SearchForSuggestionsResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SearchForSuggestionsResult.Builder,SearchForSuggestionsResult>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchForSuggestionsResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SearchForSuggestionsResult.Builder,SearchForSuggestionsResult>

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchForSuggestionsResult.Builder

Method Summary

Modifier and Type	Method and Description
static SearchForSuggestionsResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	placeId() The unique identifier of the place.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchForSuggestionsResult.Builder>	serializableBuilderClass()
String	text() The text of the place suggestion, typically formatted as an address string.
SearchForSuggestionsResult.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

placeId

public final String placeId()

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.

Returns:

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.

text

public final String text()

The text of the place suggestion, typically formatted as an address string.

Returns:

The text of the place suggestion, typically formatted as an address string.

toBuilder

public SearchForSuggestionsResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchForSuggestionsResult.Builder,SearchForSuggestionsResult>

builder

public static SearchForSuggestionsResult.Builder builder()

serializableBuilderClass

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