com.amazonaws.services.location.model.DescribePlaceIndexResult 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribePlaceIndexResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The name of the place index resource being described.
*
*/
private String indexName;
/**
*
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
* Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
*
*
*
*/
private String indexArn;
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*/
@Deprecated
private String pricingPlan;
/**
*
* The optional description for the place index resource.
*
*/
private String description;
/**
*
* The timestamp for when the place index resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*/
private java.util.Date createTime;
/**
*
* The timestamp for when the place index resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*/
private java.util.Date updateTime;
/**
*
* The data provider of geospatial data. 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 specified data storage option for requesting Places.
*
*/
private DataSourceConfiguration dataSourceConfiguration;
/**
*
* Tags associated with place index resource.
*
*/
private java.util.Map tags;
/**
*
* The name of the place index resource being described.
*
*
* @param indexName
* The name of the place index resource being described.
*/
public void setIndexName(String indexName) {
this.indexName = indexName;
}
/**
*
* The name of the place index resource being described.
*
*
* @return The name of the place index resource being described.
*/
public String getIndexName() {
return this.indexName;
}
/**
*
* The name of the place index resource being described.
*
*
* @param indexName
* The name of the place index resource being described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlaceIndexResult withIndexName(String indexName) {
setIndexName(indexName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
* Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
*
*
*
*
* @param indexArn
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
* Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
*
*
*/
public void setIndexArn(String indexArn) {
this.indexArn = indexArn;
}
/**
*
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
* Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
*
*
*
*
* @return The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
* Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
*
*
*/
public String getIndexArn() {
return this.indexArn;
}
/**
*
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
* Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
*
*
*
*
* @param indexArn
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
* Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlaceIndexResult withIndexArn(String indexArn) {
setIndexArn(indexArn);
return this;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @return No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public String getPricingPlan() {
return this.pricingPlan;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public DescribePlaceIndexResult withPricingPlan(String pricingPlan) {
setPricingPlan(pricingPlan);
return this;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public DescribePlaceIndexResult 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 DescribePlaceIndexResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The timestamp for when the place index resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param createTime
* The timestamp for when the place index resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public void setCreateTime(java.util.Date createTime) {
this.createTime = createTime;
}
/**
*
* The timestamp for when the place index resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @return The timestamp for when the place index resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public java.util.Date getCreateTime() {
return this.createTime;
}
/**
*
* The timestamp for when the place index resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param createTime
* The timestamp for when the place index resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlaceIndexResult withCreateTime(java.util.Date createTime) {
setCreateTime(createTime);
return this;
}
/**
*
* The timestamp for when the place index resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param updateTime
* The timestamp for when the place index resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public void setUpdateTime(java.util.Date updateTime) {
this.updateTime = updateTime;
}
/**
*
* The timestamp for when the place index resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @return The timestamp for when the place index resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public java.util.Date getUpdateTime() {
return this.updateTime;
}
/**
*
* The timestamp for when the place index resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param updateTime
* The timestamp for when the place index resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlaceIndexResult withUpdateTime(java.util.Date updateTime) {
setUpdateTime(updateTime);
return this;
}
/**
*
* The data provider of geospatial data. 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 data provider of geospatial data. 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 data provider of geospatial data. Values can be one of the following:
*
*
* -
*
* Esri
*
*
* -
*
* Grab
*
*
* -
*
* Here
*
*
*
*
* For more information about data providers, see Amazon Location
* Service data providers.
*
*
* @return The data provider of geospatial data. 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 data provider of geospatial data. 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 data provider of geospatial data. 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 DescribePlaceIndexResult withDataSource(String dataSource) {
setDataSource(dataSource);
return this;
}
/**
*
* The specified data storage option for requesting Places.
*
*
* @param dataSourceConfiguration
* The specified data storage option for requesting Places.
*/
public void setDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) {
this.dataSourceConfiguration = dataSourceConfiguration;
}
/**
*
* The specified data storage option for requesting Places.
*
*
* @return The specified data storage option for requesting Places.
*/
public DataSourceConfiguration getDataSourceConfiguration() {
return this.dataSourceConfiguration;
}
/**
*
* The specified data storage option for requesting Places.
*
*
* @param dataSourceConfiguration
* The specified data storage option for requesting Places.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlaceIndexResult withDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) {
setDataSourceConfiguration(dataSourceConfiguration);
return this;
}
/**
*
* Tags associated with place index resource.
*
*
* @return Tags associated with place index resource.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* Tags associated with place index resource.
*
*
* @param tags
* Tags associated with place index resource.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* Tags associated with place index resource.
*
*
* @param tags
* Tags associated with place index resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePlaceIndexResult withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see DescribePlaceIndexResult#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public DescribePlaceIndexResult 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 DescribePlaceIndexResult 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 (getIndexArn() != null)
sb.append("IndexArn: ").append(getIndexArn()).append(",");
if (getPricingPlan() != null)
sb.append("PricingPlan: ").append(getPricingPlan()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getCreateTime() != null)
sb.append("CreateTime: ").append(getCreateTime()).append(",");
if (getUpdateTime() != null)
sb.append("UpdateTime: ").append(getUpdateTime()).append(",");
if (getDataSource() != null)
sb.append("DataSource: ").append(getDataSource()).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 DescribePlaceIndexResult == false)
return false;
DescribePlaceIndexResult other = (DescribePlaceIndexResult) obj;
if (other.getIndexName() == null ^ this.getIndexName() == null)
return false;
if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == false)
return false;
if (other.getIndexArn() == null ^ this.getIndexArn() == null)
return false;
if (other.getIndexArn() != null && other.getIndexArn().equals(this.getIndexArn()) == 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.getCreateTime() == null ^ this.getCreateTime() == null)
return false;
if (other.getCreateTime() != null && other.getCreateTime().equals(this.getCreateTime()) == false)
return false;
if (other.getUpdateTime() == null ^ this.getUpdateTime() == null)
return false;
if (other.getUpdateTime() != null && other.getUpdateTime().equals(this.getUpdateTime()) == 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.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 + ((getIndexArn() == null) ? 0 : getIndexArn().hashCode());
hashCode = prime * hashCode + ((getPricingPlan() == null) ? 0 : getPricingPlan().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getCreateTime() == null) ? 0 : getCreateTime().hashCode());
hashCode = prime * hashCode + ((getUpdateTime() == null) ? 0 : getUpdateTime().hashCode());
hashCode = prime * hashCode + ((getDataSource() == null) ? 0 : getDataSource().hashCode());
hashCode = prime * hashCode + ((getDataSourceConfiguration() == null) ? 0 : getDataSourceConfiguration().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public DescribePlaceIndexResult clone() {
try {
return (DescribePlaceIndexResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}