com.splunk
Class TcpSplunkInput

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

All Implemented Interfaces:

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

public class TcpSplunkInput
extends Input

The TcpSplunkInput class represents a TCP Splunk-processed "cooked" input. This differs from a TCP raw input in that this TCP cooked data is processed by Splunk and is not in raw form.

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 TCP cooked input.
java.lang.String	getHost() Returns the source host for this TCP cooked input where this indexer gets its data.
java.lang.String	getIndex() Returns the index name for this TCP cooked input.
InputKind	getKind() Returns the input type for this TCP cooked input.
java.lang.String	getQueue() Returns the queue for this TCP cooked input.
int	getRcvBuf() Returns the value of the _rcvbuf attribute for this TCP cooked input.
java.lang.String	getRestrictToHost() Returns the incoming host restriction for this TCP cooked input.
java.lang.String	getSource() Returns the initial source key for this TCP cooked input.
java.lang.String	getSourceType() Returns the event source type for this TCP cooked input.
boolean	getSSL() Indicates whether this TCP cooked input is using SSL.

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 TCP cooked input.

Returns:

The group.

getHost

public java.lang.String getHost()

Returns the source host for this TCP cooked 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 TCP cooked input.

Returns:

The index name, or null if not specified.

getKind

public InputKind getKind()

Returns the input type for this TCP cooked input.

Overrides:

getKind in class Input

Returns:

The input kind.

See Also:

InputKind

getQueue

public java.lang.String getQueue()

Returns the queue for this TCP cooked 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 TCP cooked input.

Returns:

The _rcvbuf value.

getRestrictToHost

public java.lang.String getRestrictToHost()

Returns the incoming host restriction for this TCP cooked input.

Returns:

The incoming host restriction, or null if not specified.

getSource

public java.lang.String getSource()

Returns the initial source key for this TCP cooked 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 TCP cooked input.

Returns:

The event source type, or null if not specified.

getSSL

public boolean getSSL()

Indicates whether this TCP cooked input is using SSL.

Returns:

true if this TCP cooked input is using SSL, false if not.