software.amazon.awssdk.services.cloudsearchdomain.model

Class Hit

java.lang.Object

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

All Implemented Interfaces:

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

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

Information about a document that matches the search request.

See Also:

Serialized Form

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)
boolean	equalsBySdkFields(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)
boolean	hasExprs() Returns true if the Exprs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasFields() Returns true if the Fields property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasHighlights() Returns true if the Highlights property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
List<SdkField<?>>	sdkFields()
static Class<? extends Hit.Builder>	serializableBuilderClass()
Hit.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

id

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

hasFields

public final boolean hasFields()

Returns true if the Fields 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.

fields

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

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

Returns:

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

hasExprs

public final boolean hasExprs()

Returns true if the Exprs 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.

exprs

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

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

Returns:

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

hasHighlights

public final boolean hasHighlights()

Returns true if the Highlights 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.

highlights

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

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

Returns:

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

toBuilder

public Hit.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Hit.Builder,Hit>

builder

public static Hit.Builder builder()

serializableBuilderClass

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