Package org.graylog2.plugin.streams

Interface Stream

All Superinterfaces:
Persisted
All Known Implementing Classes:
StreamImpl
public interface Stream extends Persisted

  • Field Details

    • DEFAULT_STREAM_ID

      static final String DEFAULT_STREAM_ID
      The ID of the default message stream for all messages.
      See Also:

    • DEFAULT_EVENTS_STREAM_ID

      static final String DEFAULT_EVENTS_STREAM_ID
      The ID of the default events stream for user generated events.
      See Also:

    • DEFAULT_SYSTEM_EVENTS_STREAM_ID

      static final String DEFAULT_SYSTEM_EVENTS_STREAM_ID
      The ID of the default events stream for system events.
      See Also:

    • FAILURES_STREAM_ID

      static final String FAILURES_STREAM_ID
      The ID of the stream for message failures.
      See Also:

    • DEFAULT_EVENT_STREAM_IDS

      static final com.google.common.collect.ImmutableSet<String> DEFAULT_EVENT_STREAM_IDS
      Contains all default event streams. (e.g. events and system events)

    • NON_EDITABLE_STREAM_IDS

      static final com.google.common.collect.ImmutableSet<String> NON_EDITABLE_STREAM_IDS
      Contains streams that are not meant to be managed by the user. These streams also don't work for other stream features like stream rules or outputs.

    • NON_MESSAGE_STREAM_IDS

      static final com.google.common.collect.ImmutableSet<String> NON_MESSAGE_STREAM_IDS
      Contains streams that are not backed by typical Message objects and should be hidden from a default search request.

    • ALL_SYSTEM_STREAM_IDS

      static final com.google.common.collect.ImmutableSet<String> ALL_SYSTEM_STREAM_IDS
      A list of all streams that are provided by Graylog

  • Method Details

    • getTitle

      String getTitle()

    • getDescription

      String getDescription()

    • getDisabled

      Boolean getDisabled()

    • getContentPack

      String getContentPack()

    • setTitle

      void setTitle(String title)

    • setDescription

      void setDescription(String description)

    • setDisabled

      void setDisabled(Boolean disabled)

    • setContentPack

      void setContentPack(String contentPack)

    • setMatchingType

      void setMatchingType(Stream.MatchingType matchingType)

    • isPaused

      Boolean isPaused()

    • asMap

      Map<String,Object> asMap(List<StreamRule> streamRules)

    • getStreamRules

      List<StreamRule> getStreamRules()

    • getOutputs

      Set<Output> getOutputs()

    • getMatchingType

      Stream.MatchingType getMatchingType()

    • isDefaultStream

      boolean isDefaultStream()

    • setDefaultStream

      void setDefaultStream(boolean defaultStream)

    • getRemoveMatchesFromDefaultStream

      boolean getRemoveMatchesFromDefaultStream()

    • setRemoveMatchesFromDefaultStream

      void setRemoveMatchesFromDefaultStream(boolean removeMatchesFromDefaultStream)

    • getIndexSet

      IndexSet getIndexSet()

    • getIndexSetId

      String getIndexSetId()

    • setIndexSetId

      void setIndexSetId(String indexSetId)

    • isSystemStreamId

      static boolean isSystemStreamId(String id)

    • streamIsEditable

      static boolean streamIsEditable(String streamId)