Interface RetrieveResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<RetrieveResponse.Builder,
,RetrieveResponse> KendraResponse.Builder
,SdkBuilder<RetrieveResponse.Builder,
,RetrieveResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
RetrieveResponse
public static interface RetrieveResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<RetrieveResponse.Builder,RetrieveResponse>
-
Method Summary
Modifier and TypeMethodDescriptionThe identifier of query used for the search.resultItems
(Collection<RetrieveResultItem> resultItems) The results of the retrieved relevant passages for the search.resultItems
(Consumer<RetrieveResultItem.Builder>... resultItems) The results of the retrieved relevant passages for the search.resultItems
(RetrieveResultItem... resultItems) The results of the retrieved relevant passages for the search.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.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, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
queryId
The identifier of query used for the search. You also use
QueryId
to identify the search when using the Submitfeedback API.- Parameters:
queryId
- The identifier of query used for the search. You also useQueryId
to identify the search when using the Submitfeedback API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultItems
The results of the retrieved relevant passages for the search.
- Parameters:
resultItems
- The results of the retrieved relevant passages for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultItems
The results of the retrieved relevant passages for the search.
- Parameters:
resultItems
- The results of the retrieved relevant passages for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultItems
The results of the retrieved relevant passages for the search.
This is a convenience method that creates an instance of theRetrieveResultItem.Builder
avoiding the need to create one manually viaRetrieveResultItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresultItems(List<RetrieveResultItem>)
.- Parameters:
resultItems
- a consumer that will call methods onRetrieveResultItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-