com.splunk
Class WindowsActiveDirectoryInput

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

public class WindowsActiveDirectoryInput
extends Input

The WindowsActiveDirectoryInput class represents a Windows Active Directory 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 getIndex()
          Returns the index name of this Windows Active Directory input.
 InputKind getKind()
          Returns the input type of this Windows Active Directory input.
 boolean getMonitorSubtree()
          Indicates whether the directory path subtree is being monitored for this Windows Active Directory input.
 java.lang.String getStartingNode()
          Returns the starting location in the directory path for this Windows Active Directory input.
 java.lang.String getTargetDc()
          Returns the fully-qualified domain name of a valid, network-accessible domain controller.
 
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

getIndex

public java.lang.String getIndex()
Returns the index name of this Windows Active Directory input.

Returns:
The index name, or null if not specified.

getKind

public InputKind getKind()
Returns the input type of this Windows Active Directory input.

Overrides:
getKind in class Input
Returns:
The input kind.
See Also:
InputKind

getMonitorSubtree

public boolean getMonitorSubtree()
Indicates whether the directory path subtree is being monitored for this Windows Active Directory input.

Returns:
true if the directory path subtree is being monitored, false if not.

getStartingNode

public java.lang.String getStartingNode()
Returns the starting location in the directory path for this Windows Active Directory input. If not specified, the the root of the directory tree is used.

Returns:
The starting location in the directory path, or null if not specified.

getTargetDc

public java.lang.String getTargetDc()
Returns the fully-qualified domain name of a valid, network-accessible domain controller. If not specified, the local machine is used.

Returns:
The fully-qualified domain name, or null if not specified.