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

* Creates a place index resource in your Amazon Web Services account. Use a * place index resource to geocode addresses and other text queries by using the * SearchPlaceIndexForText operation, and reverse geocode * coordinates by using the SearchPlaceIndexForPosition operation, * and enable autosuggestions by using the * SearchPlaceIndexForSuggestions operation. *

* *

* If your application is tracking or routing assets you use in your business, * such as delivery vehicles or employees, you must not use Esri as your * geolocation provider. See section 82 of the Amazon Web Services service * terms for more details. *

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

* Specifies the geospatial data provider for the new place index. *

* *

* This field is case-sensitive. Enter the valid values as shown. For * example, entering HERE returns an error. *

* *

* Valid values include: *

* *

* For additional information , see Data providers on the Amazon Location Service Developer * Guide. *

*/ private String dataSource; /** *

* Specifies the data storage option requesting Places. *

*/ private DataSourceConfiguration dataSourceConfiguration; /** *

* The optional description for the place index resource. *

*

* Constraints:
* Length: 0 - 1000
*/ private String description; /** *

* The name of the place index resource. *

*

* Requirements: *

* *

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

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement */ private String pricingPlan; /** *

* Applies one or more tags to the place index resource. A tag is a * key-value pair that helps you manage, identify, search, and filter your * resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* */ private java.util.Map tags; /** *

* Specifies the geospatial data provider for the new place index. *

* *

* This field is case-sensitive. Enter the valid values as shown. For * example, entering HERE returns an error. *

* *

* Valid values include: *

* *

* For additional information , see Data providers on the Amazon Location Service Developer * Guide. *

* * @return

* Specifies the geospatial data provider for the new place index. *

* *

* This field is case-sensitive. Enter the valid values as shown. * For example, entering HERE returns an error. *

* *

* Valid values include: *

* *

* For additional information , see Data providers on the Amazon Location Service Developer * Guide. *

*/ public String getDataSource() { return dataSource; } /** *

* Specifies the geospatial data provider for the new place index. *

* *

* This field is case-sensitive. Enter the valid values as shown. For * example, entering HERE returns an error. *

* *

* Valid values include: *

* *

* For additional information , see Data providers on the Amazon Location Service Developer * Guide. *

* * @param dataSource

* Specifies the geospatial data provider for the new place * index. *

* *

* This field is case-sensitive. Enter the valid values as shown. * For example, entering HERE returns an error. *

* *

* Valid values include: *

* *

* For additional information , see Data providers on the Amazon Location Service * Developer Guide. *

*/ public void setDataSource(String dataSource) { this.dataSource = dataSource; } /** *

* Specifies the geospatial data provider for the new place index. *

* *

* This field is case-sensitive. Enter the valid values as shown. For * example, entering HERE returns an error. *

* *

* Valid values include: *

* *

* For additional information , see Data providers on the Amazon Location Service Developer * Guide. *

*

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

* Specifies the geospatial data provider for the new place * index. *

* *

* This field is case-sensitive. Enter the valid values as shown. * For example, entering HERE returns an error. *

* *

* Valid values include: *

* *

* For additional information , see Data providers on the Amazon Location Service * Developer Guide. *

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

* Specifies the data storage option requesting Places. *

* * @return

* Specifies the data storage option requesting Places. *

*/ public DataSourceConfiguration getDataSourceConfiguration() { return dataSourceConfiguration; } /** *

* Specifies the data storage option requesting Places. *

* * @param dataSourceConfiguration

* Specifies the data storage option requesting Places. *

*/ public void setDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) { this.dataSourceConfiguration = dataSourceConfiguration; } /** *

* Specifies the data storage option requesting Places. *

*

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

* Specifies the data storage option requesting Places. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreatePlaceIndexRequest withDataSourceConfiguration( DataSourceConfiguration dataSourceConfiguration) { this.dataSourceConfiguration = dataSourceConfiguration; return this; } /** *

* The optional description for the place index resource. *

*

* Constraints:
* Length: 0 - 1000
* * @return

* The optional description for the place index resource. *

*/ public String getDescription() { return description; } /** *

* The optional description for the place index resource. *

*

* Constraints:
* Length: 0 - 1000
* * @param description

* The optional description for the place index resource. *

*/ public void setDescription(String description) { this.description = description; } /** *

* The optional description for the place index resource. *

*

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

* Constraints:
* Length: 0 - 1000
* * @param description

* The optional description for the place index resource. *

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

* The name of the place index resource. *

*

* Requirements: *

* *

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

* The name of the place index resource. *

*

* Requirements: *

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

* The name of the place index resource. *

*

* Requirements: *

* *

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

* The name of the place index resource. *

*

* Requirements: *

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

* The name of the place index resource. *

*

* Requirements: *

* *

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

*

* Requirements: *

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

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @return

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @see PricingPlan */ public String getPricingPlan() { return pricingPlan; } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @see PricingPlan */ public void setPricingPlan(String pricingPlan) { this.pricingPlan = pricingPlan; } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

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

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PricingPlan */ public CreatePlaceIndexRequest withPricingPlan(String pricingPlan) { this.pricingPlan = pricingPlan; return this; } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @see PricingPlan */ public void setPricingPlan(PricingPlan pricingPlan) { this.pricingPlan = pricingPlan.toString(); } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

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

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PricingPlan */ public CreatePlaceIndexRequest withPricingPlan(PricingPlan pricingPlan) { this.pricingPlan = pricingPlan.toString(); return this; } /** *

* Applies one or more tags to the place index resource. A tag is a * key-value pair that helps you manage, identify, search, and filter your * resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* * * @return

* Applies one or more tags to the place index resource. A tag is a * key-value pair that helps you manage, identify, search, and * filter your resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* */ public java.util.Map getTags() { return tags; } /** *

* Applies one or more tags to the place index resource. A tag is a * key-value pair that helps you manage, identify, search, and filter your * resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* * * @param tags

* Applies one or more tags to the place index resource. A tag is * a key-value pair that helps you manage, identify, search, and * filter your resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* */ public void setTags(java.util.Map tags) { this.tags = tags; } /** *

* Applies one or more tags to the place index resource. A tag is a * key-value pair that helps you manage, identify, search, and filter your * resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

*
    *
  • *

    * Maximum 50 tags per resource. *

    *
    • *
  • *

    * Each tag key must be unique and must have exactly one associated value. *

    *
    • *
  • *

    * Maximum key length: 128 Unicode characters in UTF-8. *

    *
    • *
  • *

    * Maximum value length: 256 Unicode characters in UTF-8. *

    *
    • *
  • *

    * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following * characters: + - = . _ : / @ *

    *
    • *
  • *

    * Cannot use "aws:" as a prefix for a key. *

    *
    • *
*

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

* Applies one or more tags to the place index resource. A tag is * a key-value pair that helps you manage, identify, search, and * filter your resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

*
    *
  • *

    * Maximum 50 tags per resource. *

    *
    • *
  • *

    * Each tag key must be unique and must have exactly one * associated value. *

    *
    • *
  • *

    * Maximum key length: 128 Unicode characters in UTF-8. *

    *
    • *
  • *

    * Maximum value length: 256 Unicode characters in UTF-8. *

    *
    • *
  • *

    * Can use alphanumeric characters (A–Z, a–z, 0–9), and the * following characters: + - = . _ : / @ *

    *
    • *
  • *

    * Cannot use "aws:" as a prefix for a key. *

    *
    • *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreatePlaceIndexRequest withTags(java.util.Map tags) { this.tags = tags; return this; } /** *

* Applies one or more tags to the place index resource. A tag is a * key-value pair that helps you manage, identify, search, and filter your * resources. *

*

* Format: "key" : "value" *

*

* Restrictions: *

*
    *
  • *

    * Maximum 50 tags per resource. *

    *
    • *
  • *

    * Each tag key must be unique and must have exactly one associated value. *

    *
    • *
  • *

    * Maximum key length: 128 Unicode characters in UTF-8. *

    *
    • *
  • *

    * Maximum value length: 256 Unicode characters in UTF-8. *

    *
    • *
  • *

    * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following * characters: + - = . _ : / @ *

    *
    • *
  • *

    * Cannot use "aws:" as a prefix for a key. *

    *
    • *
*

* The method adds a new key-value pair into Tags parameter, and returns a * reference to this object so that method calls can be chained together. * * @param key The key of the entry to be added into Tags. * @param value The corresponding value of the entry to be added into Tags. * @return A reference to this updated object so that method calls can be * chained together. */ public CreatePlaceIndexRequest addTagsEntry(String key, String value) { if (null == this.tags) { this.tags = new java.util.HashMap(); } if (this.tags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tags.put(key, value); return this; } /** * Removes all the entries added into Tags. *

* Returns a reference to this object so that method calls can be chained * together. */ public CreatePlaceIndexRequest clearTagsEntries() { this.tags = null; 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 (getDataSource() != null) sb.append("DataSource: " + getDataSource() + ","); if (getDataSourceConfiguration() != null) sb.append("DataSourceConfiguration: " + getDataSourceConfiguration() + ","); if (getDescription() != null) sb.append("Description: " + getDescription() + ","); if (getIndexName() != null) sb.append("IndexName: " + getIndexName() + ","); if (getPricingPlan() != null) sb.append("PricingPlan: " + getPricingPlan() + ","); if (getTags() != null) sb.append("Tags: " + getTags()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDataSource() == null) ? 0 : getDataSource().hashCode()); hashCode = prime * hashCode + ((getDataSourceConfiguration() == null) ? 0 : getDataSourceConfiguration() .hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getIndexName() == null) ? 0 : getIndexName().hashCode()); hashCode = prime * hashCode + ((getPricingPlan() == null) ? 0 : getPricingPlan().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreatePlaceIndexRequest == false) return false; CreatePlaceIndexRequest other = (CreatePlaceIndexRequest) obj; if (other.getDataSource() == null ^ this.getDataSource() == null) return false; if (other.getDataSource() != null && other.getDataSource().equals(this.getDataSource()) == false) return false; if (other.getDataSourceConfiguration() == null ^ this.getDataSourceConfiguration() == null) return false; if (other.getDataSourceConfiguration() != null && other.getDataSourceConfiguration().equals(this.getDataSourceConfiguration()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getIndexName() == null ^ this.getIndexName() == null) return false; if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == false) return false; if (other.getPricingPlan() == null ^ this.getPricingPlan() == null) return false; if (other.getPricingPlan() != null && other.getPricingPlan().equals(this.getPricingPlan()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } }