software.amazon.awssdk.services.cloudsearchdomain.model

Class Hits

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Hits.Builder,Hits>

@Generated(value="software.amazon.awssdk:codegen")
public final class Hits
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Hits.Builder,Hits>

The collection of documents that match the search request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Hits.Builder

Method Summary

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)
boolean	equalsBySdkFields(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()
boolean	hasHit() Returns true if the Hit property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<Hit>	hit() A document that matches the search request.
List<SdkField<?>>	sdkFields()
static Class<? extends Hits.Builder>	serializableBuilderClass()
Long	start() The index of the first matching document.
Hits.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

found

public final 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 final Long start()

The index of the first matching document.

Returns:

The index of the first matching document.

cursor

public final 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.

hasHit

public final boolean hasHit()

Returns true if the Hit property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

hit

public final List<Hit> hit()

A document that matches the search request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasHit() to see if a value was sent in this field.

Returns:

A document that matches the search request.

toBuilder

public Hits.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Hits.Builder,Hits>

builder

public static Hits.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo