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(value="software.amazon.awssdk:codegen")
public final class DescribePlaceIndexResponse
extends LocationResponse
implements ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribePlaceIndexResponse.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() The pricing plan selected for the specified place index resource.
String	pricingPlanAsString() The pricing plan selected for the specified place index resource.
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

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.

dataSource

public final String dataSource()

The data provider of geospatial data. Indicates one of the available providers:

• Esri

• Here

For additional details on data providers, see the Amazon Location Service data providers page.

Returns:

The data provider of geospatial data. Indicates one of the available providers:

• Esri

• Here

For additional details on data providers, see the Amazon Location Service data providers page.

dataSourceConfiguration

public final DataSourceConfiguration dataSourceConfiguration()

The specified data storage option for requesting Places.

Returns:

The specified data storage option for requesting Places.

description

public final String description()

The optional description for the place index resource.

Returns:

The optional description for the place index resource.

indexArn

public final String indexArn()

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

• 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 AWS.

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

indexName

public final String indexName()

The name of the place index resource being described.

Returns:

The name of the place index resource being described.

pricingPlan

public final PricingPlan pricingPlan()

The pricing plan selected for the specified place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

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:

The pricing plan selected for the specified place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

See Also:

PricingPlan

pricingPlanAsString

public final String pricingPlanAsString()

The pricing plan selected for the specified place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

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:

The pricing plan selected for the specified place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

See Also:

PricingPlan

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

Returns:

Tags associated with place index resource.

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.

toBuilder

public DescribePlaceIndexResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>

Overrides:

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