Class LogQueryConfig
- java.lang.Object
- 
- com.inductiveautomation.ignition.common.logging.LogQueryConfig
 
- 
- All Implemented Interfaces:
- java.io.Serializable
 
 public class LogQueryConfig extends java.lang.Object implements java.io.SerializableA set of parameters for querying the logging system. Can be created by hand, or with LogQueryConfigBuilder.newBuilder() (the preferred method)If a limit is specified, there might be additional rows available. The result set may have an estimate available, but you can always call query again with the same filter, but with the offset moved forward. - See Also:
- Serialized Form
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classLogQueryConfig.LogQueryConfigBuilderstatic classLogQueryConfig.PropertyFilter
 - 
Constructor SummaryConstructors Constructor Description LogQueryConfig()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAllowedLogger(java.lang.String logger)voidaddAllowedMarker(java.lang.String marker)voidaddPropertyFilter(java.lang.String key, java.lang.String value)voidaddSearchTerm(java.lang.String term)voidaddSearchTerms(java.util.List<java.lang.String> terms)java.util.List<java.lang.String>getAllowedLoggers()java.util.List<java.lang.String>getAllowedMarkers()longgetEndTime()booleangetEstimateTotalSize()intgetLimit()LevelgetMinLevel()intgetOffset()java.util.List<LogQueryConfig.PropertyFilter>getPropertyFilters()java.util.List<java.lang.String>getSearchTerms()longgetStartTime()static LogQueryConfig.LogQueryConfigBuildernewBuilder()voidsetEstimateTotalSize(boolean estimateTotalSize)voidsetLimit(int limit)voidsetMinLevel(Level minLevel)voidsetOffset(int offset)voidsetTimeRange(long start, long end)Sets a time range filter.java.lang.StringtoString()
 
- 
- 
- 
Method Detail- 
addAllowedLoggerpublic void addAllowedLogger(java.lang.String logger) 
 - 
getAllowedLoggerspublic java.util.List<java.lang.String> getAllowedLoggers() 
 - 
addAllowedMarkerpublic void addAllowedMarker(java.lang.String marker) 
 - 
addSearchTermspublic void addSearchTerms(java.util.List<java.lang.String> terms) 
 - 
addSearchTermpublic void addSearchTerm(java.lang.String term) 
 - 
getSearchTermspublic java.util.List<java.lang.String> getSearchTerms() 
 - 
getAllowedMarkerspublic java.util.List<java.lang.String> getAllowedMarkers() 
 - 
getPropertyFilterspublic java.util.List<LogQueryConfig.PropertyFilter> getPropertyFilters() 
 - 
addPropertyFilterpublic void addPropertyFilter(java.lang.String key, java.lang.String value)
 - 
getMinLevelpublic Level getMinLevel() 
 - 
setMinLevelpublic void setMinLevel(Level minLevel) 
 - 
getLimitpublic int getLimit() 
 - 
setLimitpublic void setLimit(int limit) 
 - 
getOffsetpublic int getOffset() 
 - 
setOffsetpublic void setOffset(int offset) 
 - 
getStartTimepublic long getStartTime() 
 - 
getEndTimepublic long getEndTime() 
 - 
setTimeRangepublic void setTimeRange(long start, long end)Sets a time range filter. If either value is 0, it won't be included in the filter. For a time range relative to "now", set end=0, and start = -(ms range).
 - 
getEstimateTotalSizepublic boolean getEstimateTotalSize() 
 - 
setEstimateTotalSizepublic void setEstimateTotalSize(boolean estimateTotalSize) 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
newBuilderpublic static LogQueryConfig.LogQueryConfigBuilder newBuilder() 
 
- 
 
-