Package org.apache.pinot.common.response.broker

Class BrokerResponseNative

java.lang.Object

org.apache.pinot.common.response.broker.BrokerResponseNative

All Implemented Interfaces:

BrokerResponse

public class BrokerResponseNative
extends Object
implements BrokerResponse

This class implements pinot-broker's response format for any given query. All fields either primitive data types, or native objects (as opposed to JSONObjects). Supports serialization via JSON.

Field Summary

Fields

Modifier and Type	Field	Description
static BrokerResponseNative	BROKER_ONLY_EXPLAIN_PLAN_OUTPUT
static BrokerResponseNative	EMPTY_RESULT
static BrokerResponseNative	NO_TABLE_RESULT
static BrokerResponseNative	TABLE_DOES_NOT_EXIST

Constructor Summary

Constructors

Constructor	Description
BrokerResponseNative()
BrokerResponseNative(List<ProcessingException> exceptions)
BrokerResponseNative(ProcessingException exception)

Method Summary

Modifier and Type	Method	Description
void	addToExceptions(QueryProcessingException processingException)
static BrokerResponseNative	empty()	Get a new empty BrokerResponseNative.
static BrokerResponseNative	fromJsonString(String jsonString)
int	getExceptionsSize()	Get number of exceptions recorded in the response.
long	getExplainPlanNumEmptyFilterSegments()	Get the total number of segments with an EmptyFilterOperator when Explain Plan is called
long	getExplainPlanNumMatchAllFilterSegments()	Get the total number of segments with a MatchAllFilterOperator when Explain Plan is called
long	getMinConsumingFreshnessTimeMs()	Get the minimum freshness timestamp across consuming segments that were queried
long	getNumConsumingSegmentsMatched()	Get number of consuming segments that had at least one matching document
long	getNumConsumingSegmentsProcessed()	Get number of consuming segments processed by server after server side pruning
long	getNumConsumingSegmentsQueried()	Get number of consuming segments that were queried.
long	getNumDocsScanned()	Get number of documents scanned while processing the query.
long	getNumEntriesScannedInFilter()	Get number of entries scanned in filter phase while processing the query.
long	getNumEntriesScannedPostFilter()	Get number of entries scanned post filter phase while processing the query.
int	getNumRowsResultSet()	Get the total number of rows in result set
long	getNumSegmentsMatched()	Get number of segments that had at least one matching document
long	getNumSegmentsProcessed()	Get the number of segments processed by server after server side pruning
long	getNumSegmentsPrunedByBroker()	Get the total number of segments pruned on the Broker side
long	getNumSegmentsPrunedByLimit()	Get the total number of segments pruned by applying the limit optimization.
long	getNumSegmentsPrunedByServer()	Get the total number of segments pruned on the Server side
long	getNumSegmentsPrunedByValue()	Get the total number of segments pruned applying value optimizations, like bloom filters.
long	getNumSegmentsPrunedInvalid()	Get the total number of segments pruned due to invalid data or schema.
long	getNumSegmentsQueried()	Get the number of segments queried by the broker after broker side pruning
int	getNumServersQueried()	Returns the number of servers queried.
int	getNumServersResponded()	Returns the number of servers responded.
long	getOfflineResponseSerializationCpuTimeNs()	Get the response serialization cpu time used against offline table in request handling, from the broker response.
long	getOfflineSystemActivitiesCpuTimeNs()	Get the system activities cpu time used against offline table in request handling, from the broker response.
long	getOfflineThreadCpuTimeNs()	Get the thread cpu time used against offline table in request handling, from the broker response.
long	getOfflineTotalCpuTimeNs()	Get the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against offline table in request handling, from the broker response.
List<QueryProcessingException>	getProcessingExceptions()	Get the list of exceptions
long	getRealtimeResponseSerializationCpuTimeNs()	Get the response serialization cpu time used against realtime table in request handling, from the broker response.
long	getRealtimeSystemActivitiesCpuTimeNs()	Get the system activities cpu time used against realtime table in request handling, from the broker response.
long	getRealtimeThreadCpuTimeNs()	Get the thread cpu time used against realtime table in request handling, from the broker response.
long	getRealtimeTotalCpuTimeNs()	Get the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against realtime table in request handling, from the broker response.
ResultTable	getResultTable()	Get the result table.
List<String>	getSegmentStatistics()
long	getTimeUsedMs()
long	getTotalDocs()	Get total number of documents within the table hit.
Map<String,String>	getTraceInfo()
boolean	isNumGroupsLimitReached()	Returns whether the number of groups limit has been reached.
void	setExceptions(List<ProcessingException> exceptions)	Set exceptions caught during request handling, into the broker response.
void	setExplainPlanNumEmptyFilterSegments(long explainPlanNumEmptyFilterSegments)	Set the total number of segments with an EmptyFilterOperator when Explain Plan is called
void	setExplainPlanNumMatchAllFilterSegments(long explainPlanNumMatchAllFilterSegments)	Set the total number of segments with a MatchAllFilterOperator when Explain Plan is called
void	setMinConsumingFreshnessTimeMs(long minConsumingFreshnessTimeMs)
void	setNumConsumingSegmentsMatched(long numConsumingSegmentsMatched)
void	setNumConsumingSegmentsProcessed(long numConsumingSegmentsProcessed)
void	setNumConsumingSegmentsQueried(long numConsumingSegmentsQueried)
void	setNumDocsScanned(long numDocsScanned)
void	setNumEntriesScannedInFilter(long numEntriesScannedInFilter)
void	setNumEntriesScannedPostFilter(long numEntriesScannedPostFilter)
void	setNumGroupsLimitReached(boolean numGroupsLimitReached)
void	setNumRowsResultSet(int numRowsResultSet)	Set the total number of rows in result set
void	setNumSegmentsMatched(long numSegmentsMatched)
void	setNumSegmentsProcessed(long numSegmentsProcessed)
void	setNumSegmentsPrunedByBroker(long numSegmentsPrunedByBroker)	Set the total number of segments pruned on the Broker side
void	setNumSegmentsPrunedByLimit(long numSegmentsPrunedByLimit)	Set the total number of segments pruned by applying the limit optimization.
void	setNumSegmentsPrunedByServer(long numSegmentsPrunedByServer)	Set the total number of segments pruned on the Server side
void	setNumSegmentsPrunedByValue(long numSegmentsPrunedByValue)	Set the total number of segments pruned applying value optimizations, like bloom filters.
void	setNumSegmentsPrunedInvalid(long numSegmentsPrunedInvalid)	Set the total number of segments pruned due to invalid data or schema.
void	setNumSegmentsQueried(long numSegmentsQueried)
void	setNumServersQueried(int numServersQueried)	Set the number of servers got queried by the broker.
void	setNumServersResponded(int numServersResponded)	Set the number of servers responded to the broker.
void	setOfflineResponseSerializationCpuTimeNs(long offlineResponseSerializationCpuTimeNs)	Set the response serialization cpu time used against offline table in request handling, into the broker response.
void	setOfflineSystemActivitiesCpuTimeNs(long offlineSystemActivitiesCpuTimeNs)	Set the system activities cpu time used against offline table in request handling, into the broker response.
void	setOfflineThreadCpuTimeNs(long timeUsedMs)	Set the total thread cpu time used against offline table in request handling, into the broker response.
void	setOfflineTotalCpuTimeNs(long offlineTotalCpuTimeNs)	Set the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against offline table in request handling, into the broker response.
void	setProcessingExceptions(List<QueryProcessingException> processingExceptions)
void	setRealtimeResponseSerializationCpuTimeNs(long realtimeResponseSerializationCpuTimeNs)	Set the response serialization cpu time used against realtime table in request handling, into the broker response.
void	setRealtimeSystemActivitiesCpuTimeNs(long realtimeSystemActivitiesCpuTimeNs)	Set the system activities cpu time used against realtime table in request handling, into the broker response.
void	setRealtimeThreadCpuTimeNs(long timeUsedMs)	Set the total thread cpu time used against realtime table in request handling, into the broker response.
void	setRealtimeTotalCpuTimeNs(long realtimeTotalCpuTimeNs)	Set the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against realtime table in request handling, into the broker response.
void	setResultTable(ResultTable resultTable)	set the result table.
void	setSegmentStatistics(List<String> segmentStatistics)
void	setTimeUsedMs(long timeUsedMs)	Set the total time used in request handling, into the broker response.
void	setTotalDocs(long totalDocs)
void	setTraceInfo(Map<String,String> traceInfo)
String	toJsonString()	Convert the broker response to JSON String.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_RESULT

public static final BrokerResponseNative EMPTY_RESULT

NO_TABLE_RESULT

public static final BrokerResponseNative NO_TABLE_RESULT

TABLE_DOES_NOT_EXIST

public static final BrokerResponseNative TABLE_DOES_NOT_EXIST

BROKER_ONLY_EXPLAIN_PLAN_OUTPUT

public static final BrokerResponseNative BROKER_ONLY_EXPLAIN_PLAN_OUTPUT

Constructor Detail

BrokerResponseNative

public BrokerResponseNative()

BrokerResponseNative

public BrokerResponseNative(ProcessingException exception)

BrokerResponseNative

public BrokerResponseNative(List<ProcessingException> exceptions)

Method Detail

empty

public static BrokerResponseNative empty()

Get a new empty BrokerResponseNative.

fromJsonString

public static BrokerResponseNative fromJsonString(String jsonString)
                                           throws IOException

Throws:

IOException

getOfflineSystemActivitiesCpuTimeNs

public long getOfflineSystemActivitiesCpuTimeNs()

Description copied from interface: BrokerResponse

Get the system activities cpu time used against offline table in request handling, from the broker response.

Specified by:

getOfflineSystemActivitiesCpuTimeNs in interface BrokerResponse

setOfflineSystemActivitiesCpuTimeNs

public void setOfflineSystemActivitiesCpuTimeNs(long offlineSystemActivitiesCpuTimeNs)

Description copied from interface: BrokerResponse

Set the system activities cpu time used against offline table in request handling, into the broker response.

Specified by:

setOfflineSystemActivitiesCpuTimeNs in interface BrokerResponse

getRealtimeSystemActivitiesCpuTimeNs

public long getRealtimeSystemActivitiesCpuTimeNs()

Description copied from interface: BrokerResponse

Get the system activities cpu time used against realtime table in request handling, from the broker response.

Specified by:

getRealtimeSystemActivitiesCpuTimeNs in interface BrokerResponse

setRealtimeSystemActivitiesCpuTimeNs

public void setRealtimeSystemActivitiesCpuTimeNs(long realtimeSystemActivitiesCpuTimeNs)

Description copied from interface: BrokerResponse

Set the system activities cpu time used against realtime table in request handling, into the broker response.

Specified by:

setRealtimeSystemActivitiesCpuTimeNs in interface BrokerResponse

getOfflineThreadCpuTimeNs

public long getOfflineThreadCpuTimeNs()

Description copied from interface: BrokerResponse

Get the thread cpu time used against offline table in request handling, from the broker response.

Specified by:

getOfflineThreadCpuTimeNs in interface BrokerResponse

setOfflineThreadCpuTimeNs

public void setOfflineThreadCpuTimeNs(long timeUsedMs)

Description copied from interface: BrokerResponse

Set the total thread cpu time used against offline table in request handling, into the broker response.

Specified by:

setOfflineThreadCpuTimeNs in interface BrokerResponse

getRealtimeThreadCpuTimeNs

public long getRealtimeThreadCpuTimeNs()

Description copied from interface: BrokerResponse

Get the thread cpu time used against realtime table in request handling, from the broker response.

Specified by:

getRealtimeThreadCpuTimeNs in interface BrokerResponse

setRealtimeThreadCpuTimeNs

public void setRealtimeThreadCpuTimeNs(long timeUsedMs)

Description copied from interface: BrokerResponse

Set the total thread cpu time used against realtime table in request handling, into the broker response.

Specified by:

setRealtimeThreadCpuTimeNs in interface BrokerResponse

getOfflineResponseSerializationCpuTimeNs

public long getOfflineResponseSerializationCpuTimeNs()

Description copied from interface: BrokerResponse

Get the response serialization cpu time used against offline table in request handling, from the broker response.

Specified by:

getOfflineResponseSerializationCpuTimeNs in interface BrokerResponse

setOfflineResponseSerializationCpuTimeNs

public void setOfflineResponseSerializationCpuTimeNs(long offlineResponseSerializationCpuTimeNs)

Description copied from interface: BrokerResponse

Set the response serialization cpu time used against offline table in request handling, into the broker response.

Specified by:

setOfflineResponseSerializationCpuTimeNs in interface BrokerResponse

getRealtimeResponseSerializationCpuTimeNs

public long getRealtimeResponseSerializationCpuTimeNs()

Description copied from interface: BrokerResponse

Get the response serialization cpu time used against realtime table in request handling, from the broker response.

Specified by:

getRealtimeResponseSerializationCpuTimeNs in interface BrokerResponse

setRealtimeResponseSerializationCpuTimeNs

public void setRealtimeResponseSerializationCpuTimeNs(long realtimeResponseSerializationCpuTimeNs)

Description copied from interface: BrokerResponse

Set the response serialization cpu time used against realtime table in request handling, into the broker response.

Specified by:

setRealtimeResponseSerializationCpuTimeNs in interface BrokerResponse

getOfflineTotalCpuTimeNs

public long getOfflineTotalCpuTimeNs()

Description copied from interface: BrokerResponse

Get the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against offline table in request handling, from the broker response.

Specified by:

getOfflineTotalCpuTimeNs in interface BrokerResponse

setOfflineTotalCpuTimeNs

public void setOfflineTotalCpuTimeNs(long offlineTotalCpuTimeNs)

Description copied from interface: BrokerResponse

Set the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against offline table in request handling, into the broker response.

Specified by:

setOfflineTotalCpuTimeNs in interface BrokerResponse

getRealtimeTotalCpuTimeNs

public long getRealtimeTotalCpuTimeNs()

Description copied from interface: BrokerResponse

Get the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against realtime table in request handling, from the broker response.

Specified by:

getRealtimeTotalCpuTimeNs in interface BrokerResponse

setRealtimeTotalCpuTimeNs

public void setRealtimeTotalCpuTimeNs(long realtimeTotalCpuTimeNs)

Description copied from interface: BrokerResponse

Set the total cpu time(thread cpu time + system activities cpu time + response serialization cpu time) used against realtime table in request handling, into the broker response.

Specified by:

setRealtimeTotalCpuTimeNs in interface BrokerResponse

getNumSegmentsPrunedByBroker

public long getNumSegmentsPrunedByBroker()

Description copied from interface: BrokerResponse

Get the total number of segments pruned on the Broker side

Specified by:

getNumSegmentsPrunedByBroker in interface BrokerResponse

setNumSegmentsPrunedByBroker

public void setNumSegmentsPrunedByBroker(long numSegmentsPrunedByBroker)

Description copied from interface: BrokerResponse

Set the total number of segments pruned on the Broker side

Specified by:

setNumSegmentsPrunedByBroker in interface BrokerResponse

getNumSegmentsPrunedByServer

public long getNumSegmentsPrunedByServer()

Description copied from interface: BrokerResponse

Get the total number of segments pruned on the Server side

Specified by:

getNumSegmentsPrunedByServer in interface BrokerResponse

setNumSegmentsPrunedByServer

public void setNumSegmentsPrunedByServer(long numSegmentsPrunedByServer)

Description copied from interface: BrokerResponse

Set the total number of segments pruned on the Server side

Specified by:

setNumSegmentsPrunedByServer in interface BrokerResponse

getNumSegmentsPrunedInvalid

public long getNumSegmentsPrunedInvalid()

Description copied from interface: BrokerResponse

Get the total number of segments pruned due to invalid data or schema. This value is always lower or equal than BrokerResponse.getNumSegmentsPrunedByServer()

Specified by:

getNumSegmentsPrunedInvalid in interface BrokerResponse

setNumSegmentsPrunedInvalid

public void setNumSegmentsPrunedInvalid(long numSegmentsPrunedInvalid)

Description copied from interface: BrokerResponse

Set the total number of segments pruned due to invalid data or schema. This value is always lower or equal than BrokerResponse.getNumSegmentsPrunedByServer()

Specified by:

setNumSegmentsPrunedInvalid in interface BrokerResponse

getNumSegmentsPrunedByLimit

public long getNumSegmentsPrunedByLimit()

Description copied from interface: BrokerResponse

Get the total number of segments pruned by applying the limit optimization. This value is always lower or equal than BrokerResponse.getNumSegmentsPrunedByServer()

Specified by:

getNumSegmentsPrunedByLimit in interface BrokerResponse

setNumSegmentsPrunedByLimit

public void setNumSegmentsPrunedByLimit(long numSegmentsPrunedByLimit)

Description copied from interface: BrokerResponse

Set the total number of segments pruned by applying the limit optimization. This value is always lower or equal than BrokerResponse.getNumSegmentsPrunedByServer()

Specified by:

setNumSegmentsPrunedByLimit in interface BrokerResponse

getNumSegmentsPrunedByValue

public long getNumSegmentsPrunedByValue()

Description copied from interface: BrokerResponse

Get the total number of segments pruned applying value optimizations, like bloom filters. This value is always lower or equal than BrokerResponse.getNumSegmentsPrunedByServer()

Specified by:

getNumSegmentsPrunedByValue in interface BrokerResponse

setNumSegmentsPrunedByValue

public void setNumSegmentsPrunedByValue(long numSegmentsPrunedByValue)

Description copied from interface: BrokerResponse

Set the total number of segments pruned applying value optimizations, like bloom filters. This value is always lower or equal than BrokerResponse.getNumSegmentsPrunedByServer()

Specified by:

setNumSegmentsPrunedByValue in interface BrokerResponse

getExplainPlanNumEmptyFilterSegments

public long getExplainPlanNumEmptyFilterSegments()

Description copied from interface: BrokerResponse

Get the total number of segments with an EmptyFilterOperator when Explain Plan is called

Specified by:

getExplainPlanNumEmptyFilterSegments in interface BrokerResponse

setExplainPlanNumEmptyFilterSegments

public void setExplainPlanNumEmptyFilterSegments(long explainPlanNumEmptyFilterSegments)

Description copied from interface: BrokerResponse

Set the total number of segments with an EmptyFilterOperator when Explain Plan is called

Specified by:

setExplainPlanNumEmptyFilterSegments in interface BrokerResponse

getExplainPlanNumMatchAllFilterSegments

public long getExplainPlanNumMatchAllFilterSegments()

Description copied from interface: BrokerResponse

Get the total number of segments with a MatchAllFilterOperator when Explain Plan is called

Specified by:

getExplainPlanNumMatchAllFilterSegments in interface BrokerResponse

setExplainPlanNumMatchAllFilterSegments

public void setExplainPlanNumMatchAllFilterSegments(long explainPlanNumMatchAllFilterSegments)

Description copied from interface: BrokerResponse

Set the total number of segments with a MatchAllFilterOperator when Explain Plan is called

Specified by:

setExplainPlanNumMatchAllFilterSegments in interface BrokerResponse

getResultTable

public ResultTable getResultTable()

Description copied from interface: BrokerResponse

Get the result table.

Specified by:

getResultTable in interface BrokerResponse

Returns:

result table.

setResultTable

public void setResultTable(ResultTable resultTable)

Description copied from interface: BrokerResponse

set the result table.

Specified by:

setResultTable in interface BrokerResponse

Parameters:

resultTable - result table to be set.

getProcessingExceptions

public List<QueryProcessingException> getProcessingExceptions()

Description copied from interface: BrokerResponse

Get the list of exceptions

Specified by:

getProcessingExceptions in interface BrokerResponse

setProcessingExceptions

public void setProcessingExceptions(List<QueryProcessingException> processingExceptions)

getNumServersQueried

public int getNumServersQueried()

Description copied from interface: BrokerResponse

Returns the number of servers queried.

Specified by:

getNumServersQueried in interface BrokerResponse

setNumServersQueried

public void setNumServersQueried(int numServersQueried)

Description copied from interface: BrokerResponse

Set the number of servers got queried by the broker.

Specified by:

setNumServersQueried in interface BrokerResponse

Parameters:

numServersQueried - number of servers got queried.

getNumServersResponded

public int getNumServersResponded()

Description copied from interface: BrokerResponse

Returns the number of servers responded.

Specified by:

getNumServersResponded in interface BrokerResponse

setNumServersResponded

public void setNumServersResponded(int numServersResponded)

Description copied from interface: BrokerResponse

Set the number of servers responded to the broker.

Specified by:

setNumServersResponded in interface BrokerResponse

Parameters:

numServersResponded - number of servers responded.

getNumDocsScanned

public long getNumDocsScanned()

Description copied from interface: BrokerResponse

Get number of documents scanned while processing the query.

Specified by:

getNumDocsScanned in interface BrokerResponse

setNumDocsScanned

public void setNumDocsScanned(long numDocsScanned)

getNumEntriesScannedInFilter

public long getNumEntriesScannedInFilter()

Description copied from interface: BrokerResponse

Get number of entries scanned in filter phase while processing the query.

Specified by:

getNumEntriesScannedInFilter in interface BrokerResponse

setNumEntriesScannedInFilter

public void setNumEntriesScannedInFilter(long numEntriesScannedInFilter)

getNumEntriesScannedPostFilter

public long getNumEntriesScannedPostFilter()

Description copied from interface: BrokerResponse

Get number of entries scanned post filter phase while processing the query.

Specified by:

getNumEntriesScannedPostFilter in interface BrokerResponse

setNumEntriesScannedPostFilter

public void setNumEntriesScannedPostFilter(long numEntriesScannedPostFilter)

getNumSegmentsQueried

public long getNumSegmentsQueried()

Description copied from interface: BrokerResponse

Get the number of segments queried by the broker after broker side pruning

Specified by:

getNumSegmentsQueried in interface BrokerResponse

setNumSegmentsQueried

public void setNumSegmentsQueried(long numSegmentsQueried)

getNumSegmentsProcessed

public long getNumSegmentsProcessed()

Description copied from interface: BrokerResponse

Get the number of segments processed by server after server side pruning

Specified by:

getNumSegmentsProcessed in interface BrokerResponse

setNumSegmentsProcessed

public void setNumSegmentsProcessed(long numSegmentsProcessed)

getNumSegmentsMatched

public long getNumSegmentsMatched()

Description copied from interface: BrokerResponse

Get number of segments that had at least one matching document

Specified by:

getNumSegmentsMatched in interface BrokerResponse

setNumSegmentsMatched

public void setNumSegmentsMatched(long numSegmentsMatched)

getNumConsumingSegmentsQueried

public long getNumConsumingSegmentsQueried()

Description copied from interface: BrokerResponse

Get number of consuming segments that were queried.

Specified by:

getNumConsumingSegmentsQueried in interface BrokerResponse

setNumConsumingSegmentsQueried

public void setNumConsumingSegmentsQueried(long numConsumingSegmentsQueried)

getNumConsumingSegmentsProcessed

public long getNumConsumingSegmentsProcessed()

Description copied from interface: BrokerResponse

Get number of consuming segments processed by server after server side pruning

Specified by:

getNumConsumingSegmentsProcessed in interface BrokerResponse

setNumConsumingSegmentsProcessed

public void setNumConsumingSegmentsProcessed(long numConsumingSegmentsProcessed)

getNumConsumingSegmentsMatched

public long getNumConsumingSegmentsMatched()

Description copied from interface: BrokerResponse

Get number of consuming segments that had at least one matching document

Specified by:

getNumConsumingSegmentsMatched in interface BrokerResponse

setNumConsumingSegmentsMatched

public void setNumConsumingSegmentsMatched(long numConsumingSegmentsMatched)

getMinConsumingFreshnessTimeMs

public long getMinConsumingFreshnessTimeMs()

Description copied from interface: BrokerResponse

Get the minimum freshness timestamp across consuming segments that were queried

Specified by:

getMinConsumingFreshnessTimeMs in interface BrokerResponse

setMinConsumingFreshnessTimeMs

public void setMinConsumingFreshnessTimeMs(long minConsumingFreshnessTimeMs)

getTotalDocs

public long getTotalDocs()

Description copied from interface: BrokerResponse

Get total number of documents within the table hit.

Specified by:

getTotalDocs in interface BrokerResponse

setTotalDocs

public void setTotalDocs(long totalDocs)

isNumGroupsLimitReached

public boolean isNumGroupsLimitReached()

Description copied from interface: BrokerResponse

Returns whether the number of groups limit has been reached.

Specified by:

isNumGroupsLimitReached in interface BrokerResponse

setNumGroupsLimitReached

public void setNumGroupsLimitReached(boolean numGroupsLimitReached)

getTimeUsedMs

public long getTimeUsedMs()

setTimeUsedMs

public void setTimeUsedMs(long timeUsedMs)

Description copied from interface: BrokerResponse

Set the total time used in request handling, into the broker response.

Specified by:

setTimeUsedMs in interface BrokerResponse

getNumRowsResultSet

public int getNumRowsResultSet()

Description copied from interface: BrokerResponse

Get the total number of rows in result set

Specified by:

getNumRowsResultSet in interface BrokerResponse

setNumRowsResultSet

public void setNumRowsResultSet(int numRowsResultSet)

Description copied from interface: BrokerResponse

Set the total number of rows in result set

Specified by:

setNumRowsResultSet in interface BrokerResponse

getSegmentStatistics

public List<String> getSegmentStatistics()

setSegmentStatistics

public void setSegmentStatistics(List<String> segmentStatistics)

getTraceInfo

public Map<String,String> getTraceInfo()

setTraceInfo

public void setTraceInfo(Map<String,String> traceInfo)

toJsonString

public String toJsonString()
                    throws IOException

Description copied from interface: BrokerResponse

Convert the broker response to JSON String.

Specified by:

toJsonString in interface BrokerResponse

Throws:

IOException

setExceptions

public void setExceptions(List<ProcessingException> exceptions)

Description copied from interface: BrokerResponse

Set exceptions caught during request handling, into the broker response.

Specified by:

setExceptions in interface BrokerResponse

addToExceptions

public void addToExceptions(QueryProcessingException processingException)

getExceptionsSize

public int getExceptionsSize()

Description copied from interface: BrokerResponse

Get number of exceptions recorded in the response.

Specified by:

getExceptionsSize in interface BrokerResponse