Package co.elasticsearch.enterprisesearch.client.model.response.search

Class SearchApiResponse<T extends ResponseDocument>

java.lang.Object

co.elasticsearch.enterprisesearch.client.model.response.search.SearchApiResponse<T>

Type Parameters:

T - The type of document contained in the given engine

All Implemented Interfaces:

ErrorableResponse, Iterable<T>

public class SearchApiResponse<T extends ResponseDocument>
extends Object
implements Iterable<T>, ErrorableResponse

Represents the response from a search operation

Constructor Summary

Constructors

Constructor	Description
SearchApiResponse()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
void	forEach(Consumer<? super T> action)
List<String>	getErrors()	The errors associated with this response, if any
<F extends Facet> Optional<F>	getFacetByFieldAndName(String fieldName, String facetName, Class<F> facetType)	Get the Facet on the specified field, with the specified name, and type.
<F extends Facet> Optional<F>	getFacetByName(String facetName, Class<F> facetType)	Get the Facet on the specified field, with the specified name, and type.
List<Facet>	getFacets()	Get the facets
List<Facet>	getFacetsByField(String fieldName)	Get a list of Facets that are mapped to a specific field
Meta	getMeta()	Object delimiting the results meta data.
List<T>	getResults()	The documents returned by the request
int	hashCode()
boolean	isAlert()	Returns if there is 1 or more alerts for this response
boolean	isError()	Gets whether this response contains any errors from the requested operation
boolean	isWarning()	Returns if there is 1 or more warnings for this response
Iterator<T>	iterator()
SearchApiResponse<T>	setErrors(List<String> errors)	The errors associated with this response, if any
SearchApiResponse<T>	setFacetMap(Map<String,List<Facet>> facetMap)	Value and Range facets for the query
SearchApiResponse<T>	setMeta(Meta meta)	Object delimiting the results meta data.
SearchApiResponse<T>	setResults(List<T> results)	The documents returned by the request
Spliterator<T>	spliterator()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchApiResponse

public SearchApiResponse()

Method Detail

getFacets

public List<Facet> getFacets()

Get the facets

Returns:

The facets

getFacetsByField

public List<Facet> getFacetsByField(String fieldName)

Get a list of Facets that are mapped to a specific field

Parameters:

fieldName - The name of the field in the search document

Returns:

A list of facets

getFacetByName

public <F extends Facet> Optional<F> getFacetByName(String facetName,
                                                    Class<F> facetType)

Get the Facet on the specified field, with the specified name, and type. The facet

Type Parameters:

F - The type of facet expected. If the type does not match, it will return an empty Optional

Parameters:

facetName - The name of the facet

facetType - the type of the facet

Returns:

The facet if one is found, and is the correct class, or an empty Optional

getFacetByFieldAndName

public <F extends Facet> Optional<F> getFacetByFieldAndName(String fieldName,
                                                            String facetName,
                                                            Class<F> facetType)

Get the Facet on the specified field, with the specified name, and type. The facet

Type Parameters:

F - The type of facet expected. If the type does not match, it will return an empty Optional

Parameters:

fieldName - The name of the field in the search document

facetName - The name of the facet

facetType - The type of the facet

Returns:

The facet if one is found, and is the correct class, or an empty Optional

iterator

@NotNull
public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends ResponseDocument>

forEach

public void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T extends ResponseDocument>

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Iterable<T extends ResponseDocument>

isWarning

public boolean isWarning()

Returns if there is 1 or more warnings for this response

Returns:

true if there is at least 1 warning, otherwise false

isAlert

public boolean isAlert()

Returns if there is 1 or more alerts for this response

Returns:

true if there is at least 1 alert, otherwise false

isError

public boolean isError()

Description copied from interface: ErrorableResponse

Gets whether this response contains any errors from the requested operation

Specified by:

isError in interface ErrorableResponse

Returns:

true if 1 or more errors occurred, otherwise false

getMeta

public Meta getMeta()

Object delimiting the results meta data.

Returns:

the page metadata

getResults

public List<T> getResults()

The documents returned by the request

Returns:

the results

getErrors

public List<String> getErrors()

The errors associated with this response, if any

Returns:

the errors

setMeta

public SearchApiResponse<T> setMeta(Meta meta)

Object delimiting the results meta data.

Parameters:

meta - the page metadata

Returns:

this.

setResults

public SearchApiResponse<T> setResults(List<T> results)

The documents returned by the request

Parameters:

results - the results

Returns:

this.

setErrors

public SearchApiResponse<T> setErrors(List<String> errors)

The errors associated with this response, if any

Parameters:

errors - the errors

Returns:

this.

setFacetMap

public SearchApiResponse<T> setFacetMap(Map<String,List<Facet>> facetMap)

Value and Range facets for the query

Parameters:

facetMap - The facets to build on the search results

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object