Interface SuggestResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<SuggestResponse.Builder,SuggestResponse>, GeoPlacesResponse.Builder, SdkBuilder<SuggestResponse.Builder,SuggestResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

SuggestResponse

@Mutable
@NotThreadSafe
public static interface SuggestResponse.Builder
extends GeoPlacesResponse.Builder, SdkPojo, CopyableBuilder<SuggestResponse.Builder,SuggestResponse>

Method Summary

Modifier and Type	Method	Description
SuggestResponse.Builder	pricingBucket(String pricingBucket)	The pricing bucket for which the query is charged at.
SuggestResponse.Builder	queryRefinements(Collection<QueryRefinement> queryRefinements)	Maximum number of query terms to be returned for use with a search text query.
SuggestResponse.Builder	queryRefinements(Consumer<QueryRefinement.Builder>... queryRefinements)	Maximum number of query terms to be returned for use with a search text query.
SuggestResponse.Builder	queryRefinements(QueryRefinement... queryRefinements)	Maximum number of query terms to be returned for use with a search text query.
SuggestResponse.Builder	resultItems(Collection<SuggestResultItem> resultItems)	List of places or results returned for a query.
SuggestResponse.Builder	resultItems(Consumer<SuggestResultItem.Builder>... resultItems)	List of places or results returned for a query.
SuggestResponse.Builder	resultItems(SuggestResultItem... resultItems)	List of places or results returned for a query.

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

copy

Methods inherited from interface software.amazon.awssdk.services.geoplaces.model.GeoPlacesResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Method Details

pricingBucket

SuggestResponse.Builder pricingBucket(String pricingBucket)

The pricing bucket for which the query is charged at.

For more information on pricing, please visit Amazon Location Service Pricing.

Parameters:

pricingBucket - The pricing bucket for which the query is charged at.

For more information on pricing, please visit Amazon Location Service Pricing.

Returns:

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

resultItems

SuggestResponse.Builder resultItems(Collection<SuggestResultItem> resultItems)

List of places or results returned for a query.

Parameters:

resultItems - List of places or results returned for a query.

Returns:

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

resultItems

SuggestResponse.Builder resultItems(SuggestResultItem... resultItems)

List of places or results returned for a query.

Parameters:

resultItems - List of places or results returned for a query.

Returns:

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

resultItems

SuggestResponse.Builder resultItems(Consumer<SuggestResultItem.Builder>... resultItems)

List of places or results returned for a query.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resultItems(List<SuggestResultItem>).

Parameters:

resultItems - a consumer that will call methods on SuggestResultItem.Builder

Returns:

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

See Also:

• resultItems(java.util.Collection<SuggestResultItem>)

queryRefinements

SuggestResponse.Builder queryRefinements(Collection<QueryRefinement> queryRefinements)

Maximum number of query terms to be returned for use with a search text query.

Parameters:

queryRefinements - Maximum number of query terms to be returned for use with a search text query.

Returns:

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

queryRefinements

SuggestResponse.Builder queryRefinements(QueryRefinement... queryRefinements)

Maximum number of query terms to be returned for use with a search text query.

Parameters:

queryRefinements - Maximum number of query terms to be returned for use with a search text query.

Returns:

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

queryRefinements

SuggestResponse.Builder queryRefinements(Consumer<QueryRefinement.Builder>... queryRefinements)

Maximum number of query terms to be returned for use with a search text query.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryRefinements(List<QueryRefinement>).

Parameters:

queryRefinements - a consumer that will call methods on QueryRefinement.Builder

Returns:

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

See Also:

• queryRefinements(java.util.Collection<QueryRefinement>)