DescribePlaceIndexResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.location.model.DescribePlaceIndexResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribePlaceIndexResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribePlaceIndexResult()

Constructors
Constructor and Description
`DescribePlaceIndexResult()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DescribePlaceIndexResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`DescribePlaceIndexResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`DescribePlaceIndexResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreateTime()` The timestamp for when the place index resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`String`	`getDataSource()` The data provider of geospatial data.
`DataSourceConfiguration`	`getDataSourceConfiguration()` The specified data storage option for requesting Places.
`String`	`getDescription()` The optional description for the place index resource.
`String`	`getIndexArn()` The Amazon Resource Name (ARN) for the place index resource.
`String`	`getIndexName()` The name of the place index resource being described.
`String`	`getPricingPlan()` Deprecated.
`Map<String,String>`	`getTags()` Tags associated with place index resource.
`Date`	`getUpdateTime()` The timestamp for when the place index resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`int`	`hashCode()`
`void`	`setCreateTime(Date createTime)` The timestamp for when the place index resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`void`	`setDataSource(String dataSource)` The data provider of geospatial data.
`void`	`setDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)` The specified data storage option for requesting Places.
`void`	`setDescription(String description)` The optional description for the place index resource.
`void`	`setIndexArn(String indexArn)` The Amazon Resource Name (ARN) for the place index resource.
`void`	`setIndexName(String indexName)` The name of the place index resource being described.
`void`	`setPricingPlan(String pricingPlan)` Deprecated.
`void`	`setTags(Map<String,String> tags)` Tags associated with place index resource.
`void`	`setUpdateTime(Date updateTime)` The timestamp for when the place index resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`String`	`toString()` Returns a string representation of this object.
`DescribePlaceIndexResult`	`withCreateTime(Date createTime)` The timestamp for when the place index resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`DescribePlaceIndexResult`	`withDataSource(String dataSource)` The data provider of geospatial data.
`DescribePlaceIndexResult`	`withDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)` The specified data storage option for requesting Places.
`DescribePlaceIndexResult`	`withDescription(String description)` The optional description for the place index resource.
`DescribePlaceIndexResult`	`withIndexArn(String indexArn)` The Amazon Resource Name (ARN) for the place index resource.
`DescribePlaceIndexResult`	`withIndexName(String indexName)` The name of the place index resource being described.
`DescribePlaceIndexResult`	`withPricingPlan(PricingPlan pricingPlan)` Deprecated.
`DescribePlaceIndexResult`	`withPricingPlan(String pricingPlan)` Deprecated.
`DescribePlaceIndexResult`	`withTags(Map<String,String> tags)` Tags associated with place index resource.
`DescribePlaceIndexResult`	`withUpdateTime(Date updateTime)` The timestamp for when the place index resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribePlaceIndexResult
```
public DescribePlaceIndexResult()
```
- Method Detail
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    createTime - The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - getCreateTime
```
public Date getCreateTime()
```
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - withCreateTime
```
public DescribePlaceIndexResult withCreateTime(Date createTime)
```
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    createTime - The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataSource
```
public void setDataSource(String 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.
    Parameters:
    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.
  - getDataSource
```
public String getDataSource()
```
    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:
    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.
  - withDataSource
```
public DescribePlaceIndexResult withDataSource(String 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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataSourceConfiguration
```
public void setDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)
```
    The specified data storage option for requesting Places.
    
    Parameters:
    
    dataSourceConfiguration - The specified data storage option for requesting Places.
  - getDataSourceConfiguration
```
public DataSourceConfiguration getDataSourceConfiguration()
```
    The specified data storage option for requesting Places.
    
    Returns:
    
    The specified data storage option for requesting Places.
  - withDataSourceConfiguration
```
public DescribePlaceIndexResult withDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)
```
    The specified data storage option for requesting Places.
    
    Parameters:
    
    dataSourceConfiguration - The specified data storage option for requesting Places.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The optional description for the place index resource.
    
    Parameters:
    
    description - The optional description for the place index resource.
  - getDescription
```
public String getDescription()
```
    The optional description for the place index resource.
    
    Returns:
    
    The optional description for the place index resource.
  - withDescription
```
public DescribePlaceIndexResult withDescription(String description)
```
    The optional description for the place index resource.
    
    Parameters:
    
    description - The optional description for the place index resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexArn
```
public void setIndexArn(String 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
    Parameters:
    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
  - getIndexArn
```
public String getIndexArn()
```
    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:
    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
  - withIndexArn
```
public DescribePlaceIndexResult withIndexArn(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexName
```
public void setIndexName(String indexName)
```
    The name of the place index resource being described.
    
    Parameters:
    
    indexName - The name of the place index resource being described.
  - getIndexName
```
public String getIndexName()
```
    The name of the place index resource being described.
    
    Returns:
    
    The name of the place index resource being described.
  - withIndexName
```
public DescribePlaceIndexResult withIndexName(String indexName)
```
    The name of the place index resource being described.
    
    Parameters:
    
    indexName - The name of the place index resource being described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPricingPlan
```
@Deprecated
public void setPricingPlan(String pricingPlan)
```
    Deprecated.
    
    No longer used. Always returns RequestBasedUsage.
    
    Parameters:
    
    pricingPlan - No longer used. Always returns RequestBasedUsage.
    
    See Also:
    
    PricingPlan
  - getPricingPlan
```
@Deprecated
public String getPricingPlan()
```
    Deprecated.
    
    No longer used. Always returns RequestBasedUsage.
    
    Returns:
    
    No longer used. Always returns RequestBasedUsage.
    
    See Also:
    
    PricingPlan
  - withPricingPlan
```
@Deprecated
public DescribePlaceIndexResult withPricingPlan(String pricingPlan)
```
    Deprecated.
    
    No longer used. Always returns RequestBasedUsage.
    
    Parameters:
    
    pricingPlan - No longer used. Always returns RequestBasedUsage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PricingPlan
  - withPricingPlan
```
@Deprecated
public DescribePlaceIndexResult withPricingPlan(PricingPlan pricingPlan)
```
    Deprecated.
    
    No longer used. Always returns RequestBasedUsage.
    
    Parameters:
    
    pricingPlan - No longer used. Always returns RequestBasedUsage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PricingPlan
  - getTags
```
public Map<String,String> getTags()
```
    Tags associated with place index resource.
    
    Returns:
    
    Tags associated with place index resource.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tags associated with place index resource.
    
    Parameters:
    
    tags - Tags associated with place index resource.
  - withTags
```
public DescribePlaceIndexResult withTags(Map<String,String> tags)
```
    Tags associated with place index resource.
    
    Parameters:
    
    tags - Tags associated with place index resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public DescribePlaceIndexResult addTagsEntry(String key,
                                             String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public DescribePlaceIndexResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    updateTime - The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - getUpdateTime
```
public Date getUpdateTime()
```
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - withUpdateTime
```
public DescribePlaceIndexResult withUpdateTime(Date updateTime)
```
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    updateTime - The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribePlaceIndexResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribePlaceIndexResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribePlaceIndexResult

Method Detail

setCreateTime

getCreateTime

withCreateTime

setDataSource

getDataSource

withDataSource

setDataSourceConfiguration

getDataSourceConfiguration

withDataSourceConfiguration

setDescription

getDescription

withDescription

setIndexArn

getIndexArn

withIndexArn

setIndexName

getIndexName

withIndexName

setPricingPlan

getPricingPlan

withPricingPlan

withPricingPlan

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setUpdateTime

getUpdateTime

withUpdateTime

toString

equals

hashCode

clone