com.splunk
Class OutputSyslog

java.lang.Object
  extended by com.splunk.Resource
      extended by com.splunk.Entity
          extended by com.splunk.OutputSyslog
All Implemented Interfaces:
java.util.Map<java.lang.String,java.lang.Object>

public class OutputSyslog
extends Entity

The OutputSyslog class represents a syslog output, providing access to properties of a forwarding server that provides data in standard syslog format.


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 getServer()
          Returns the destination host:port of this server.
 java.lang.String getType()
          Returns the connection type of this server.
 void setPriority(int priority)
          Sets the syslog priority.
 void setServer(java.lang.String server)
          Sets the host:port where the syslog data is sent.
 void setTimestampFormat(java.lang.String timestampformat)
          Sets the timestamp format that precedes each event that is sent.
 void setType(java.lang.String type)
          Sets the protocol to use to send syslog data.
 
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, update, 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

getServer

public java.lang.String getServer()
Returns the destination host:port of this server.

Returns:
The destination host:port.

getType

public java.lang.String getType()
Returns the connection type of this server.

Returns:
The connection type.

setPriority

public void setPriority(int priority)
Sets the syslog priority. For more information about the correct values and format, see outputs.conf in the Admin Manual.

Parameters:
priority - The syslog priority.

setServer

public void setServer(java.lang.String server)
Sets the host:port where the syslog data is sent.

Parameters:
server - The destination host:port.

setTimestampFormat

public void setTimestampFormat(java.lang.String timestampformat)
Sets the timestamp format that precedes each event that is sent. For more information about this format, see outputs.conf in the Admin Manual.

Parameters:
timestampformat - The timestamp format.

setType

public void setType(java.lang.String type)
Sets the protocol to use to send syslog data. Valid values are "tcp" and "udp".

Parameters:
type - The protocol type.