MonitorInput (splunk 1.9.1 API)

java.lang.Object
- com.splunk.Resource
- - com.splunk.Entity
  - - com.splunk.Input
    - - com.splunk.MonitorInput

All Implemented Interfaces:

Map<String,Object>
```
public class MonitorInput
extends Input
```
The MonitorInput class represents a monitor input, which is a file, directory, script, or network port that is monitored for new data.

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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getBlacklist()` Returns a regular expression for a file path that when matched is not indexed.
`String`	`getCrcSalt()` Returns a string that is used to force Splunk to index files that have a matching cyclic redundancy check (CRC).
`int`	`getFileCount()` Returns the file count of this monitor input.
`boolean`	`getFollowTail()` Indicates whether files that are seen for the first time will be read from the end.
`String`	`getHost()` Returns the host for this monitor input.
`String`	`getHostRegex()` Returns the regular expression for a file path to determine the host.
`String`	`getIgnoreOlderThan()` Returns a time value that defines a rolling time window for monitoring files.
`String`	`getIndex()` Gets the index where events from this monitor input are stored.
`InputKind`	`getKind()` Returns the type of monitor input.
`String`	`getQueue()` Returns the queue for this monitor input.
`int`	`getRcvBuf()` Deprecated. Returns the value of the `_rcvbuf` attribute for this monitor input.
`boolean`	`getRecursive()` Indicates whether sub-directories are monitored within this monitor input.
`String`	`getSource()` Returns the source of events from this monitor input.
`String`	`getSourceType()` Returns the source type of events from this monitor input.
`int`	`getTimeBeforeClose()` Returns the time period for keeping a file open.
`String`	`getWhitelist()` Returns a regular expression for a file path that, when matched, is indexed.
`void`	`setBlacklist(String blacklist)` Sets a regular expression for a file path that, when matched, is not indexed.
`void`	`setCheckIndex(boolean index)` Sets whether the `index` value is checked to ensure that it is the name of a valid index.
`void`	`setCheckPath(boolean path)` Sets whether the `name` value is checked to ensure that it exists.
`void`	`setCrcSalt(String salt)` Sets a string that is used to force Splunk to index files that have a matching cyclic redundancy check (CRC).
`void`	`setFollowTail(boolean followTail)` Sets whether files that are seen for the first time will be read from the end.
`void`	`setHost(String host)` Sets the value to populate in the host field for events from this monitor input.
`void`	`setHostRegex(String regex)` Set the regular expression for a file path to determine the host.
`void`	`setHostSegment(String segment)` Sets the specified slash-separate segment of the file path as the host field value.
`void`	`setIgnoreOlderThan(String time)` Sets a time value that defines a rolling time window for monitoring files.
`void`	`setIndex(String index)` Sets the index where events from this monitor input are stored.
`void`	`setRecursive(boolean recursive)` Sets whether to monitor sub-directories within this monitor input.
`void`	`setRenameSource(String name)` Sets the name to populate in the source field for events from this monitor input.
`void`	`setSourcetype(String sourcetype)` Sets the source type to populate in the sourcetype field for events from this monitor input.
`void`	`setTimeBeforeClose(int period)` Sets the time period for keeping a file open.
`void`	`setWhitelist(String whitelist)` Sets a regular expression for a file path that, when matched, is indexed.

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, 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
  - getBlacklist
```
public String getBlacklist()
```
    Returns a regular expression for a file path that when matched is not indexed.
    
    Returns:
    
    The regex for a file path.
  - getCrcSalt
```
public String getCrcSalt()
```
    Returns a string that is used to force Splunk to index files that have a matching cyclic redundancy check (CRC). When set, this string is added to the CRC. If the string is "<SOURCE>", the full source path is added to the CRC, ensuring that each file being monitored has a unique CRC. For more info, see the Edit inputs.conf topic in the Getting Data In manual.
    
    Returns:
    
    The string that is added to the CRC, or null if not set.
  - getFileCount
```
public int getFileCount()
```
    Returns the file count of this monitor input.
    
    Returns:
    
    The file count.
  - getFollowTail
```
public boolean getFollowTail()
```
    Indicates whether files that are seen for the first time will be read from the end.
    
    Returns:
    
    true if new files are read from the end, false if not.
  - getHost
```
public String getHost()
```
    Returns the host for this monitor input.
    
    Returns:
    
    The host, or null if not specified.
  - getHostRegex
```
public String getHostRegex()
```
    Returns the regular expression for a file path to determine the host. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this monitor input. The regular expression must have one capture group.
    
    Returns:
    
    The regular expression for a file path.
  - getIgnoreOlderThan
```
public String getIgnoreOlderThan()
```
    Returns a time value that defines a rolling time window for monitoring files. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.
    
    Returns:
    
    The time value.
  - getIndex
```
public String getIndex()
```
    Gets the index where events from this monitor input are stored.
    
    Returns:
    
    The index name.
  - getKind
```
public InputKind getKind()
```
    Returns the type of monitor input.
    
    Overrides:
    
    getKind in class Input
    
    Returns:
    
    The input kind.
  - getQueue
```
public String getQueue()
```
    Returns the queue for this monitor input. Valid values are "parsingQueue" and "indexQueue".
    
    Returns:
    
    The queue, or null if not specified.
  - getRecursive
```
public boolean getRecursive()
```
    Indicates whether sub-directories are monitored within this monitor input.
    
    Returns:
    
    true if sub-directories are monitored, false if not.
  - getRcvBuf
```
public int getRcvBuf()
```
    Deprecated. Returns the value of the _rcvbuf attribute for this monitor input.
    
    Returns:
    
    The _rcvbuf value.
  - getSource
```
public String getSource()
```
    Returns the source of events from this monitor input.
    
    Returns:
    
    The source name.
  - getSourceType
```
public String getSourceType()
```
    Returns the source type of events from this monitor input.
    
    Returns:
    
    The source type.
  - getTimeBeforeClose
```
public int getTimeBeforeClose()
```
    Returns the time period for keeping a file open.
    
    Returns:
    
    The time to keep a file open, in seconds.
  - getWhitelist
```
public String getWhitelist()
```
    Returns a regular expression for a file path that, when matched, is indexed.
    
    Returns:
    
    The regular expression for a file path.
  - setBlacklist
```
public void setBlacklist(String blacklist)
```
    Sets a regular expression for a file path that, when matched, is not indexed.
    
    Parameters:
    
    blacklist - The regular expression for a file path.
  - setCheckIndex
```
public void setCheckIndex(boolean index)
```
    Sets whether the index value is checked to ensure that it is the name of a valid index.
    
    Parameters:
    
    index - true to verify index, false if not.
  - setCheckPath
```
public void setCheckPath(boolean path)
```
    Sets whether the name value is checked to ensure that it exists.
    
    Parameters:
    
    path - true to verify name, false if not.
  - setCrcSalt
```
public void setCrcSalt(String salt)
```
    Sets a string that is used to force Splunk to index files that have a matching cyclic redundancy check (CRC). When set, this string is added to the CRC. If the string is "<SOURCE>", the full source path is added to the CRC, ensuring that each file being monitored has a unique CRC. For more info, see the Edit inputs.conf topic in the Getting Data In manual.
    
    Parameters:
    
    salt - The string that is added to the CRC.
  - setFollowTail
```
public void setFollowTail(boolean followTail)
```
    Sets whether files that are seen for the first time will be read from the end.
    
    Parameters:
    
    followTail - true to read new files from the end, false if not.
  - setHost
```
public void setHost(String host)
```
    Sets the value to populate in the host field for events from this monitor input.
    
    Parameters:
    
    host - The value for the host field.
  - setHostRegex
```
public void setHostRegex(String regex)
```
    Set the regular expression for a file path to determine the host. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this monitor input. The regular expression must have one capture group.
    
    Parameters:
    
    regex - The regular expression for a file path.
  - setHostSegment
```
public void setHostSegment(String segment)
```
    Sets the specified slash-separate segment of the file path as the host field value.
    
    Parameters:
    
    segment - The slash-separate segment.
  - setIgnoreOlderThan
```
public void setIgnoreOlderThan(String time)
```
    Sets a time value that defines a rolling time window for monitoring files. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.
    
    Parameters:
    
    time - The time value.
  - setIndex
```
public void setIndex(String index)
```
    Sets the index where events from this monitor input are stored.
    
    Parameters:
    
    index - The index name.
  - setRecursive
```
public void setRecursive(boolean recursive)
```
    Sets whether to monitor sub-directories within this monitor input.
    
    Parameters:
    
    recursive - true to monitor sub-directories, false if not.
  - setRenameSource
```
public void setRenameSource(String name)
```
    Sets the name to populate in the source field for events from this monitor input. The same source name should not be used for multiple data inputs.
    
    Parameters:
    
    name - The source name.
  - setSourcetype
```
public void setSourcetype(String sourcetype)
```
    Sets the source type to populate in the sourcetype field for events from this monitor input.
    
    Parameters:
    
    sourcetype - The source type.
  - setTimeBeforeClose
```
public void setTimeBeforeClose(int period)
```
    Sets the time period for keeping a file open.
    
    Parameters:
    
    period - The time to keep a file open, in seconds.
  - setWhitelist
```
public void setWhitelist(String whitelist)
```
    Sets a regular expression for a file path that, when matched, is indexed.
    
    Parameters:
    
    whitelist - The regular expression for the file path.

Class MonitorInput

Nested Class Summary

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

Field Summary

Fields inherited from class com.splunk.Entity

Fields inherited from class com.splunk.Resource

Method Summary

Methods inherited from class com.splunk.Entity

Methods inherited from class com.splunk.Resource

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Method Detail

getBlacklist

getCrcSalt

getFileCount

getFollowTail

getHost

getHostRegex

getIgnoreOlderThan

getIndex

getKind

getQueue

getRecursive

getRcvBuf

getSource

getSourceType

getTimeBeforeClose

getWhitelist

setBlacklist

setCheckIndex

setCheckPath

setCrcSalt

setFollowTail

setHost

setHostRegex

setHostSegment

setIgnoreOlderThan

setIndex

setRecursive

setRenameSource

setSourcetype

setTimeBeforeClose

setWhitelist