Package org.graylog2.plugin.streams
Interface Stream
- All Superinterfaces:
Persisted
- All Known Implementing Classes:
StreamImpl
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final com.google.common.collect.ImmutableSet<String>
A list of all streams that are provided by Graylogstatic final com.google.common.collect.ImmutableSet<String>
Contains all default event streams.static final String
The ID of the default events stream for user generated events.static final String
The ID of the default message stream for all messages.static final String
The ID of the default events stream for system events.static final String
The ID of the stream for message failures.static final com.google.common.collect.ImmutableSet<String>
Contains streams that are not meant to be managed by the user.static final com.google.common.collect.ImmutableSet<String>
Contains streams that are not backed by typicalMessage
objects and should be hidden from a default search request. -
Method Summary
Modifier and TypeMethodDescriptionasMap
(List<StreamRule> streamRules) boolean
getTitle()
boolean
isPaused()
static boolean
void
setContentPack
(String contentPack) void
setDefaultStream
(boolean defaultStream) void
setDescription
(String description) void
setDisabled
(Boolean disabled) void
setIndexSetId
(String indexSetId) void
setMatchingType
(Stream.MatchingType matchingType) void
setRemoveMatchesFromDefaultStream
(boolean removeMatchesFromDefaultStream) void
static boolean
streamIsEditable
(String streamId) Methods inherited from interface org.graylog2.plugin.database.Persisted
asMap, getEmbeddedValidations, getFields, getId, getValidations
-
Field Details
-
DEFAULT_STREAM_ID
The ID of the default message stream for all messages.- See Also:
-
DEFAULT_EVENTS_STREAM_ID
The ID of the default events stream for user generated events.- See Also:
-
DEFAULT_SYSTEM_EVENTS_STREAM_ID
The ID of the default events stream for system events.- See Also:
-
FAILURES_STREAM_ID
The ID of the stream for message failures.- See Also:
-
DEFAULT_EVENT_STREAM_IDS
Contains all default event streams. (e.g. events and system events) -
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
Contains streams that are not backed by typicalMessage
objects and should be hidden from a default search request. -
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
-
setDescription
-
setDisabled
-
setContentPack
-
setMatchingType
-
isPaused
Boolean isPaused() -
asMap
-
getStreamRules
List<StreamRule> getStreamRules() -
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
-
isSystemStreamId
-
streamIsEditable
-