/* * 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; /** *

* A summary of the request sent by using SearchPlaceIndexForPosition. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SearchPlaceIndexForPositionSummary implements Serializable, Cloneable, StructuredPojo { /** *

* The geospatial data provider attached to the place index resource specified in the request. Values can be one of * the following: *

*
* Esri *
*
*
* Grab *
*
*
* Here *
*

* For more information about data providers, see Amazon Location * Service data providers. *

*/ private String dataSource; /** *

* The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English. *

*/ private String language; /** *

* Contains the optional result count limit that is specified in the request. *

* Default value: 50 *

*/ private Integer maxResults; /** *

* The position specified in the request. *

*/ private java.util.List position; /** *

* The geospatial data provider attached to the place index resource specified in the request. Values can be one of * the following: *

*
* Esri *
*
*
* Grab *
*
*
* Here *
*

* For more information about data providers, see Amazon Location * Service data providers. *

* * @param dataSource * The geospatial data provider attached to the place index resource specified in the request. Values can be * one of the following:

*
* Esri *
*
*
* Grab *
*
*
* Here *
*

* For more information about data providers, see Amazon * Location Service data providers. */ public void setDataSource(String dataSource) { this.dataSource = dataSource; } /** *

* The geospatial data provider attached to the place index resource specified in the request. Values can be one of * the following: *

*
* Esri *
*
*
* Grab *
*
*
* Here *
*

* For more information about data providers, see Amazon Location * Service data providers. *

* * @return The geospatial data provider attached to the place index resource specified in the request. Values can be * one of the following:

*
* Esri *
*
*
* Grab *
*
*
* Here *
*

* For more information about data providers, see Amazon * Location Service data providers. */ public String getDataSource() { return this.dataSource; } /** *

* The geospatial data provider attached to the place index resource specified in the request. Values can be one of * the following: *

*
* Esri *
*
*
* Grab *
*
*
* Here *
*

* For more information about data providers, see Amazon Location * Service data providers. *

* * @param dataSource * The geospatial data provider attached to the place index resource specified in the request. Values can be * one of the following:

*
* Esri *
*
*
* Grab *
*
*
* Here *
*

* For more information about data providers, see Amazon * Location Service data providers. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchPlaceIndexForPositionSummary withDataSource(String dataSource) { setDataSource(dataSource); return this; } /** *

* The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English. *

* * @return The preferred language used to return results. Matches the language in the request. The value is a valid * BCP 47 language tag, for example, en for * English. */ public String getLanguage() { return this.language; } /** *

* The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English. *

* * @param language * The preferred language used to return results. Matches the language in the request. The value is a valid * BCP 47 language tag, for example, en for * English. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchPlaceIndexForPositionSummary withLanguage(String language) { setLanguage(language); return this; } /** *

* Contains the optional result count limit that is specified in the request. *

* Default value: 50 *

* * @param maxResults * Contains the optional result count limit that is specified in the request.

* Default value: 50 */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* Contains the optional result count limit that is specified in the request. *

* Default value: 50 *

* * @return Contains the optional result count limit that is specified in the request.

* Default value: 50 */ public Integer getMaxResults() { return this.maxResults; } /** *

* Contains the optional result count limit that is specified in the request. *

* Default value: 50 *

* * @param maxResults * Contains the optional result count limit that is specified in the request.

* Default value: 50 * @return Returns a reference to this object so that method calls can be chained together. */ public SearchPlaceIndexForPositionSummary withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** *

* The position specified in the request. *

* * @return The position specified in the request. */ public java.util.List getPosition() { return position; } /** *

* The position specified in the request. *

* * @param position * The position specified in the request. */ public void setPosition(java.util.Collection position) { if (position == null) { this.position = null; return; } this.position = new java.util.ArrayList(position); } /** *

* The position specified in the request. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setPosition(java.util.Collection)} or {@link #withPosition(java.util.Collection)} if you want to override * the existing values. *

* * @param position * The position specified in the request. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchPlaceIndexForPositionSummary withPosition(Double... position) { if (this.position == null) { setPosition(new java.util.ArrayList(position.length)); } for (Double ele : position) { this.position.add(ele); } return this; } /** *

* The position specified in the request. *

* * @param position * The position specified in the request. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchPlaceIndexForPositionSummary withPosition(java.util.Collection position) { setPosition(position); 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 (getDataSource() != null) sb.append("DataSource: ").append(getDataSource()).append(","); if (getLanguage() != null) sb.append("Language: ").append(getLanguage()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()).append(","); if (getPosition() != null) sb.append("Position: ").append("***Sensitive Data Redacted***"); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SearchPlaceIndexForPositionSummary == false) return false; SearchPlaceIndexForPositionSummary other = (SearchPlaceIndexForPositionSummary) obj; if (other.getDataSource() == null ^ this.getDataSource() == null) return false; if (other.getDataSource() != null && other.getDataSource().equals(this.getDataSource()) == false) return false; if (other.getLanguage() == null ^ this.getLanguage() == null) return false; if (other.getLanguage() != null && other.getLanguage().equals(this.getLanguage()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; if (other.getPosition() == null ^ this.getPosition() == null) return false; if (other.getPosition() != null && other.getPosition().equals(this.getPosition()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDataSource() == null) ? 0 : getDataSource().hashCode()); hashCode = prime * hashCode + ((getLanguage() == null) ? 0 : getLanguage().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getPosition() == null) ? 0 : getPosition().hashCode()); return hashCode; } @Override public SearchPlaceIndexForPositionSummary clone() { try { return (SearchPlaceIndexForPositionSummary) 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.SearchPlaceIndexForPositionSummaryMarshaller.getInstance().marshall(this, protocolMarshaller); } }