/* * 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; public class DescribePlaceIndexResult implements Serializable { /** *
* The timestamp for when the place index resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* 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; /** ** The optional description for the place index resource. *
*
* Constraints:
* Length: 0 - 1000
*/
private String description;
/**
*
* 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
*
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0
* -9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$
*/
private String indexArn;
/**
*
* The name of the place index resource being described. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*/
private String indexName;
/**
*
* No longer used. Always returns RequestBasedUsage
.
*
* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking,
* MobileAssetManagement
*/
private String pricingPlan;
/**
*
* Tags associated with place index resource. *
*/ private java.util.Map
* The timestamp for when the place index resource was last updated in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the place index resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the place index resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the place index resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the place index resource was created in
* ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the place index resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param createTime
* The timestamp for when the place index resource was created in
* ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* 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 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. *
*/ 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public DescribePlaceIndexResult withDataSource(String dataSource) { this.dataSource = dataSource; return this; } /** ** The specified data storage option for requesting Places. *
* * @return* The specified data storage option for requesting Places. *
*/ public DataSourceConfiguration getDataSourceConfiguration() { return dataSourceConfiguration; } /** ** 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param dataSourceConfiguration
* The specified data storage option for requesting Places. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribePlaceIndexResult 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 DescribePlaceIndexResult withDescription(String description) { this.description = description; 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
*
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0
* -9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$
*
* @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
*
* 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
*
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0
* -9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$
*
* @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
*
* 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
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0
* -9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$
*
* @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
*
* The name of the place index resource being described. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*
* @return
* The name of the place index resource being described. *
*/ public String getIndexName() { return indexName; } /** ** The name of the place index resource being described. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*
* @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. *
** 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 being described. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribePlaceIndexResult withIndexName(String indexName) { this.indexName = indexName; return this; } /** *
* No longer used. Always returns RequestBasedUsage
.
*
* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking,
* MobileAssetManagement
*
* @return
* No longer used. Always returns RequestBasedUsage
.
*
* No longer used. Always returns RequestBasedUsage
.
*
* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking,
* MobileAssetManagement
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage
.
*
* No longer used. Always returns 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. Always returns RequestBasedUsage
.
*
* No longer used. Always returns RequestBasedUsage
.
*
* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking,
* MobileAssetManagement
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage
.
*
* No longer used. Always returns 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. Always returns RequestBasedUsage
.
*
* Tags associated with place index resource. *
* * @return* Tags associated with place index resource. *
*/ public java.util.Map* Tags associated with place index resource. *
* * @param tags* Tags associated with place index resource. *
*/ public void setTags(java.util.Map* Tags associated with place index resource. *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* Tags associated with place index resource. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribePlaceIndexResult withTags(java.util.Map* Tags associated with place index resource. *
*
* 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 DescribePlaceIndexResult addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public DescribePlaceIndexResult clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* The timestamp for when the place index resource was last updated in ISO
* 8601 format:
* The timestamp for when the place index resource was last updated
* in ISO
* 8601 format:
* The timestamp for when the place index resource was last updated in ISO
* 8601 format:
* The timestamp for when the place index resource was last
* updated in ISO
* 8601 format:
* The timestamp for when the place index resource was last updated in ISO
* 8601 format:
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param updateTime
* The timestamp for when the place index resource was last
* updated in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
*