Class MessageSearchOptions.Builder

java.lang.Object
codes.grow.packages.graylog.MessageSearchOptions.Builder
Enclosing class:
MessageSearchOptions

public static final class MessageSearchOptions.Builder extends Object
  • Method Details

    • range

      public MessageSearchOptions.Builder range(Duration range)
      Sets a relative range ending now (default 300 s when no other range is given).
      Parameters:
      range - positive duration
      Returns:
      this builder
    • start

      public MessageSearchOptions.Builder start(Instant start)
      Sets the start of an absolute range (default end minus 300 s).
      Parameters:
      start - instant
      Returns:
      this builder
    • end

      Sets the end of an absolute range (default now).
      Parameters:
      end - instant
      Returns:
      this builder
    • keyword

      public MessageSearchOptions.Builder keyword(String keyword)
      Sets a Graylog keyword range such as "last five minutes".
      Parameters:
      keyword - keyword
      Returns:
      this builder
    • limit

      public MessageSearchOptions.Builder limit(int limit)
      Sets the page size (default 100, at most 10 000).
      Parameters:
      limit - 1..10000
      Returns:
      this builder
    • offset

      public MessageSearchOptions.Builder offset(int offset)
      Sets how many matches to skip (pagination).
      Parameters:
      offset - non-negative offset
      Returns:
      this builder
    • fields

      public MessageSearchOptions.Builder fields(String... fields)
      Limits the returned fields.
      Parameters:
      fields - field names
      Returns:
      this builder
    • sort

      Sets the sort keys; later keys break ties.
      Parameters:
      sort - sort keys
      Returns:
      this builder
    • streams

      public MessageSearchOptions.Builder streams(String... streams)
      Restricts the search to these stream ids.
      Parameters:
      streams - stream ids
      Returns:
      this builder
    • streams

      public MessageSearchOptions.Builder streams(List<String> streams)
      Restricts the search to these stream ids.
      Parameters:
      streams - stream ids
      Returns:
      this builder
    • build

      public MessageSearchOptions build()
      Builds the options (validated by the search call).
      Returns:
      the options