Package com.inductiveautomation.ignition.common.logging

Class LogQueryConfig.LogQueryConfigBuilder

java.lang.Object

com.inductiveautomation.ignition.common.logging.LogQueryConfig.LogQueryConfigBuilder

Enclosing class:

LogQueryConfig

public static class LogQueryConfig.LogQueryConfigBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
LogQueryConfig.LogQueryConfigBuilder	atOrAbove(Level level)
LogQueryConfig.LogQueryConfigBuilder	betweenTime(long startTime, long endTime)
LogQueryConfig	build()
LogQueryConfig.LogQueryConfigBuilder	eventsForSystems(String... systemIds)	System events are those logged through LoggerEx's infoEvent, warnEvent, errorEvent functions.
LogQueryConfig.LogQueryConfigBuilder	forLogger(String loggerName)
LogQueryConfig.LogQueryConfigBuilder	fromString(String text)	A search method that does a text-based search of log event columns containing the matching text, which is first split into tokens if space, tab or comma delimiters are found in the text.
LogQueryConfig.LogQueryConfigBuilder	limitPageTo(int limit)	This version of limit will limit the result set to the provided value, but if offset is 0, will also attempt to calculate the full resultset size.
LogQueryConfig.LogQueryConfigBuilder	limitTo(int limit)	This sets a limit on the result set, and can be used along with offset.
LogQueryConfig.LogQueryConfigBuilder	newerThan(long time)
LogQueryConfig.LogQueryConfigBuilder	olderThan(long time)
LogQueryConfig.LogQueryConfigBuilder	startingAt(int offset)
LogQueryConfig.LogQueryConfigBuilder	withAnyProperties(String... keyValues)	Filters a set of property/value pairs.
LogQueryConfig.LogQueryConfigBuilder	withinLast(long time, TimeUnits units)
LogQueryConfig.LogQueryConfigBuilder	withTerm(String term)

Methods inherited from class java.lang.Object

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

Method Details

newerThan

public LogQueryConfig.LogQueryConfigBuilder newerThan(long time)

olderThan

public LogQueryConfig.LogQueryConfigBuilder olderThan(long time)

betweenTime

public LogQueryConfig.LogQueryConfigBuilder betweenTime(long startTime,
 long endTime)

withinLast

public LogQueryConfig.LogQueryConfigBuilder withinLast(long time,
 TimeUnits units)

atOrAbove

public LogQueryConfig.LogQueryConfigBuilder atOrAbove(Level level)

withAnyProperties

public LogQueryConfig.LogQueryConfigBuilder withAnyProperties(String... keyValues)

Filters a set of property/value pairs. Must be provided in pairs, the value can include wildcards. They will be treated as "or" conditions, if you want to restrict the results to have all of the properties, additional filtering will have to be done on the results.

eventsForSystems

public LogQueryConfig.LogQueryConfigBuilder eventsForSystems(String... systemIds)

System events are those logged through LoggerEx's infoEvent, warnEvent, errorEvent functions. This function takes a list of system ids to allow in the query.

forLogger

public LogQueryConfig.LogQueryConfigBuilder forLogger(String loggerName)

limitTo

public LogQueryConfig.LogQueryConfigBuilder limitTo(int limit)

This sets a limit on the result set, and can be used along with offset. Note: This function does not attempt to calculate the total return set size that would occur without the limit. For that, use limitPageTo().

limitPageTo

public LogQueryConfig.LogQueryConfigBuilder limitPageTo(int limit)

This version of limit will limit the result set to the provided value, but if offset is 0, will also attempt to calculate the full resultset size.

startingAt

public LogQueryConfig.LogQueryConfigBuilder startingAt(int offset)

fromString

public LogQueryConfig.LogQueryConfigBuilder fromString(String text)

A search method that does a text-based search of log event columns containing the matching text, which is first split into tokens if space, tab or comma delimiters are found in the text. Current implementation executes each term as a LIKE clause, which may be very expensive if a large number of terms are parsed from the text or the columns are not indexed.

withTerm

public LogQueryConfig.LogQueryConfigBuilder withTerm(String term)

build

public LogQueryConfig build()