software.amazon.awssdk.services.location.model

Interface DescribePlaceIndexResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>, LocationResponse.Builder, SdkBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribePlaceIndexResponse

public static interface DescribePlaceIndexResponse.Builder
extends LocationResponse.Builder, SdkPojo, CopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>

Method Summary

Modifier and Type	Method and Description
DescribePlaceIndexResponse.Builder	createTime(Instant createTime) The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
DescribePlaceIndexResponse.Builder	dataSource(String dataSource) The data provider of geospatial data.
default DescribePlaceIndexResponse.Builder	dataSourceConfiguration(Consumer<DataSourceConfiguration.Builder> dataSourceConfiguration) The specified data storage option for requesting Places.
DescribePlaceIndexResponse.Builder	dataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) The specified data storage option for requesting Places.
DescribePlaceIndexResponse.Builder	description(String description) The optional description for the place index resource.
DescribePlaceIndexResponse.Builder	indexArn(String indexArn) The Amazon Resource Name (ARN) for the place index resource.
DescribePlaceIndexResponse.Builder	indexName(String indexName) The name of the place index resource being described.
DescribePlaceIndexResponse.Builder	pricingPlan(PricingPlan pricingPlan) Deprecated. Deprecated. Always returns RequestBasedUsage.
DescribePlaceIndexResponse.Builder	pricingPlan(String pricingPlan) Deprecated. Deprecated. Always returns RequestBasedUsage.
DescribePlaceIndexResponse.Builder	tags(Map<String,String> tags) Tags associated with place index resource.
DescribePlaceIndexResponse.Builder	updateTime(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 interface software.amazon.awssdk.services.location.model.LocationResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

createTime

DescribePlaceIndexResponse.Builder createTime(Instant 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.

dataSource

DescribePlaceIndexResponse.Builder dataSource(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.

dataSourceConfiguration

DescribePlaceIndexResponse.Builder dataSourceConfiguration(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.

dataSourceConfiguration

default DescribePlaceIndexResponse.Builder dataSourceConfiguration(Consumer<DataSourceConfiguration.Builder> dataSourceConfiguration)

The specified data storage option for requesting Places.

This is a convenience method that creates an instance of the DataSourceConfiguration.Builder avoiding the need to create one manually via DataSourceConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSourceConfiguration(DataSourceConfiguration).

Parameters:

dataSourceConfiguration - a consumer that will call methods on DataSourceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dataSourceConfiguration(DataSourceConfiguration)

description

DescribePlaceIndexResponse.Builder description(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.

indexArn

DescribePlaceIndexResponse.Builder indexArn(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

indexName

DescribePlaceIndexResponse.Builder indexName(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.

pricingPlan

@Deprecated
DescribePlaceIndexResponse.Builder pricingPlan(String pricingPlan)

Deprecated. Deprecated. Always returns RequestBasedUsage.

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, PricingPlan

pricingPlan

@Deprecated
DescribePlaceIndexResponse.Builder pricingPlan(PricingPlan pricingPlan)

Deprecated. Deprecated. Always returns RequestBasedUsage.

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, PricingPlan

tags

DescribePlaceIndexResponse.Builder tags(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.

updateTime

DescribePlaceIndexResponse.Builder updateTime(Instant 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.