software.amazon.awssdk.services.location.model

Interface GetPlaceRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetPlaceRequest

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

Method Summary

Modifier and Type	Method and Description
GetPlaceRequest.Builder	indexName(String indexName) The name of the place index resource that you want to use for the search.
GetPlaceRequest.Builder	language(String language) The preferred language used to return results.
GetPlaceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetPlaceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetPlaceRequest.Builder	placeId(String placeId) The identifier of the place to find.

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

build

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

overrideConfiguration

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

indexName

GetPlaceRequest.Builder indexName(String indexName)

The name of the place index resource that you want to use for the search.

Parameters:

indexName - The name of the place index resource that you want to use for the search.

Returns:

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

language

GetPlaceRequest.Builder language(String language)

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Parameters:

language - The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Returns:

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

placeId

GetPlaceRequest.Builder placeId(String placeId)

The identifier of the place to find.

Parameters:

placeId - The identifier of the place to find.

Returns:

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

overrideConfiguration

GetPlaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder