Interface Hits.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Hits.Builder,
,Hits> SdkBuilder<Hits.Builder,
,Hits> SdkPojo
- Enclosing class:
Hits
-
Method Summary
Modifier and TypeMethodDescriptionA cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.The total number of documents that match the search request.hit
(Collection<Hit> hit) A document that matches the search request.hit
(Consumer<Hit.Builder>... hit) A document that matches the search request.A document that matches the search request.The index of the first matching document.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, sdkFields
-
Method Details
-
found
The total number of documents that match the search request.
- Parameters:
found
- The total number of documents that match the search request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
start
The index of the first matching document.
- Parameters:
start
- The index of the first matching document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cursor
A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.
- Parameters:
cursor
- A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hit
A document that matches the search request.
- Parameters:
hit
- A document that matches the search request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hit
A document that matches the search request.
- Parameters:
hit
- A document that matches the search request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hit
A document that matches the search request.
This is a convenience method that creates an instance of theHit.Builder
avoiding the need to create one manually viaHit.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohit(List<Hit>)
.- Parameters:
hit
- a consumer that will call methods onHit.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-