com.splunk
Class EventType

java.lang.Object
  com.splunk.Resource
      com.splunk.Entity
          com.splunk.EventType

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>

public class EventType
extends Entity

The EventType class represents an event type.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.Entity

content, toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title

Method Summary

java.lang.String	getDescription() Returns the description of this event type.
int	getPriority() Returns the priority of this event type.
java.lang.String	getSearch() Returns the search terms for this event type.
java.lang.String[]	getTags() Deprecated. Use tags.conf.spec file to assign tags to groups of events with related field values. Returns the list of tags for this event type.
void	setDescription(java.lang.String description) Sets the description of the event type.
void	setDisabled(boolean disabled) Sets whether the event type is enabled or disabled.
void	setPriority(int priority) Sets the priority of the event type.
void	setSearch(java.lang.String search) Sets the search string.
void	update() Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
void	update(java.util.Map<java.lang.String,java.lang.Object> args) Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, validate, values

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, invalidate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of this event type.

Returns:

The description of this event type.

getPriority

public int getPriority()

Returns the priority of this event type. The range is 1 to 10, with 1 being the highest priority.

Returns:

The priority of this event type.

getSearch

public java.lang.String getSearch()

Returns the search terms for this event type.

Returns:

The search terms for this event type.

getTags

public java.lang.String[] getTags()

Deprecated. Use tags.conf.spec file to assign tags to groups of events with related field values. Returns the list of tags for this event type.

Returns:

The list of tags for this event type.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the event type.

Parameters:

description - The description of the event type.

setDisabled

public void setDisabled(boolean disabled)

Sets whether the event type is enabled or disabled.

Note: Using this method requires you to restart Splunk before this setting takes effect. To avoid restarting Splunk, use the Entity.disable and Entity.enable methods instead, which take effect immediately.

See Also:

Entity.disable(), Entity.enable()

setPriority

public void setPriority(int priority)

Sets the priority of the event type. Valid values are from 1 to 10, with 1 being the highest priority.

Parameters:

priority - The priority of the event type.

setSearch

public void setSearch(java.lang.String search)

Sets the search string.

Parameters:

search - The search string.

update

public void update(java.util.Map<java.lang.String,java.lang.Object> args)

Updates the entity with the values you previously set using the setter methods, and any additional specified arguments. The specified arguments take precedent over the values that were set using the setter methods.

Overrides:

update in class Entity

Parameters:

args - The arguments to update.

update

public void update()

Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.

Overrides:

update in class Entity