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

Interface CreatePlaceIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreatePlaceIndexRequest.Builder,CreatePlaceIndexRequest>, LocationRequest.Builder, SdkBuilder<CreatePlaceIndexRequest.Builder,CreatePlaceIndexRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreatePlaceIndexRequest

public static interface CreatePlaceIndexRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<CreatePlaceIndexRequest.Builder,CreatePlaceIndexRequest>

Method Summary

Modifier and Type	Method	Description
CreatePlaceIndexRequest.Builder	dataSource(String dataSource)	Specifies the geospatial data provider for the new place index.
default CreatePlaceIndexRequest.Builder	dataSourceConfiguration(Consumer<DataSourceConfiguration.Builder> dataSourceConfiguration)	Specifies the data storage option requesting Places.
CreatePlaceIndexRequest.Builder	dataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)	Specifies the data storage option requesting Places.
CreatePlaceIndexRequest.Builder	description(String description)	The optional description for the place index resource.
CreatePlaceIndexRequest.Builder	indexName(String indexName)	The name of the place index resource.
CreatePlaceIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreatePlaceIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreatePlaceIndexRequest.Builder	pricingPlan(String pricingPlan)	Deprecated. Deprecated.
CreatePlaceIndexRequest.Builder	pricingPlan(PricingPlan pricingPlan)	Deprecated. Deprecated.
CreatePlaceIndexRequest.Builder	tags(Map<String,String> tags)	Applies one or more tags to the place index resource.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

dataSource

CreatePlaceIndexRequest.Builder dataSource(String dataSource)

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.

• Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.

  If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

Parameters:

dataSource - Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.

• Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.

  If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

Returns:

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

dataSourceConfiguration

CreatePlaceIndexRequest.Builder dataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)

Specifies the data storage option requesting Places.

Parameters:

dataSourceConfiguration - Specifies the data storage option requesting Places.

Returns:

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

dataSourceConfiguration

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

Specifies the data storage option 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

CreatePlaceIndexRequest.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.

indexName

CreatePlaceIndexRequest.Builder indexName(String indexName)

The name of the place index resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

Parameters:

indexName - The name of the place index resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

Returns:

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

pricingPlan

@Deprecated
CreatePlaceIndexRequest.Builder pricingPlan(String pricingPlan)

Deprecated.

Deprecated. If included, the only allowed value is RequestBasedUsage.

No longer used. If included, the only allowed value is RequestBasedUsage.

Parameters:

pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

Returns:

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

See Also:

PricingPlan, PricingPlan

pricingPlan

@Deprecated
CreatePlaceIndexRequest.Builder pricingPlan(PricingPlan pricingPlan)

Deprecated.

Deprecated. If included, the only allowed value is RequestBasedUsage.

No longer used. If included, the only allowed value is RequestBasedUsage.

Parameters:

pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

Returns:

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

See Also:

PricingPlan, PricingPlan

tags

CreatePlaceIndexRequest.Builder tags(Map<String,String> tags)

Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.

• Each tag key must be unique and must have exactly one associated value.

• Maximum key length: 128 Unicode characters in UTF-8.

• Maximum value length: 256 Unicode characters in UTF-8.

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

• Cannot use "aws:" as a prefix for a key.

Parameters:

tags - Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.

• Each tag key must be unique and must have exactly one associated value.

• Maximum key length: 128 Unicode characters in UTF-8.

• Maximum value length: 256 Unicode characters in UTF-8.

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

• Cannot use "aws:" as a prefix for a key.

Returns:

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

overrideConfiguration

CreatePlaceIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreatePlaceIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder