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.Serializable
A 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 Summary
Nested Classes Modifier and Type Class Description static class
LogQueryConfig.LogQueryConfigBuilder
static class
LogQueryConfig.PropertyFilter
-
Constructor Summary
Constructors Constructor Description LogQueryConfig()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAllowedLogger(java.lang.String logger)
void
addAllowedMarker(java.lang.String marker)
void
addPropertyFilter(java.lang.String key, java.lang.String value)
void
addSearchTerm(java.lang.String term)
void
addSearchTerms(java.util.List<java.lang.String> terms)
java.util.List<java.lang.String>
getAllowedLoggers()
java.util.List<java.lang.String>
getAllowedMarkers()
long
getEndTime()
boolean
getEstimateTotalSize()
int
getLimit()
Level
getMinLevel()
int
getOffset()
java.util.List<LogQueryConfig.PropertyFilter>
getPropertyFilters()
java.util.List<java.lang.String>
getSearchTerms()
long
getStartTime()
static LogQueryConfig.LogQueryConfigBuilder
newBuilder()
void
setEstimateTotalSize(boolean estimateTotalSize)
void
setLimit(int limit)
void
setMinLevel(Level minLevel)
void
setOffset(int offset)
void
setTimeRange(long start, long end)
Sets a time range filter.java.lang.String
toString()
-
-
-
Method Detail
-
addAllowedLogger
public void addAllowedLogger(java.lang.String logger)
-
getAllowedLoggers
public java.util.List<java.lang.String> getAllowedLoggers()
-
addAllowedMarker
public void addAllowedMarker(java.lang.String marker)
-
addSearchTerms
public void addSearchTerms(java.util.List<java.lang.String> terms)
-
addSearchTerm
public void addSearchTerm(java.lang.String term)
-
getSearchTerms
public java.util.List<java.lang.String> getSearchTerms()
-
getAllowedMarkers
public java.util.List<java.lang.String> getAllowedMarkers()
-
getPropertyFilters
public java.util.List<LogQueryConfig.PropertyFilter> getPropertyFilters()
-
addPropertyFilter
public void addPropertyFilter(java.lang.String key, java.lang.String value)
-
getMinLevel
public Level getMinLevel()
-
setMinLevel
public void setMinLevel(Level minLevel)
-
getLimit
public int getLimit()
-
setLimit
public void setLimit(int limit)
-
getOffset
public int getOffset()
-
setOffset
public void setOffset(int offset)
-
getStartTime
public long getStartTime()
-
getEndTime
public long getEndTime()
-
setTimeRange
public 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).
-
getEstimateTotalSize
public boolean getEstimateTotalSize()
-
setEstimateTotalSize
public void setEstimateTotalSize(boolean estimateTotalSize)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
newBuilder
public static LogQueryConfig.LogQueryConfigBuilder newBuilder()
-
-