Hit (AWS SDK For Java for OSGi 1.10.4 API)

java.lang.Object
- com.amazonaws.services.cloudsearchdomain.model.Hit

All Implemented Interfaces:

Serializable, Cloneable
```
public class Hit
extends Object
implements Serializable, Cloneable
```
Information about a document that matches the search request.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Hit()

Constructors
Constructor and Description
`Hit()`

Method Summary

Methods
Modifier and Type	Method and Description
`Hit`	`addExprsEntry(String key, String value)` The expressions returned from a document that matches the search request.
`Hit`	`addFieldsEntry(String key, List<String> value)` The fields returned from a document that matches the search request.
`Hit`	`addHighlightsEntry(String key, String value)` The highlights returned from a document that matches the search request.
`Hit`	`clearExprsEntries()` Removes all the entries added into Exprs.
`Hit`	`clearFieldsEntries()` Removes all the entries added into Fields.
`Hit`	`clearHighlightsEntries()` Removes all the entries added into Highlights.
`Hit`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getExprs()` The expressions returned from a document that matches the search request.
`Map<String,List<String>>`	`getFields()` The fields returned from a document that matches the search request.
`Map<String,String>`	`getHighlights()` The highlights returned from a document that matches the search request.
`String`	`getId()` The document ID of a document that matches the search request.
`int`	`hashCode()`
`void`	`setExprs(Map<String,String> exprs)` The expressions returned from a document that matches the search request.
`void`	`setFields(Map<String,List<String>> fields)` The fields returned from a document that matches the search request.
`void`	`setHighlights(Map<String,String> highlights)` The highlights returned from a document that matches the search request.
`void`	`setId(String id)` The document ID of a document that matches the search request.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Hit`	`withExprs(Map<String,String> exprs)` The expressions returned from a document that matches the search request.
`Hit`	`withFields(Map<String,List<String>> fields)` The fields returned from a document that matches the search request.
`Hit`	`withHighlights(Map<String,String> highlights)` The highlights returned from a document that matches the search request.
`Hit`	`withId(String id)` The document ID of a document that matches the search request.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Hit
```
public Hit()
```
- Method Detail
  - getId
```
public String getId()
```
    The document ID of a document that matches the search request.
    
    Returns:
    The document ID of a document that matches the search request.
  - setId
```
public void setId(String id)
```
    The document ID of a document that matches the search request.
    
    Parameters:
    id - The document ID of a document that matches the search request.
  - withId
```
public Hit withId(String id)
```
    The document ID of a document that matches the search request.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    id - The document ID of a document that matches the search request.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getFields
```
public Map<String,List<String>> getFields()
```
    The fields returned from a document that matches the search request.
    
    Returns:
    The fields returned from a document that matches the search request.
  - setFields
```
public void setFields(Map<String,List<String>> fields)
```
    The fields returned from a document that matches the search request.
    
    Parameters:
    fields - The fields returned from a document that matches the search request.
  - withFields
```
public Hit withFields(Map<String,List<String>> fields)
```
    The fields returned from a document that matches the search request.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    fields - The fields returned from a document that matches the search request.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addFieldsEntry
```
public Hit addFieldsEntry(String key,
                 List<String> value)
```
    The fields returned from a document that matches the search request.
    The method adds a new key-value pair into Fields parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    key - The key of the entry to be added into Fields.
    value - The corresponding value of the entry to be added into Fields.
  - clearFieldsEntries
```
public Hit clearFieldsEntries()
```
    Removes all the entries added into Fields.
    Returns a reference to this object so that method calls can be chained together.
  - getExprs
```
public Map<String,String> getExprs()
```
    The expressions returned from a document that matches the search request.
    
    Returns:
    The expressions returned from a document that matches the search request.
  - setExprs
```
public void setExprs(Map<String,String> exprs)
```
    The expressions returned from a document that matches the search request.
    
    Parameters:
    exprs - The expressions returned from a document that matches the search request.
  - withExprs
```
public Hit withExprs(Map<String,String> exprs)
```
    The expressions returned from a document that matches the search request.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    exprs - The expressions returned from a document that matches the search request.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addExprsEntry
```
public Hit addExprsEntry(String key,
                String value)
```
    The expressions returned from a document that matches the search request.
    The method adds a new key-value pair into Exprs parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    key - The key of the entry to be added into Exprs.
    value - The corresponding value of the entry to be added into Exprs.
  - clearExprsEntries
```
public Hit clearExprsEntries()
```
    Removes all the entries added into Exprs.
    Returns a reference to this object so that method calls can be chained together.
  - getHighlights
```
public Map<String,String> getHighlights()
```
    The highlights returned from a document that matches the search request.
    
    Returns:
    The highlights returned from a document that matches the search request.
  - setHighlights
```
public void setHighlights(Map<String,String> highlights)
```
    The highlights returned from a document that matches the search request.
    
    Parameters:
    highlights - The highlights returned from a document that matches the search request.
  - withHighlights
```
public Hit withHighlights(Map<String,String> highlights)
```
    The highlights returned from a document that matches the search request.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    highlights - The highlights returned from a document that matches the search request.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addHighlightsEntry
```
public Hit addHighlightsEntry(String key,
                     String value)
```
    The highlights returned from a document that matches the search request.
    The method adds a new key-value pair into Highlights parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    key - The key of the entry to be added into Highlights.
    value - The corresponding value of the entry to be added into Highlights.
  - clearHighlightsEntries
```
public Hit clearHighlightsEntries()
```
    Removes all the entries added into Highlights.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public Hit clone()
```
    Overrides:
    
    clone in class Object

Class Hit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Hit

Method Detail

getId

setId

withId

getFields

setFields

withFields

addFieldsEntry

clearFieldsEntries

getExprs

setExprs

withExprs

addExprsEntry

clearExprsEntries

getHighlights

setHighlights

withHighlights

addHighlightsEntry

clearHighlightsEntries

toString

hashCode

equals

clone