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 Type	Method	Description
SearchResponse.Builder	nextToken(String nextToken)	If the result of the previous Search request was truncated, the response includes a NextToken.
SearchResponse.Builder	results(Collection<SearchRecord> results)	A list of SearchRecord objects.
SearchResponse.Builder	results(Consumer<SearchRecord.Builder>... results)	A list of SearchRecord objects.
SearchResponse.Builder	results(SearchRecord... results)	A list of SearchRecord objects.
default SearchResponse.Builder	totalHits(Consumer<TotalHits.Builder> totalHits)	The total number of matching results.
SearchResponse.Builder	totalHits(TotalHits totalHits)	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

SearchResponse.Builder results(Collection<SearchRecord> results)

A list of SearchRecord objects.

Parameters:

results - A list of SearchRecord objects.

Returns:

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

results

SearchResponse.Builder results(SearchRecord... results)

A list of SearchRecord objects.

Parameters:

results - A list of SearchRecord objects.

Returns:

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

results

SearchResponse.Builder results(Consumer<SearchRecord.Builder>... results)

A list of SearchRecord objects.

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

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

Parameters:

results - a consumer that will call methods on SearchRecord.Builder

Returns:

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

See Also:

• results(java.util.Collection<SearchRecord>)

nextToken

SearchResponse.Builder nextToken(String 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 previous Search 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

SearchResponse.Builder totalHits(TotalHits 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

default SearchResponse.Builder totalHits(Consumer<TotalHits.Builder> totalHits)

The total number of matching results.

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

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

Parameters:

totalHits - a consumer that will call methods on TotalHits.Builder

Returns:

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

See Also:

• totalHits(TotalHits)