Interface SearchResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<SearchResponse.Builder,
,SearchResponse> SageMakerResponse.Builder
,SdkBuilder<SearchResponse.Builder,
,SearchResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
SearchResponse
@Mutable
@NotThreadSafe
public static interface SearchResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<SearchResponse.Builder,SearchResponse>
-
Method Summary
Modifier and TypeMethodDescriptionIf the result of the previousSearch
request was truncated, the response includes a NextToken.results
(Collection<SearchRecord> results) A list ofSearchRecord
objects.results
(Consumer<SearchRecord.Builder>... results) A list ofSearchRecord
objects.results
(SearchRecord... results) A list ofSearchRecord
objects.default SearchResponse.Builder
totalHits
(Consumer<TotalHits.Builder> totalHits) The total number of matching results.The total number of matching results.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.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
-
results
A list of
SearchRecord
objects.- Parameters:
results
- A list ofSearchRecord
objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
results
A list of
SearchRecord
objects.- Parameters:
results
- A list ofSearchRecord
objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
results
A list of
This is a convenience method that creates an instance of theSearchRecord
objects.SearchRecord.Builder
avoiding the need to create one manually viaSearchRecord.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresults(List<SearchRecord>)
.- Parameters:
results
- a consumer that will call methods onSearchRecord.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nextToken
If the result of the previous
Search
request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.- Parameters:
nextToken
- If the result of the previousSearch
request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
totalHits
The total number of matching results.
- Parameters:
totalHits
- The total number of matching results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
totalHits
The total number of matching results.
This is a convenience method that creates an instance of theTotalHits.Builder
avoiding the need to create one manually viaTotalHits.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tototalHits(TotalHits)
.- Parameters:
totalHits
- a consumer that will call methods onTotalHits.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-