/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.location.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* <p>
* Contains a search result from a text search query that is run on a place index resource.
* </p>
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForTextResult" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SearchForTextResult implements Serializable, Cloneable, StructuredPojo {
/**
* <p>
* The distance in meters of a great-circle arc between the bias position specified and the result.
* <code>Distance</code> will be returned only if a bias position was specified in the query.
* </p>
* <note>
* <p>
* A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance
* between two locations.
* </p>
* </note>
*/
private Double distance;
/**
* <p>
* Details about the search result, such as its address and position.
* </p>
*/
private Place place;
/**
* <p>
* The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the place
* again later.
* </p>
* <note>
* <p>
* For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place indexes
* that use HERE or Grab as a data provider.
* </p>
* </note>
*/
private String placeId;
/**
* <p>
* 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.
* </p>
* <p>
* Returned only when the partner selected is Esri or Grab.
* </p>
*/
private Double relevance;
/**
* <p>
* The distance in meters of a great-circle arc between the bias position specified and the result.
* <code>Distance</code> will be returned only if a bias position was specified in the query.
* </p>
* <note>
* <p>
* A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance
* between two locations.
* </p>
* </note>
*
* @param distance
* The distance in meters of a great-circle arc between the bias position specified and the result.
* <code>Distance</code> will be returned only if a bias position was specified in the query.</p> <note>
* <p>
* A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest
* distance between two locations.
* </p>
*/
public void setDistance(Double distance) {
this.distance = distance;
}
/**
* <p>
* The distance in meters of a great-circle arc between the bias position specified and the result.
* <code>Distance</code> will be returned only if a bias position was specified in the query.
* </p>
* <note>
* <p>
* A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance
* between two locations.
* </p>
* </note>
*
* @return The distance in meters of a great-circle arc between the bias position specified and the result.
* <code>Distance</code> will be returned only if a bias position was specified in the query.</p> <note>
* <p>
* A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest
* distance between two locations.
* </p>
*/
public Double getDistance() {
return this.distance;
}
/**
* <p>
* The distance in meters of a great-circle arc between the bias position specified and the result.
* <code>Distance</code> will be returned only if a bias position was specified in the query.
* </p>
* <note>
* <p>
* A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance
* between two locations.
* </p>
* </note>
*
* @param distance
* The distance in meters of a great-circle arc between the bias position specified and the result.
* <code>Distance</code> will be returned only if a bias position was specified in the query.</p> <note>
* <p>
* A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest
* distance between two locations.
* </p>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchForTextResult withDistance(Double distance) {
setDistance(distance);
return this;
}
/**
* <p>
* Details about the search result, such as its address and position.
* </p>
*
* @param place
* Details about the search result, such as its address and position.
*/
public void setPlace(Place place) {
this.place = place;
}
/**
* <p>
* Details about the search result, such as its address and position.
* </p>
*
* @return Details about the search result, such as its address and position.
*/
public Place getPlace() {
return this.place;
}
/**
* <p>
* Details about the search result, such as its address and position.
* </p>
*
* @param place
* Details about the search result, such as its address and position.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchForTextResult withPlace(Place place) {
setPlace(place);
return this;
}
/**
* <p>
* The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the place
* again later.
* </p>
* <note>
* <p>
* For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place indexes
* that use HERE or Grab as a data provider.
* </p>
* </note>
*
* @param placeId
* The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the
* place again later.</p> <note>
* <p>
* For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place
* indexes that use HERE or Grab as a data provider.
* </p>
*/
public void setPlaceId(String placeId) {
this.placeId = placeId;
}
/**
* <p>
* The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the place
* again later.
* </p>
* <note>
* <p>
* For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place indexes
* that use HERE or Grab as a data provider.
* </p>
* </note>
*
* @return The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the
* place again later.</p> <note>
* <p>
* For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place
* indexes that use HERE or Grab as a data provider.
* </p>
*/
public String getPlaceId() {
return this.placeId;
}
/**
* <p>
* The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the place
* again later.
* </p>
* <note>
* <p>
* For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place indexes
* that use HERE or Grab as a data provider.
* </p>
* </note>
*
* @param placeId
* The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the
* place again later.</p> <note>
* <p>
* For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is returned only by place
* indexes that use HERE or Grab as a data provider.
* </p>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchForTextResult withPlaceId(String placeId) {
setPlaceId(placeId);
return this;
}
/**
* <p>
* 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.
* </p>
* <p>
* Returned only when the partner selected is Esri or Grab.
* </p>
*
* @param 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.</p>
* <p>
* Returned only when the partner selected is Esri or Grab.
*/
public void setRelevance(Double relevance) {
this.relevance = relevance;
}
/**
* <p>
* 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.
* </p>
* <p>
* Returned only when the partner selected is Esri or Grab.
* </p>
*
* @return 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.</p>
* <p>
* Returned only when the partner selected is Esri or Grab.
*/
public Double getRelevance() {
return this.relevance;
}
/**
* <p>
* 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.
* </p>
* <p>
* Returned only when the partner selected is Esri or Grab.
* </p>
*
* @param 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.</p>
* <p>
* Returned only when the partner selected is Esri or Grab.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchForTextResult withRelevance(Double relevance) {
setRelevance(relevance);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDistance() != null)
sb.append("Distance: ").append(getDistance()).append(",");
if (getPlace() != null)
sb.append("Place: ").append(getPlace()).append(",");
if (getPlaceId() != null)
sb.append("PlaceId: ").append(getPlaceId()).append(",");
if (getRelevance() != null)
sb.append("Relevance: ").append(getRelevance());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchForTextResult == false)
return false;
SearchForTextResult other = (SearchForTextResult) obj;
if (other.getDistance() == null ^ this.getDistance() == null)
return false;
if (other.getDistance() != null && other.getDistance().equals(this.getDistance()) == false)
return false;
if (other.getPlace() == null ^ this.getPlace() == null)
return false;
if (other.getPlace() != null && other.getPlace().equals(this.getPlace()) == false)
return false;
if (other.getPlaceId() == null ^ this.getPlaceId() == null)
return false;
if (other.getPlaceId() != null && other.getPlaceId().equals(this.getPlaceId()) == false)
return false;
if (other.getRelevance() == null ^ this.getRelevance() == null)
return false;
if (other.getRelevance() != null && other.getRelevance().equals(this.getRelevance()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDistance() == null) ? 0 : getDistance().hashCode());
hashCode = prime * hashCode + ((getPlace() == null) ? 0 : getPlace().hashCode());
hashCode = prime * hashCode + ((getPlaceId() == null) ? 0 : getPlaceId().hashCode());
hashCode = prime * hashCode + ((getRelevance() == null) ? 0 : getRelevance().hashCode());
return hashCode;
}
@Override
public SearchForTextResult clone() {
try {
return (SearchForTextResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.location.model.transform.SearchForTextResultMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}