Hit (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Hit
extends Object
implements Serializable, Cloneable, StructuredPojo

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Hit`	`addExprsEntry(String key, String value)` Add a single Exprs entry
`Hit`	`addFieldsEntry(String key, List<String> value)` Add a single Fields entry
`Hit`	`addHighlightsEntry(String key, String value)` Add a single Highlights entry
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Hit
```
public Hit()
```
- 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.
  - addFieldsEntry
```
public Hit addFieldsEntry(String key,
                          List<String> value)
```
    Add a single Fields entry
    
    See Also:
    
    withFields(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearFieldsEntries
```
public Hit clearFieldsEntries()
```
    Removes all the entries added into Fields.
    
    Returns:
    
    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.
  - addExprsEntry
```
public Hit addExprsEntry(String key,
                         String value)
```
    Add a single Exprs entry
    
    See Also:
    
    withExprs(java.util.Map<java.lang.String, java.lang.String>)
  - clearExprsEntries
```
public Hit clearExprsEntries()
```
    Removes all the entries added into Exprs.
    
    Returns:
    
    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.
  - addHighlightsEntry
```
public Hit addHighlightsEntry(String key,
                              String value)
```
    Add a single Highlights entry
    
    See Also:
    
    withHighlights(java.util.Map<java.lang.String, java.lang.String>)
  - clearHighlightsEntries
```
public Hit clearHighlightsEntries()
```
    Removes all the entries added into Highlights.
    
    Returns:
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Hit clone()
```
    Overrides:
    
    clone in class Object
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class Hit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Hit

Method Detail

setId

getId

withId

getFields

setFields

withFields

addFieldsEntry

clearFieldsEntries

getExprs

setExprs

withExprs

addExprsEntry

clearExprsEntries

getHighlights

setHighlights

withHighlights

addHighlightsEntry

clearHighlightsEntries

toString

equals

hashCode

clone

marshall