Package com.inductiveautomation.ignition.common.logging

Class LogResults

java.lang.Object

com.inductiveautomation.ignition.common.logging.LogResults

All Implemented Interfaces:

Serializable

public class LogResults
extends Object
implements Serializable

The results of a query to the logging system. Contains a set of events, and potentially an estimate of the total number of events that might be available, if the filter set a limit.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LogResults(List<LogEvent> events)
LogResults(List<LogEvent> events, int estimatedTotalResults)

Method Summary

Modifier and Type	Method	Description
int	getEstimatedTotalResults()	If the query was page limited (limitPageTo() on the LogQueryConfig builder), and would have had more results, this is an estimate of the number.
List<LogEvent>	getEvents()

Methods inherited from class java.lang.Object

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

Constructor Details

LogResults

public LogResults(List<LogEvent> events)

LogResults

public LogResults(List<LogEvent> events,
 int estimatedTotalResults)

Method Details

getEvents

public List<LogEvent> getEvents()

getEstimatedTotalResults

public int getEstimatedTotalResults()

If the query was page limited (limitPageTo() on the LogQueryConfig builder), and would have had more results, this is an estimate of the number. If the underlying system can't provide this information, this will return 0. Also, this is only expected to be calculated the "first" time, which generally means when pageLimit!=0 and offset==0 on the filter.