com.amazonaws.services.location.model.CreatePlaceIndexRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location Show documentation
/*
* Copyright 2019-2024 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreatePlaceIndexRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the place index resource.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*
*/
private String indexName;
/**
*
* 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:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your region of
* interest, see Esri
* details on geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information about
* GrabMaps' coverage, see GrabMaps countries
* and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage in
* your region of interest, see HERE details on
* goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store
* results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
*
*
*
*
* For additional information , see Data providers
* on the Amazon Location Service Developer Guide.
*
*/
private String dataSource;
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*/
@Deprecated
private String pricingPlan;
/**
*
* The optional description for the place index resource.
*
*/
private String description;
/**
*
* Specifies the data storage option requesting Places.
*
*/
private DataSourceConfiguration dataSourceConfiguration;
/**
*
* 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.
*
*
*
*/
private java.util.Map tags;
/**
*
* The name of the place index resource.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*
*
* @param indexName
* The name of the place index resource.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*/
public void setIndexName(String indexName) {
this.indexName = indexName;
}
/**
*
* The name of the place index resource.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*
*
* @return The name of the place index resource.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*/
public String getIndexName() {
return this.indexName;
}
/**
*
* The name of the place index resource.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*
*
* @param indexName
* The name of the place index resource.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlaceIndexRequest withIndexName(String indexName) {
setIndexName(indexName);
return this;
}
/**
*
* 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:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your region of
* interest, see Esri
* details on geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information about
* GrabMaps' coverage, see GrabMaps countries
* and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage in
* your region of interest, see HERE details on
* goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store
* results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
*
*
*
*
* 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:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your
* region of interest, see Esri details on
* geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information
* about GrabMaps'
* coverage, see GrabMaps
* countries and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies'
* coverage in your region of interest, see HERE
* details on goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location
* Service.
*
*
*
*
* 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:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your region of
* interest, see Esri
* details on geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information about
* GrabMaps' coverage, see GrabMaps countries
* and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage in
* your region of interest, see HERE details on
* goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store
* results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
*
*
*
*
* 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:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your
* region of interest, see Esri details on
* geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional
* information about GrabMaps' coverage, see
* GrabMaps
* countries and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies'
* coverage in your region of interest, see HERE
* details on goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location
* Service.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
*/
public String getDataSource() {
return this.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:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your region of
* interest, see Esri
* details on geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information about
* GrabMaps' coverage, see GrabMaps countries
* and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage in
* your region of interest, see HERE details on
* goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store
* results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
*
*
*
*
* 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:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your
* region of interest, see Esri details on
* geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information
* about GrabMaps'
* coverage, see GrabMaps
* countries and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies'
* coverage in your region of interest, see HERE
* details on goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location
* Service.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlaceIndexRequest withDataSource(String dataSource) {
setDataSource(dataSource);
return this;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @return No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public String getPricingPlan() {
return this.pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreatePlaceIndexRequest withPricingPlan(String pricingPlan) {
setPricingPlan(pricingPlan);
return this;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreatePlaceIndexRequest withPricingPlan(PricingPlan pricingPlan) {
this.pricingPlan = pricingPlan.toString();
return this;
}
/**
*
* The optional description for the place index resource.
*
*
* @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.
*
*
* @return The optional description for the place index resource.
*/
public String getDescription() {
return this.description;
}
/**
*
* The optional description for the place index resource.
*
*
* @param description
* The optional description for the place index resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlaceIndexRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* 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.
*
*
* @return Specifies the data storage option requesting Places.
*/
public DataSourceConfiguration getDataSourceConfiguration() {
return this.dataSourceConfiguration;
}
/**
*
* Specifies the data storage option requesting Places.
*
*
* @param dataSourceConfiguration
* Specifies the data storage option requesting Places.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlaceIndexRequest withDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) {
setDataSourceConfiguration(dataSourceConfiguration);
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.
*
*
*
*
* @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:
*
*
* -
*
* 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.
*
*
*/
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:
*
*
* -
*
* 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.
*
*
*
*
* @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.
*
*
*/
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.
*
*
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlaceIndexRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreatePlaceIndexRequest#withTags
* @returns a reference to this 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.
*
* @return 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. 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 (getIndexName() != null)
sb.append("IndexName: ").append(getIndexName()).append(",");
if (getDataSource() != null)
sb.append("DataSource: ").append(getDataSource()).append(",");
if (getPricingPlan() != null)
sb.append("PricingPlan: ").append(getPricingPlan()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getDataSourceConfiguration() != null)
sb.append("DataSourceConfiguration: ").append(getDataSourceConfiguration()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@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.getIndexName() == null ^ this.getIndexName() == null)
return false;
if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == false)
return false;
if (other.getDataSource() == null ^ this.getDataSource() == null)
return false;
if (other.getDataSource() != null && other.getDataSource().equals(this.getDataSource()) == 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.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == 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.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIndexName() == null) ? 0 : getIndexName().hashCode());
hashCode = prime * hashCode + ((getDataSource() == null) ? 0 : getDataSource().hashCode());
hashCode = prime * hashCode + ((getPricingPlan() == null) ? 0 : getPricingPlan().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getDataSourceConfiguration() == null) ? 0 : getDataSourceConfiguration().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreatePlaceIndexRequest clone() {
return (CreatePlaceIndexRequest) super.clone();
}
}