Package com.carfey.ops.api.bean.log

Class LogListingParameters

  • public class LogListingParameters
extends java.lang.Object
    Used to filter a LogListing via LogManager.
    Since:
    3.0

    • Constructor Detail

      • LogListingParameters

        public LogListingParameters()

    • Method Detail

      • getStartDate

        public com.carfey.jdk.lang.DateTime getStartDate()
        Limits the listing to the selected start time (based on scheduled time). Defaults to 24 hours ago.
        Returns:
        start date

      • setStartDate

        public void setStartDate​(com.carfey.jdk.lang.DateTime startDate)

      • withStartDate

        public LogListingParameters withStartDate​(com.carfey.jdk.lang.DateTime startDate)

      • getEndDate

        public com.carfey.jdk.lang.DateTime getEndDate()
        Limits the listing to the selected end time (based on scheduled time). Defaults to 24 hours after start date.
        Returns:
        end date

      • setEndDate

        public void setEndDate​(com.carfey.jdk.lang.DateTime endDate)

      • getFilterText

        public java.lang.String getFilterText()
        Limits results to those with summary or message text matching the supplied text. The wildcard character '%' may be used along with regular characters.
        Returns:
        filter text

      • setFilterText

        public void setFilterText​(java.lang.String filterText)

      • getCategories

        public java.util.List<Category> getCategories()
        If non-empty, limits results to those matching a supplied category.
        Returns:
        categories

      • setCategories

        public void setCategories​(java.util.List<Category> categories)

      • getLevels

        public java.util.List<LogLevel> getLevels()
        If non-empty, limits results to those matching a supplied severity log level.
        Returns:
        log levels

      • setLevels

        public void setLevels​(java.util.List<LogLevel> levels)

      • getHosts

        public java.util.List<java.lang.String> getHosts()
        If non-empty, limits results to those matching a supplied host name.
        Returns:
        hosts

      • setHosts

        public void setHosts​(java.util.List<java.lang.String> hosts)

      • getStartKey

        public java.lang.String getStartKey()
        Used to fetch a subsequent page of results, based on the key returned by LogListing.
        Returns:
        start key

      • setStartKey

        public void setStartKey​(java.lang.String startKey)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object