com.amazonaws.services.location.model

Class SearchForPositionResult

java.lang.Object

com.amazonaws.services.location.model.SearchForPositionResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchForPositionResult
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchForPositionResult()

Method Summary

Modifier and Type	Method and Description
SearchForPositionResult	clone()
boolean	equals(Object obj)
Double	getDistance() The distance in meters of a great-circle arc between the query position and the result.
Place	getPlace() Details about the search result, such as its address and position.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDistance(Double distance) The distance in meters of a great-circle arc between the query position and the result.
void	setPlace(Place place) Details about the search result, such as its address and position.
String	toString() Returns a string representation of this object.
SearchForPositionResult	withDistance(Double distance) The distance in meters of a great-circle arc between the query position and the result.
SearchForPositionResult	withPlace(Place place) Details about the search result, such as its address and position.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchForPositionResult

public SearchForPositionResult()

Method Detail

setDistance

public void setDistance(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.

Parameters:

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.

getDistance

public Double getDistance()

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.

withDistance

public SearchForPositionResult withDistance(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPlace

public void setPlace(Place place)

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

Parameters:

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

getPlace

public Place getPlace()

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

Returns:

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

withPlace

public SearchForPositionResult withPlace(Place place)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SearchForPositionResult clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.