All Known Implementing Classes:

BrokerResponseNative
```
public interface BrokerResponse
```
Interface for broker response.

Method Summary

Modifier and Type	Method	Description
`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.
`long`	`getTotalDocs()`	Get total number of documents within the table hit.
`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`	`setNumRowsResultSet(int numRowsResultSet)`	Set the total number of rows in result set
`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`	`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 offlineThreadCpuTimeNs)`	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`	`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 realtimeThreadCpuTimeNs)`	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`	`setTimeUsedMs(long timeUsedMs)`	Set the total time used in request handling, into the broker response.
`String`	`toJsonString()`	Convert the broker response to JSON String.

- Method Detail
  - setExceptions
```
void setExceptions(List<ProcessingException> exceptions)
```
    Set exceptions caught during request handling, into the broker response.
  - setNumServersQueried
```
void setNumServersQueried(int numServersQueried)
```
    Set the number of servers got queried by the broker.
    
    Parameters:
    
    numServersQueried - number of servers got queried.
  - setNumServersResponded
```
void setNumServersResponded(int numServersResponded)
```
    Set the number of servers responded to the broker.
    
    Parameters:
    
    numServersResponded - number of servers responded.
  - setTimeUsedMs
```
void setTimeUsedMs(long timeUsedMs)
```
    Set the total time used in request handling, into the broker response.
  - setNumRowsResultSet
```
void setNumRowsResultSet(int numRowsResultSet)
```
    Set the total number of rows in result set
  - toJsonString
```
String toJsonString()
             throws Exception
```
    Convert the broker response to JSON String.
    
    Throws:
    
    Exception
  - getNumServersQueried
```
int getNumServersQueried()
```
    Returns the number of servers queried.
  - getNumServersResponded
```
int getNumServersResponded()
```
    Returns the number of servers responded.
  - getNumDocsScanned
```
long getNumDocsScanned()
```
    Get number of documents scanned while processing the query.
  - getNumEntriesScannedInFilter
```
long getNumEntriesScannedInFilter()
```
    Get number of entries scanned in filter phase while processing the query.
  - getNumEntriesScannedPostFilter
```
long getNumEntriesScannedPostFilter()
```
    Get number of entries scanned post filter phase while processing the query.
  - getNumSegmentsQueried
```
long getNumSegmentsQueried()
```
    Get the number of segments queried by the broker after broker side pruning
  - getNumSegmentsProcessed
```
long getNumSegmentsProcessed()
```
    Get the number of segments processed by server after server side pruning
  - getNumSegmentsMatched
```
long getNumSegmentsMatched()
```
    Get number of segments that had at least one matching document
  - getNumConsumingSegmentsQueried
```
long getNumConsumingSegmentsQueried()
```
    Get number of consuming segments that were queried.
  - getNumConsumingSegmentsProcessed
```
long getNumConsumingSegmentsProcessed()
```
    Get number of consuming segments processed by server after server side pruning
  - getNumConsumingSegmentsMatched
```
long getNumConsumingSegmentsMatched()
```
    Get number of consuming segments that had at least one matching document
  - getMinConsumingFreshnessTimeMs
```
long getMinConsumingFreshnessTimeMs()
```
    Get the minimum freshness timestamp across consuming segments that were queried
  - getTotalDocs
```
long getTotalDocs()
```
    Get total number of documents within the table hit.
  - isNumGroupsLimitReached
```
boolean isNumGroupsLimitReached()
```
    Returns whether the number of groups limit has been reached.
  - getExceptionsSize
```
int getExceptionsSize()
```
    Get number of exceptions recorded in the response.
  - setResultTable
```
void setResultTable(ResultTable resultTable)
```
    set the result table.
    
    Parameters:
    
    resultTable - result table to be set.
  - getResultTable
```
ResultTable getResultTable()
```
    Get the result table.
    
    Returns:
    
    result table.
  - getProcessingExceptions
```
List<QueryProcessingException> getProcessingExceptions()
```
    Get the list of exceptions
  - getNumRowsResultSet
```
int getNumRowsResultSet()
```
    Get the total number of rows in result set
  - setOfflineThreadCpuTimeNs
```
void setOfflineThreadCpuTimeNs(long offlineThreadCpuTimeNs)
```
    Set the total thread cpu time used against offline table in request handling, into the broker response.
  - getOfflineThreadCpuTimeNs
```
long getOfflineThreadCpuTimeNs()
```
    Get the thread cpu time used against offline table in request handling, from the broker response.
  - getRealtimeThreadCpuTimeNs
```
long getRealtimeThreadCpuTimeNs()
```
    Get the thread cpu time used against realtime table in request handling, from the broker response.
  - setRealtimeThreadCpuTimeNs
```
void setRealtimeThreadCpuTimeNs(long realtimeThreadCpuTimeNs)
```
    Set the total thread cpu time used against realtime table in request handling, into the broker response.
  - getOfflineSystemActivitiesCpuTimeNs
```
long getOfflineSystemActivitiesCpuTimeNs()
```
    Get the system activities cpu time used against offline table in request handling, from the broker response.
  - setOfflineSystemActivitiesCpuTimeNs
```
void setOfflineSystemActivitiesCpuTimeNs(long offlineSystemActivitiesCpuTimeNs)
```
    Set the system activities cpu time used against offline table in request handling, into the broker response.
  - getRealtimeSystemActivitiesCpuTimeNs
```
long getRealtimeSystemActivitiesCpuTimeNs()
```
    Get the system activities cpu time used against realtime table in request handling, from the broker response.
  - setRealtimeSystemActivitiesCpuTimeNs
```
void setRealtimeSystemActivitiesCpuTimeNs(long realtimeSystemActivitiesCpuTimeNs)
```
    Set the system activities cpu time used against realtime table in request handling, into the broker response.
  - getOfflineResponseSerializationCpuTimeNs
```
long getOfflineResponseSerializationCpuTimeNs()
```
    Get the response serialization cpu time used against offline table in request handling, from the broker response.
  - setOfflineResponseSerializationCpuTimeNs
```
void setOfflineResponseSerializationCpuTimeNs(long offlineResponseSerializationCpuTimeNs)
```
    Set the response serialization cpu time used against offline table in request handling, into the broker response.
  - getRealtimeResponseSerializationCpuTimeNs
```
long getRealtimeResponseSerializationCpuTimeNs()
```
    Get the response serialization cpu time used against realtime table in request handling, from the broker response.
  - setRealtimeResponseSerializationCpuTimeNs
```
void setRealtimeResponseSerializationCpuTimeNs(long realtimeResponseSerializationCpuTimeNs)
```
    Set the response serialization cpu time used against realtime table in request handling, into the broker response.
  - getOfflineTotalCpuTimeNs
```
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.
  - setOfflineTotalCpuTimeNs
```
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.
  - getRealtimeTotalCpuTimeNs
```
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.
  - setRealtimeTotalCpuTimeNs
```
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.
  - getNumSegmentsPrunedByBroker
```
long getNumSegmentsPrunedByBroker()
```
    Get the total number of segments pruned on the Broker side
  - setNumSegmentsPrunedByBroker
```
void setNumSegmentsPrunedByBroker(long numSegmentsPrunedByBroker)
```
    Set the total number of segments pruned on the Broker side
  - getNumSegmentsPrunedByServer
```
long getNumSegmentsPrunedByServer()
```
    Get the total number of segments pruned on the Server side
  - setNumSegmentsPrunedByServer
```
void setNumSegmentsPrunedByServer(long numSegmentsPrunedByServer)
```
    Set the total number of segments pruned on the Server side
  - getNumSegmentsPrunedInvalid
```
long getNumSegmentsPrunedInvalid()
```
    Get the total number of segments pruned due to invalid data or schema. This value is always lower or equal than getNumSegmentsPrunedByServer()
  - setNumSegmentsPrunedInvalid
```
void setNumSegmentsPrunedInvalid(long numSegmentsPrunedInvalid)
```
    Set the total number of segments pruned due to invalid data or schema. This value is always lower or equal than getNumSegmentsPrunedByServer()
  - getNumSegmentsPrunedByLimit
```
long getNumSegmentsPrunedByLimit()
```
    Get the total number of segments pruned by applying the limit optimization. This value is always lower or equal than getNumSegmentsPrunedByServer()
  - setNumSegmentsPrunedByLimit
```
void setNumSegmentsPrunedByLimit(long numSegmentsPrunedByLimit)
```
    Set the total number of segments pruned by applying the limit optimization. This value is always lower or equal than getNumSegmentsPrunedByServer()
  - getNumSegmentsPrunedByValue
```
long getNumSegmentsPrunedByValue()
```
    Get the total number of segments pruned applying value optimizations, like bloom filters. This value is always lower or equal than getNumSegmentsPrunedByServer()
  - setNumSegmentsPrunedByValue
```
void setNumSegmentsPrunedByValue(long numSegmentsPrunedByValue)
```
    Set the total number of segments pruned applying value optimizations, like bloom filters. This value is always lower or equal than getNumSegmentsPrunedByServer()
  - getExplainPlanNumEmptyFilterSegments
```
long getExplainPlanNumEmptyFilterSegments()
```
    Get the total number of segments with an EmptyFilterOperator when Explain Plan is called
  - setExplainPlanNumEmptyFilterSegments
```
void setExplainPlanNumEmptyFilterSegments(long explainPlanNumEmptyFilterSegments)
```
    Set the total number of segments with an EmptyFilterOperator when Explain Plan is called
  - getExplainPlanNumMatchAllFilterSegments
```
long getExplainPlanNumMatchAllFilterSegments()
```
    Get the total number of segments with a MatchAllFilterOperator when Explain Plan is called
  - setExplainPlanNumMatchAllFilterSegments
```
void setExplainPlanNumMatchAllFilterSegments(long explainPlanNumMatchAllFilterSegments)
```
    Set the total number of segments with a MatchAllFilterOperator when Explain Plan is called

Interface BrokerResponse

Method Summary

Method Detail

setExceptions

setNumServersQueried

setNumServersResponded

setTimeUsedMs

setNumRowsResultSet

toJsonString

getNumServersQueried

getNumServersResponded

getNumDocsScanned

getNumEntriesScannedInFilter

getNumEntriesScannedPostFilter

getNumSegmentsQueried

getNumSegmentsProcessed

getNumSegmentsMatched

getNumConsumingSegmentsQueried

getNumConsumingSegmentsProcessed

getNumConsumingSegmentsMatched

getMinConsumingFreshnessTimeMs

getTotalDocs

isNumGroupsLimitReached

getExceptionsSize

setResultTable

getResultTable

getProcessingExceptions

getNumRowsResultSet

setOfflineThreadCpuTimeNs

getOfflineThreadCpuTimeNs

getRealtimeThreadCpuTimeNs

setRealtimeThreadCpuTimeNs

getOfflineSystemActivitiesCpuTimeNs

setOfflineSystemActivitiesCpuTimeNs

getRealtimeSystemActivitiesCpuTimeNs

setRealtimeSystemActivitiesCpuTimeNs

getOfflineResponseSerializationCpuTimeNs

setOfflineResponseSerializationCpuTimeNs

getRealtimeResponseSerializationCpuTimeNs

setRealtimeResponseSerializationCpuTimeNs

getOfflineTotalCpuTimeNs

setOfflineTotalCpuTimeNs

getRealtimeTotalCpuTimeNs

setRealtimeTotalCpuTimeNs

getNumSegmentsPrunedByBroker

setNumSegmentsPrunedByBroker

getNumSegmentsPrunedByServer

setNumSegmentsPrunedByServer

getNumSegmentsPrunedInvalid

setNumSegmentsPrunedInvalid

getNumSegmentsPrunedByLimit

setNumSegmentsPrunedByLimit

getNumSegmentsPrunedByValue

setNumSegmentsPrunedByValue

getExplainPlanNumEmptyFilterSegments

setExplainPlanNumEmptyFilterSegments

getExplainPlanNumMatchAllFilterSegments

setExplainPlanNumMatchAllFilterSegments