Package software.amazon.awssdk.services.location.model

Class SearchForTextResult

java.lang.Object

software.amazon.awssdk.services.location.model.SearchForTextResult

All Implemented Interfaces:

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

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

Contains a search result from a text search query that is run on a place index resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchForTextResult.Builder

Method Summary

Modifier and Type	Method	Description
static SearchForTextResult.Builder	builder()
Double	distance()	The distance in meters of a great-circle arc between the bias position specified and the result.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Place	place()	Details about the search result, such as its address and position.
String	placeId()	The unique identifier of the place.
Double	relevance()	The relative confidence in the match for a result among the results returned.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchForTextResult.Builder>	serializableBuilderClass()
SearchForTextResult.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

place

public final Place place()

Details about the search result, such as its address and position.

Returns:

Details about the search result, such as its address and position.

distance

public final Double distance()

The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

Returns:

The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

relevance

public final Double relevance()

The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

Returned only when the partner selected is Esri or Grab.

Returns:

The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

Returned only when the partner selected is Esri or Grab.

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 SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

Returns:

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

For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

toBuilder

public SearchForTextResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchForTextResult.Builder,SearchForTextResult>

builder

public static SearchForTextResult.Builder builder()

serializableBuilderClass

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