com.splunk

Class WindowsEventLogInput

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Input

com.splunk.WindowsEventLogInput

All Implemented Interfaces:

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

public class WindowsEventLogInput
extends Input

The WindowsEventLogInput class represents a Windows Event Log data input.

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, updated

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHosts() Returns a list of secondary hosts used for monitoring.
java.lang.String	getIndex() Returns the index name of this Windows Event Log input.
InputKind	getKind() Returns the input kind of this input.
java.lang.String	getLocalName() Returns the collection name of this Windows Event Log input.
java.lang.String[]	getLogs() Returns the list of event log names to gather data from for this Windows Event Log input.
java.lang.String	getLookupHost() Returns the main host of this Windows Event Log input.
void	setHosts(java.lang.String hosts) Sets a list of secondary hosts to be used for monitoring.
void	setIndex(java.lang.String index) Sets the index in which to store all generated events.
void	setLogs(java.lang.String logs) Sets the list of event log names to gather data from.
void	setLookupHost(java.lang.String lookup_host) Sets the main host from which to monitor log events.
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, getUpdated, 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

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

getHosts

public java.lang.String getHosts()

Returns a list of secondary hosts used for monitoring. To list the main host, use the getLookupHost method.

Returns:

A comma-separated list of additional hosts used in monitoring, or null if not specified.

See Also:

getLookupHost()

getIndex

public java.lang.String getIndex()

Returns the index name of this Windows Event Log input.

Returns:

The index name, or null if not specified.

getKind

public InputKind getKind()

Returns the input kind of this input.

Overrides:

getKind in class Input

Returns:

The input kind.

getLogs

public java.lang.String[] getLogs()

Returns the list of event log names to gather data from for this Windows Event Log input.

Returns:

The list of event log names, or null if not specified.

getLocalName

public java.lang.String getLocalName()

Returns the collection name of this Windows Event Log input. This name appears in the configuration file, the source, and the sourcetype of the indexed data. If the value is "localhost", it will use native event log collection; otherwise, it will use WMI.

Returns:

The collection name.

getLookupHost

public java.lang.String getLookupHost()

Returns the main host of this Windows Event Log input. To list secondary hosts, use the getHosts method.

Returns:

The main host.

See Also:

getHosts()

setHosts

public void setHosts(java.lang.String hosts)

Sets a list of secondary hosts to be used for monitoring. Specify the main host using the setLookupHost method.

Parameters:

hosts - The comma-separated list of additional hosts.

See Also:

setLookupHost(java.lang.String)

setIndex

public void setIndex(java.lang.String index)

Sets the index in which to store all generated events.

Parameters:

index - The index name.

setLogs

public void setLogs(java.lang.String logs)

Sets the list of event log names to gather data from.

Parameters:

logs - The list of event log names.

setLookupHost

public void setLookupHost(java.lang.String lookup_host)

Sets the main host from which to monitor log events. To specify additional hosts to use for monitoring, use the setHosts method.

Parameters:

lookup_host - The main host.

See Also:

setHosts(java.lang.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