/* * Copyright 2010-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.geo.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Finds a place by its unique ID. A PlaceId is returned by other * search operations. *

* *

* A PlaceId is valid only if all of the following are the same in the original * search request and the call to GetPlace. *

*
* Customer Amazon Web Services account *
*
*
* Amazon Web Services Region *
*
*
* Data provider specified in the place index resource *
*

* */ public class GetPlaceRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the place index resource that you want to use for the search. *

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*/ private String indexName; /** *

* The preferred language used to return results. The value must be a valid * BCP 47 language tag, * for example, en for English. *

* This setting affects the languages used in the results, but not the * results themselves. If no language is specified, or not supported for a * particular result, the partner automatically chooses a language for the * result. *

* For an example, we'll use the Greek language. You search for a location * around Athens, Greece, with the language parameter set to * en. The city in the results will most likely be * returned as Athens. *

* If you set the language parameter to el, for * Greek, then the city in the results will more likely be * returned as Αθήνα. *

* If the data provider does not have a value for Greek, the result will be * in a language that the provider does support. *

* Constraints:
* Length: 2 - 35
*/ private String language; /** *

* The identifier of the place to find. *

*/ private String placeId; /** *

* The name of the place index resource that you want to use for the search. *

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @return

* The name of the place index resource that you want to use for the * search. *

*/ public String getIndexName() { return indexName; } /** *

* The name of the place index resource that you want to use for the search. *

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @param indexName

* The name of the place index resource that you want to use for * the search. *

*/ public void setIndexName(String indexName) { this.indexName = indexName; } /** *

* The name of the place index resource that you want to use for the search. *

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

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @param indexName

* The name of the place index resource that you want to use for * the search. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetPlaceRequest withIndexName(String indexName) { this.indexName = indexName; return this; } /** *

* The preferred language used to return results. The value must be a valid * BCP 47 language tag, * for example, en for English. *

* If you set the language parameter to el, for * Greek, then the city in the results will more likely be * returned as Αθήνα. *

* If the data provider does not have a value for Greek, the result will be * in a language that the provider does support. *

* Constraints:
* Length: 2 - 35
* * @return

* The preferred language used to return results. The value must be * a valid BCP 47 * language tag, for example, en for English. *

* This setting affects the languages used in the results, but not * the results themselves. If no language is specified, or not * supported for a particular result, the partner automatically * chooses a language for the result. *

* For an example, we'll use the Greek language. You search for a * location around Athens, Greece, with the language * parameter set to en. The city in the * results will most likely be returned as Athens. *

* If you set the language parameter to el * , for Greek, then the city in the results will more * likely be returned as Αθήνα. *

* If the data provider does not have a value for Greek, the result * will be in a language that the provider does support. *

*/ public String getLanguage() { return language; } /** *

* The preferred language used to return results. The value must be a valid * BCP 47 language tag, * for example, en for English. *

* If you set the language parameter to el, for * Greek, then the city in the results will more likely be * returned as Αθήνα. *

* If the data provider does not have a value for Greek, the result will be * in a language that the provider does support. *

* Constraints:
* Length: 2 - 35
* * @param language

* The preferred language used to return results. The value must * be a valid BCP * 47 language tag, for example, en for English. *

* This setting affects the languages used in the results, but * not the results themselves. If no language is specified, or * not supported for a particular result, the partner * automatically chooses a language for the result. *

* If you set the language parameter to * el, for Greek, then the city in the * results will more likely be returned as Αθήνα. *

* If the data provider does not have a value for Greek, the * result will be in a language that the provider does support. *

*/ public void setLanguage(String language) { this.language = language; } /** *

* The preferred language used to return results. The value must be a valid * BCP 47 language tag, * for example, en for English. *

* If you set the language parameter to el, for * Greek, then the city in the results will more likely be * returned as Αθήνα. *

* If the data provider does not have a value for Greek, the result will be * in a language that the provider does support. *

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

* Constraints:
* Length: 2 - 35
* * @param language

* The preferred language used to return results. The value must * be a valid BCP * 47 language tag, for example, en for English. *

* If you set the language parameter to * el, for Greek, then the city in the * results will more likely be returned as Αθήνα. *

* If the data provider does not have a value for Greek, the * result will be in a language that the provider does support. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetPlaceRequest withLanguage(String language) { this.language = language; return this; } /** *

* The identifier of the place to find. *

* * @return

* The identifier of the place to find. *

*/ public String getPlaceId() { return placeId; } /** *

* The identifier of the place to find. *

* * @param placeId

* The identifier of the place to find. *

*/ public void setPlaceId(String placeId) { this.placeId = placeId; } /** *

* The identifier of the place to find. *

* Returns a reference to this object so that method calls can be chained * together. * * @param placeId

* The identifier of the place to find. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetPlaceRequest withPlaceId(String placeId) { this.placeId = placeId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getIndexName() != null) sb.append("IndexName: " + getIndexName() + ","); if (getLanguage() != null) sb.append("Language: " + getLanguage() + ","); if (getPlaceId() != null) sb.append("PlaceId: " + getPlaceId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getIndexName() == null) ? 0 : getIndexName().hashCode()); hashCode = prime * hashCode + ((getLanguage() == null) ? 0 : getLanguage().hashCode()); hashCode = prime * hashCode + ((getPlaceId() == null) ? 0 : getPlaceId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetPlaceRequest == false) return false; GetPlaceRequest other = (GetPlaceRequest) obj; if (other.getIndexName() == null ^ this.getIndexName() == null) return false; if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == 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.getPlaceId() == null ^ this.getPlaceId() == null) return false; if (other.getPlaceId() != null && other.getPlaceId().equals(this.getPlaceId()) == false) return false; return true; } }