com.splunk
Class UdpInput

java.lang.Object
  com.splunk.Resource
      com.splunk.Entity
          com.splunk.Input
              com.splunk.UdpInput

All Implemented Interfaces:

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

public class UdpInput
extends Input

The UdpInput class represents a UDP 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.Resource

actions, path, service, title

Method Summary

java.lang.String	getConnectionHost() Returns the style of host connection.
java.lang.String	getGroup() Returns the group for this UDP input.
java.lang.String	getHost() Returns the source host for this UDP input, where this indexer gets its data.
java.lang.String	getIndex() Returns the index name for this UDP input.
InputKind	getKind() Returns the input type for this UDP input.
java.lang.String	getQueue() Returns the queue for this UDP input.
int	getRcvBuf() Returns the value of the _rcvbuf attribute for this UDP input.
java.lang.String	getSource() Returns the initial source key for this UDP input.
java.lang.String	getSourceType() Returns the event source type for this UDP input.
boolean	noAppendingTimeStamp() Indicates whether Splunk prepends a timestamp and hostname to incoming events.
boolean	noPriorityStripping() Indicates whether Splunk removes the priority field from incoming events.

Methods inherited from class com.splunk.Entity

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

Methods inherited from class com.splunk.Resource

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

getConnectionHost

public java.lang.String getConnectionHost()

Returns the style of host connection. Valid values are: ip, dns, and none.

Returns:

The style of host connection, or null if not specified.

getGroup

public java.lang.String getGroup()

Returns the group for this UDP input.

Returns:

The group.

getHost

public java.lang.String getHost()

Returns the source host for this UDP input, where this indexer gets its data.

Returns:

The source host, or null if not specified.

getIndex

public java.lang.String getIndex()

Returns the index name for this UDP input.

Returns:

The index name.

getKind

public InputKind getKind()

Returns the input type for this UDP input.

Overrides:

getKind in class Input

Returns:

The input kind.

See Also:

InputKind

getQueue

public java.lang.String getQueue()

Returns the queue for this UDP input. Valid values are: parsingQueue and indexQueue.

Returns:

The queue, or null if not specified.

getRcvBuf

public int getRcvBuf()

Returns the value of the _rcvbuf attribute for this UDP input.

Returns:

The _rcvbuf value.

getSource

public java.lang.String getSource()

Returns the initial source key for this UDP input. Typically, this value is the input file path.

Returns:

The source, or null if not specified.

getSourceType

public java.lang.String getSourceType()

Returns the event source type for this UDP input.

Returns:

The event source type, or null if not specified.

noAppendingTimeStamp

public boolean noAppendingTimeStamp()

Indicates whether Splunk prepends a timestamp and hostname to incoming events.

Returns:

true if Splunk does not prepend a timestamp and hostname to incoming events, false if it does.

noPriorityStripping

public boolean noPriorityStripping()

Indicates whether Splunk removes the priority field from incoming events.

Returns:

true if Splunk does not remove the priority field from incoming syslog events, false if it does.