com.splunk

Class TcpSplunkInput

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Input

com.splunk.TcpSplunkInput

All Implemented Interfaces:

Map<String,Object>

public class TcpSplunkInput
extends Input

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

Nested Class Summary

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

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
TcpConnections	connections() Returns an object that contains the inbound cooked TCP connections.
String	getConnectionHost() Returns the style of host connection.
String	getGroup() Returns the group for this cooked TCP input.
String	getHost() Returns the source host for this cooked TCP input where this indexer gets its data.
String	getIndex() Returns the index name for this cooked TCP input.
InputKind	getKind() Returns the input kind of this input.
int	getPort() Returns the port that this input is listening on.
String	getQueue() Returns the queue for this cooked TCP input.
int	getRcvBuf() Deprecated. Returns the value of the _rcvbuf attribute for this cooked TCP input.
String	getRestrictToHost() Returns the incoming host restriction for this cooked TCP input.
String	getSource() Returns the initial source key for this cooked TCP input.
String	getSourceType() Returns the event source type for this cooked TCP input.
boolean	getSSL() Indicates whether this cooked TCP input is using secure socket layer (SSL).
void	setConnectionHost(String connection_host) Sets the value for the from-host field for the remote server that is sending data.
void	setDisabled(boolean disabled) Sets whether this input is enabled or disabled.
void	setHost(String host) Sets the host from which the indexer gets data.
void	setSSL(boolean SSL) Sets whether to use secure socket layer (SSL).
void	update(Map<String,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, update, 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

connections

public TcpConnections connections()

Returns an object that contains the inbound cooked TCP connections.

Returns:

The TCP connections object.

getConnectionHost

public 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 String getGroup()

Returns the group for this cooked TCP input.

Returns:

The group.

getHost

public String getHost()

Returns the source host for this cooked TCP input where this indexer gets its data.

Returns:

The source host, or null if not specified.

getIndex

public String getIndex()

Returns the index name for this cooked TCP 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.

getQueue

public String getQueue()

Returns the queue for this cooked TCP input. Valid values are: "parsingQueue" and "indexQueue".

Returns:

The queue, or null if not specified.

getRcvBuf

public int getRcvBuf()

Deprecated. Returns the value of the _rcvbuf attribute for this cooked TCP input.

Returns:

The _rcvbuf value.

getRestrictToHost

public String getRestrictToHost()

Returns the incoming host restriction for this cooked TCP input.

Returns:

The incoming host restriction, or null if not specified.

getSource

public String getSource()

Returns the initial source key for this cooked TCP input. Typically this value is the input file path.

Returns:

The source, or null if not specified.

getSourceType

public String getSourceType()

Returns the event source type for this cooked TCP input.

Returns:

The event source type, or null if not specified.

getSSL

public boolean getSSL()

Indicates whether this cooked TCP input is using secure socket layer (SSL).

Returns:

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

setSSL

public void setSSL(boolean SSL)

Sets whether to use secure socket layer (SSL).

Parameters:

SSL - true to use SSL, false if not.

setConnectionHost

public void setConnectionHost(String connection_host)

Sets the value for the from-host field for the remote server that is sending data. Valid values are:

• "ip": Sets the host to the IP address of the remote server sending data.
• "dns": Sets the host to the reverse DNS entry for the IP address of the remote server sending data.
• "none": Leaves the host as specified in inputs.conf, which is typically the Splunk system host name.

Parameters:

connection_host - The connection host information.

setDisabled

public void setDisabled(boolean disabled)

Sets whether this input 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.

Parameters:

disabled - true to disable this input, false to enable it.

setHost

public void setHost(String host)

Sets the host from which the indexer gets data.

Parameters:

host - The host.

getPort

public int getPort()

Returns the port that this input is listening on.

Returns:

int value

update

public void update(Map<String,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 the update method to additionally update this input's path if the RestrictToHost property is changed.

Overrides:

update in class Entity

Parameters:

args - The arguments to update.