Interface SuggestResultItem.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SuggestResultItem.Builder,SuggestResultItem>, SdkBuilder<SuggestResultItem.Builder,SuggestResultItem>, SdkPojo

Enclosing class:

SuggestResultItem

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

Method Summary

Modifier and Type	Method	Description
default SuggestResultItem.Builder	highlights(Consumer<SuggestHighlights.Builder> highlights)	Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.
SuggestResultItem.Builder	highlights(SuggestHighlights highlights)	Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.
default SuggestResultItem.Builder	place(Consumer<SuggestPlaceResult.Builder> place)	The suggested place by its unique ID.
SuggestResultItem.Builder	place(SuggestPlaceResult place)	The suggested place by its unique ID.
default SuggestResultItem.Builder	query(Consumer<SuggestQueryResult.Builder> query)	Sets the value of the Query property for this object.
SuggestResultItem.Builder	query(SuggestQueryResult query)	Sets the value of the Query property for this object.
SuggestResultItem.Builder	suggestResultItemType(String suggestResultItemType)	The result type.
SuggestResultItem.Builder	suggestResultItemType(SuggestResultItemType suggestResultItemType)	The result type.
SuggestResultItem.Builder	title(String title)	The display title that should be used when presenting this option to the end user.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

title

SuggestResultItem.Builder title(String title)

The display title that should be used when presenting this option to the end user.

Parameters:

title - The display title that should be used when presenting this option to the end user.

Returns:

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

suggestResultItemType

SuggestResultItem.Builder suggestResultItemType(String suggestResultItemType)

The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

Parameters:

suggestResultItemType - The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

Returns:

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

See Also:

• SuggestResultItemType
• SuggestResultItemType

suggestResultItemType

SuggestResultItem.Builder suggestResultItemType(SuggestResultItemType suggestResultItemType)

The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

Parameters:

suggestResultItemType - The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

Returns:

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

See Also:

• SuggestResultItemType
• SuggestResultItemType

place

SuggestResultItem.Builder place(SuggestPlaceResult place)

The suggested place by its unique ID.

Parameters:

place - The suggested place by its unique ID.

Returns:

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

place

default SuggestResultItem.Builder place(Consumer<SuggestPlaceResult.Builder> place)

The suggested place by its unique ID.

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

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

Parameters:

place - a consumer that will call methods on SuggestPlaceResult.Builder

Returns:

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

See Also:

• place(SuggestPlaceResult)

query

SuggestResultItem.Builder query(SuggestQueryResult query)

Sets the value of the Query property for this object.

Parameters:

query - The new value for the Query property for this object.

Returns:

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

query

default SuggestResultItem.Builder query(Consumer<SuggestQueryResult.Builder> query)

Sets the value of the Query property for this object. This is a convenience method that creates an instance of the SuggestQueryResult.Builder avoiding the need to create one manually via SuggestQueryResult.builder().

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

Parameters:

query - a consumer that will call methods on SuggestQueryResult.Builder

Returns:

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

See Also:

• query(SuggestQueryResult)

highlights

SuggestResultItem.Builder highlights(SuggestHighlights highlights)

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

Parameters:

highlights - Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

Returns:

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

highlights

default SuggestResultItem.Builder highlights(Consumer<SuggestHighlights.Builder> highlights)

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

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

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

Parameters:

highlights - a consumer that will call methods on SuggestHighlights.Builder

Returns:

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

See Also:

• highlights(SuggestHighlights)