com.amazonaws.services.location.model

Class SearchForTextResult

java.lang.Object

com.amazonaws.services.location.model.SearchForTextResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchForTextResult()

Method Summary

Modifier and Type	Method and Description
SearchForTextResult	clone()
boolean	equals(Object obj)
Double	getDistance() The distance in meters of a great-circle arc between the bias position specified and the result.
Place	getPlace() Details about the search result, such as its address and position.
Double	getRelevance() The relative confidence in the match for a result among the results returned.
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 bias position specified and the result.
void	setPlace(Place place) Details about the search result, such as its address and position.
void	setRelevance(Double relevance) The relative confidence in the match for a result among the results returned.
String	toString() Returns a string representation of this object.
SearchForTextResult	withDistance(Double distance) The distance in meters of a great-circle arc between the bias position specified and the result.
SearchForTextResult	withPlace(Place place) Details about the search result, such as its address and position.
SearchForTextResult	withRelevance(Double relevance) The relative confidence in the match for a result among the results returned.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchForTextResult

public SearchForTextResult()

Method Detail

setDistance

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

Parameters:

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.

getDistance

public Double getDistance()

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.

withDistance

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

Parameters:

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:

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 SearchForTextResult 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.

setRelevance

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

Parameters:

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.

getRelevance

public Double getRelevance()

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.

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.

withRelevance

public SearchForTextResult withRelevance(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.

Parameters:

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.

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 SearchForTextResult 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.