software.amazon.awssdk.services.cloudsearchdomain.model

Class Hit

java.lang.Object

software.amazon.awssdk.services.cloudsearchdomain.model.Hit

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Hit.Builder,Hit>

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

Information about a document that matches the search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Hit.Builder

Method Summary

Modifier and Type	Method and Description
static Hit.Builder	builder()
boolean	equals(Object obj)
Map<String,String>	exprs() The expressions returned from a document that matches the search request.
Map<String,List<String>>	fields() The fields returned from a document that matches the search request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,String>	highlights() The highlights returned from a document that matches the search request.
String	id() The document ID of a document that matches the search request.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends Hit.Builder>	serializableBuilderClass()
Hit.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

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

copy

Method Detail

id

public String id()

The document ID of a document that matches the search request.

Returns:

The document ID of a document that matches the search request.

fields

public Map<String,List<String>> fields()

The fields returned from a document that matches the search request.

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

Returns:

The fields returned from a document that matches the search request.

exprs

public Map<String,String> exprs()

The expressions returned from a document that matches the search request.

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

Returns:

The expressions returned from a document that matches the search request.

highlights

public Map<String,String> highlights()

The highlights returned from a document that matches the search request.

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

Returns:

The highlights returned from a document that matches the search request.

toBuilder

public Hit.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<Hit.Builder,Hit>

Returns:

a builder for type T

builder

public static Hit.Builder builder()

serializableBuilderClass

public static Class<? extends Hit.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

getValueForField

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

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.