org.graylog2.plugin.streams

Interface Stream

All Superinterfaces:

Persisted

All Known Implementing Classes:

StreamImpl

public interface Stream
extends Persisted

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Stream.MatchingType

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableSet<String>	DEFAULT_EVENT_STREAM_IDS Contains all default event streams.
static String	DEFAULT_EVENTS_STREAM_ID The ID of the default events stream for user generated events.
static String	DEFAULT_STREAM_ID The ID of the default message stream for all messages.
static String	DEFAULT_SYSTEM_EVENTS_STREAM_ID The ID of the default events stream for system events.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap(List<StreamRule> streamRules)
Map<String,List<String>>	getAlertReceivers()
String	getContentPack()
String	getDescription()
Boolean	getDisabled()
IndexSet	getIndexSet()
String	getIndexSetId()
Stream.MatchingType	getMatchingType()
Set<Output>	getOutputs()
boolean	getRemoveMatchesFromDefaultStream()
List<StreamRule>	getStreamRules()
String	getTitle()
boolean	isDefaultStream()
static boolean	isDefaultStreamId(String id)
Boolean	isPaused()
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	setTitle(String title)

Methods inherited from interface org.graylog2.plugin.database.Persisted

asMap, getEmbeddedValidations, getFields, getId, getValidations

Field Detail

DEFAULT_STREAM_ID

static final String DEFAULT_STREAM_ID

The ID of the default message stream for all messages.

See Also:

Constant Field Values

DEFAULT_EVENTS_STREAM_ID

static final String DEFAULT_EVENTS_STREAM_ID

The ID of the default events stream for user generated events.

See Also:

Constant Field Values

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:

Constant Field Values

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)

Method Detail

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()

getAlertReceivers

Map<String,List<String>> getAlertReceivers()

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)

isDefaultStreamId

static boolean isDefaultStreamId(String id)