SearchResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cloudsearchdomain.model.SearchResult

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable
```
The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchResult()

Constructors
Constructor and Description
`SearchResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchResult`	`addFacetsEntry(String key, BucketInfo value)`
`SearchResult`	`addStatsEntry(String key, FieldStats value)`
`SearchResult`	`clearFacetsEntries()` Removes all the entries added into Facets.
`SearchResult`	`clearStatsEntries()` Removes all the entries added into Stats.
`SearchResult`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,BucketInfo>`	`getFacets()` The requested facet information.
`Hits`	`getHits()` The documents that match the search criteria.
`Map<String,FieldStats>`	`getStats()` The requested field statistics information.
`SearchStatus`	`getStatus()` The status information returned for the search request.
`int`	`hashCode()`
`void`	`setFacets(Map<String,BucketInfo> facets)` The requested facet information.
`void`	`setHits(Hits hits)` The documents that match the search criteria.
`void`	`setStats(Map<String,FieldStats> stats)` The requested field statistics information.
`void`	`setStatus(SearchStatus status)` The status information returned for the search request.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SearchResult`	`withFacets(Map<String,BucketInfo> facets)` The requested facet information.
`SearchResult`	`withHits(Hits hits)` The documents that match the search criteria.
`SearchResult`	`withStats(Map<String,FieldStats> stats)` The requested field statistics information.
`SearchResult`	`withStatus(SearchStatus status)` The status information returned for the search request.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - SearchResult
```
public SearchResult()
```
- Method Detail
  - setStatus
```
public void setStatus(SearchStatus status)
```
    The status information returned for the search request.
    
    Parameters:
    
    status - The status information returned for the search request.
  - getStatus
```
public SearchStatus getStatus()
```
    The status information returned for the search request.
    
    Returns:
    
    The status information returned for the search request.
  - withStatus
```
public SearchResult withStatus(SearchStatus status)
```
    The status information returned for the search request.
    
    Parameters:
    
    status - The status information returned for the search request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHits
```
public void setHits(Hits hits)
```
    The documents that match the search criteria.
    
    Parameters:
    
    hits - The documents that match the search criteria.
  - getHits
```
public Hits getHits()
```
    The documents that match the search criteria.
    
    Returns:
    
    The documents that match the search criteria.
  - withHits
```
public SearchResult withHits(Hits hits)
```
    The documents that match the search criteria.
    
    Parameters:
    
    hits - The documents that match the search criteria.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFacets
```
public Map<String,BucketInfo> getFacets()
```
    The requested facet information.
    
    Returns:
    
    The requested facet information.
  - setFacets
```
public void setFacets(Map<String,BucketInfo> facets)
```
    The requested facet information.
    
    Parameters:
    
    facets - The requested facet information.
  - withFacets
```
public SearchResult withFacets(Map<String,BucketInfo> facets)
```
    The requested facet information.
    
    Parameters:
    
    facets - The requested facet information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addFacetsEntry
```
public SearchResult addFacetsEntry(String key,
                                   BucketInfo value)
```
  - clearFacetsEntries
```
public SearchResult clearFacetsEntries()
```
    Removes all the entries added into Facets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStats
```
public Map<String,FieldStats> getStats()
```
    The requested field statistics information.
    
    Returns:
    
    The requested field statistics information.
  - setStats
```
public void setStats(Map<String,FieldStats> stats)
```
    The requested field statistics information.
    
    Parameters:
    
    stats - The requested field statistics information.
  - withStats
```
public SearchResult withStats(Map<String,FieldStats> stats)
```
    The requested field statistics information.
    
    Parameters:
    
    stats - The requested field statistics information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addStatsEntry
```
public SearchResult addStatsEntry(String key,
                                  FieldStats value)
```
  - clearStatsEntries
```
public SearchResult clearStatsEntries()
```
    Removes all the entries added into Stats.
    
    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; useful for testing and debugging.
    
    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 SearchResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class SearchResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

SearchResult

Method Detail

setStatus

getStatus

withStatus

setHits

getHits

withHits

getFacets

setFacets

withFacets

addFacetsEntry

clearFacetsEntries

getStats

setStats

withStats

addStatsEntry

clearStatsEntries

toString

equals

hashCode

clone