Package software.amazon.awssdk.services.location.model

Class DescribePlaceIndexResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.location.model.LocationResponse

software.amazon.awssdk.services.location.model.DescribePlaceIndexResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribePlaceIndexResponse
extends LocationResponse
implements ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribePlaceIndexResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribePlaceIndexResponse.Builder	builder()
Instant	createTime()	The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
String	dataSource()	The data provider of geospatial data.
DataSourceConfiguration	dataSourceConfiguration()	The specified data storage option for requesting Places.
String	description()	The optional description for the place index resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	indexArn()	The Amazon Resource Name (ARN) for the place index resource.
String	indexName()	The name of the place index resource being described.
PricingPlan	pricingPlan()	Deprecated. Deprecated.
String	pricingPlanAsString()	Deprecated. Deprecated.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribePlaceIndexResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Tags associated with place index resource.
DescribePlaceIndexResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	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 software.amazon.awssdk.services.location.model.LocationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

indexName

public final String indexName()

The name of the place index resource being described.

Returns:

The name of the place index resource being described.

indexArn

public final 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

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

pricingPlan

@Deprecated
public final PricingPlan pricingPlan()

Deprecated.

Deprecated. Always returns RequestBasedUsage.

No longer used. Always returns RequestBasedUsage.

If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

Returns:

No longer used. Always returns RequestBasedUsage.

See Also:

PricingPlan

pricingPlanAsString

@Deprecated
public final String pricingPlanAsString()

Deprecated.

Deprecated. Always returns RequestBasedUsage.

No longer used. Always returns RequestBasedUsage.

If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

Returns:

No longer used. Always returns RequestBasedUsage.

See Also:

PricingPlan

description

public final String description()

The optional description for the place index resource.

Returns:

The optional description for the place index resource.

createTime

public final Instant createTime()

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.

updateTime

public final Instant updateTime()

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.

dataSource

public final 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.

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.

dataSourceConfiguration

public final DataSourceConfiguration dataSourceConfiguration()

The specified data storage option for requesting Places.

Returns:

The specified data storage option for requesting Places.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

Tags associated with place index resource.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Tags associated with place index resource.

toBuilder

public DescribePlaceIndexResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribePlaceIndexResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribePlaceIndexResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo