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

Class 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.

    • Constructor Detail

      • BrokerResponseNative

        public BrokerResponseNative()

    • Method Detail

      • 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

      • 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

      • 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

      • 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

      • 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

      • 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.

      • 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)

      • setNumEntriesScannedInFilter

        public void setNumEntriesScannedInFilter​(long numEntriesScannedInFilter)

      • 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)

      • setNumSegmentsMatched

        public void setNumSegmentsMatched​(long numSegmentsMatched)

      • setNumConsumingSegmentsQueried

        public void setNumConsumingSegmentsQueried​(long numConsumingSegmentsQueried)

      • setNumConsumingSegmentsProcessed

        public void setNumConsumingSegmentsProcessed​(long numConsumingSegmentsProcessed)

      • setNumConsumingSegmentsMatched

        public void setNumConsumingSegmentsMatched​(long numConsumingSegmentsMatched)

      • 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)

      • 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

      • 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)

      • setTraceInfo

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