@Generated(value="software.amazon.awssdk:codegen") public final class Hits extends Object implements StructuredPojo, ToCopyableBuilder<Hits.Builder,Hits>
The collection of documents that match the search request.
Modifier and Type | Class and Description |
---|---|
static interface |
Hits.Builder |
Modifier and Type | Method and Description |
---|---|
static Hits.Builder |
builder() |
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.
|
boolean |
equals(Object obj) |
Long |
found()
The total number of documents that match the search request.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<Hit> |
hit()
A document that matches the search request.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
static Class<? extends Hits.Builder> |
serializableBuilderClass() |
Long |
start()
The index of the first matching document.
|
Hits.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public Long found()
The total number of documents that match the search request.
public Long start()
The index of the first matching document.
public 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.
public List<Hit> hit()
A document that matches the search request.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Hits.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Hits.Builder,Hits>
public static Hits.Builder builder()
public static Class<? extends Hits.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.