Package software.amazon.awssdk.services.cloudsearchdomain.model

Interface Hits.Builder

All Superinterfaces:

CopyableBuilder<Hits.Builder,Hits>, SdkBuilder<Hits.Builder,Hits>

Enclosing class:

Hits

public static interface Hits.Builder
extends CopyableBuilder<Hits.Builder,Hits>

Method Summary

Modifier and Type	Method	Description
Hits.Builder	cursor(String 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.
Hits.Builder	found(Long found)	The total number of documents that match the search request.
Hits.Builder	hit(Collection<Hit> hit)	A document that matches the search request.
Hits.Builder	hit(Hit... hit)	A document that matches the search request.
Hits.Builder	start(Long start)	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

apply, build

Method Detail

found

Hits.Builder found(Long 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

Hits.Builder start(Long 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

Hits.Builder cursor(String 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

Hits.Builder hit(Collection<Hit> 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

Hits.Builder hit(Hit... hit)

A document that matches the search request.

NOTE: This method appends the values to the existing list (if any). Use #setHit(java.util.Collection) or #withHit(java.util.Collection) if you want to override the existing values.

Parameters:

hit - A document that matches the search request.

Returns:

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