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

Class SearchForPositionResult

java.lang.Object

software.amazon.awssdk.services.location.model.SearchForPositionResult

All Implemented Interfaces:

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

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

Contains a search result from a position 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	SearchForPositionResult.Builder

Method Summary

Modifier and Type	Method	Description
static SearchForPositionResult.Builder	builder()
Double	distance()	The distance in meters of a great-circle arc between the query position 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.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchForPositionResult.Builder>	serializableBuilderClass()
SearchForPositionResult.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 query position and the result.

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 query position and the result.

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

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

toBuilder

public SearchForPositionResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchForPositionResult.Builder,SearchForPositionResult>

builder

public static SearchForPositionResult.Builder builder()

serializableBuilderClass

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