io.searchbox.client

Class JestResult

java.lang.Object

io.searchbox.client.JestResult

Direct Known Subclasses:

BulkResult, CatResult, CountResult, DocumentExistsResult, DocumentResult, MultiSearchResult, SearchResult, UpdateByQueryResult

public class JestResult
extends Object

Author:

Dogukan Sonmez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JestResult.MetaField

Field Summary

Fields

Modifier and Type	Field and Description
protected String	errorMessage
static String	ES_METADATA_ID
static String	ES_METADATA_VERSION
protected com.google.gson.Gson	gson
protected boolean	isSucceeded
protected com.google.gson.JsonObject	jsonObject
protected String	jsonString
protected static com.google.common.collect.ImmutableList<JestResult.MetaField>	META_FIELDS
protected String	pathToResult
protected int	responseCode

Constructor Summary

Constructors

Constructor and Description
JestResult(com.google.gson.Gson gson)
JestResult(JestResult source)

Method Summary

Modifier and Type	Method and Description
protected <T> T	createSourceObject(com.google.gson.JsonElement source, Class<T> type)
protected List<com.google.gson.JsonElement>	extractSource()
protected List<com.google.gson.JsonElement>	extractSource(boolean addEsMetadataFields)
String	getErrorMessage()
Map	getJsonMap() Deprecated.
com.google.gson.JsonObject	getJsonObject()
String	getJsonString()
protected String[]	getKeys()
String	getPathToResult()
int	getResponseCode()
<T> T	getSourceAsObject(Class<T> clazz)
<T> T	getSourceAsObject(Class<T> clazz, boolean addEsMetadataFields)
<T> List<T>	getSourceAsObjectList(Class<T> type)
<T> List<T>	getSourceAsObjectList(Class<T> type, boolean addEsMetadataFields)
String	getSourceAsString()
List<String>	getSourceAsStringList()
Object	getValue(String key)
boolean	isSucceeded()
void	setErrorMessage(String errorMessage) manually set an error message, eg.
void	setJsonMap(Map<String,Object> resultMap)
void	setJsonObject(com.google.gson.JsonObject jsonObject)
void	setJsonString(String jsonString)
void	setPathToResult(String pathToResult)
void	setResponseCode(int responseCode)
void	setSucceeded(boolean succeeded)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ES_METADATA_ID

public static final String ES_METADATA_ID

See Also:

Constant Field Values

ES_METADATA_VERSION

public static final String ES_METADATA_VERSION

See Also:

Constant Field Values

META_FIELDS

protected static final com.google.common.collect.ImmutableList<JestResult.MetaField> META_FIELDS

jsonObject

protected com.google.gson.JsonObject jsonObject

jsonString

protected String jsonString

pathToResult

protected String pathToResult

responseCode

protected int responseCode

isSucceeded

protected boolean isSucceeded

errorMessage

protected String errorMessage

gson

protected com.google.gson.Gson gson

Constructor Detail

JestResult

public JestResult(JestResult source)

JestResult

public JestResult(com.google.gson.Gson gson)

Method Detail

getPathToResult

public String getPathToResult()

setPathToResult

public void setPathToResult(String pathToResult)

getValue

public Object getValue(String key)

isSucceeded

public boolean isSucceeded()

setSucceeded

public void setSucceeded(boolean succeeded)

getJsonString

public String getJsonString()

setJsonString

public void setJsonString(String jsonString)

getErrorMessage

public String getErrorMessage()

getResponseCode

public int getResponseCode()

setResponseCode

public void setResponseCode(int responseCode)

setErrorMessage

public void setErrorMessage(String errorMessage)

manually set an error message, eg. for the cases where non-200 response code is received

getJsonObject

public com.google.gson.JsonObject getJsonObject()

setJsonObject

public void setJsonObject(com.google.gson.JsonObject jsonObject)

getJsonMap

@Deprecated
public Map getJsonMap()

Deprecated.

setJsonMap

public void setJsonMap(Map<String,Object> resultMap)

getSourceAsString

public String getSourceAsString()

Returns:

null if operation did not succeed or the response is null or the "keys" field of the action is empty or the response does not contain the key to source. String representing the source JSON element(s) otherwise. Elements are joined with a comma if there are multiple sources (e.g.: search with multiple hits).

getSourceAsStringList

public List<String> getSourceAsStringList()

Returns:

null if operation did not succeed or the response is null or the "keys" field of the action is empty or the response does not contain the key to source. List of strings representing the source JSON element(s) otherwise.

getSourceAsObject

public <T> T getSourceAsObject(Class<T> clazz)

getSourceAsObject

public <T> T getSourceAsObject(Class<T> clazz,
                               boolean addEsMetadataFields)

getSourceAsObjectList

public <T> List<T> getSourceAsObjectList(Class<T> type)

getSourceAsObjectList

public <T> List<T> getSourceAsObjectList(Class<T> type,
                                         boolean addEsMetadataFields)

extractSource

protected List<com.google.gson.JsonElement> extractSource()

extractSource

protected List<com.google.gson.JsonElement> extractSource(boolean addEsMetadataFields)

createSourceObject

protected <T> T createSourceObject(com.google.gson.JsonElement source,
                                   Class<T> type)

getKeys

protected String[] getKeys()

toString

public String toString()

Overrides:

toString in class Object