Class Hit
- 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 Description Hit()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Hit
addExprsEntry(String key, String value)
Hit
addFieldsEntry(String key, List<String> value)
Hit
addHighlightsEntry(String key, String value)
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.
-
-
-
Method Detail
-
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.
-
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.
-
withId
public Hit withId(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.- Returns:
- Returns a reference to this 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.
- Parameters:
fields
- The fields returned from a document that matches the search request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clearFieldsEntries
public Hit clearFieldsEntries()
Removes all the entries added into Fields. <p> 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.
- Parameters:
exprs
- The expressions returned from a document that matches the search request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clearExprsEntries
public Hit clearExprsEntries()
Removes all the entries added into Exprs. <p> 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.
- Parameters:
highlights
- The highlights returned from a document that matches the search request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clearHighlightsEntries
public Hit clearHighlightsEntries()
Removes all the entries added into Highlights. <p> 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-