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

Class Hits

java.lang.Object

software.amazon.awssdk.services.cloudsearchdomain.model.Hits

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Hits.Builder,Hits>

@Generated("software.amazon.awssdk:codegen")
public class Hits
extends Object
implements StructuredPojo, ToCopyableBuilder<Hits.Builder,Hits>

The collection of documents that match the search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Hits.Builder

Method Summary

Modifier and Type	Method	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.
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()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

found

public Long found()

The total number of documents that match the search request.

Returns:

The total number of documents that match the search request.

start

public Long start()

The index of the first matching document.

Returns:

The index of the first matching document.

cursor

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.

Returns:

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

hit

public List<Hit> hit()

A document that matches the search request.

Returns:

A document that matches the search request.

toBuilder

public Hits.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Hits.Builder,Hits>

Returns:

a builder for type T

builder

public static Hits.Builder builder()

serializableBuilderClass

public static Class<? extends Hits.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.