java.lang.Object
- software.amazon.awssdk.services.cloudsearchdomain.model.Hit

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Hit.Builder,Hit>
```
@Generated("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 Description

static interface Hit.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`	For responses, this returns true if the service returned a value for the Exprs property.
`boolean`	`hasFields()`	For responses, this returns true if the service returned a value for the Fields property.
`int`	`hashCode()`
`boolean`	`hasHighlights()`	For responses, this returns true if the service returned a value for the Highlights property.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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()
```
    For responses, this returns true if the service returned a value for the Fields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFields() method.
    
    Returns:
    
    The fields returned from a document that matches the search request.
  - hasExprs
```
public final boolean hasExprs()
```
    For responses, this returns true if the service returned a value for the Exprs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExprs() method.
    
    Returns:
    
    The expressions returned from a document that matches the search request.
  - hasHighlights
```
public final boolean hasHighlights()
```
    For responses, this returns true if the service returned a value for the Highlights property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHighlights() method.
    
    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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Hit

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

hasFields

fields

hasExprs

exprs

hasHighlights

highlights

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField