com.splunk
Class DistributedConfiguration

java.lang.Object
  com.splunk.Resource
      com.splunk.Entity
          com.splunk.DistributedConfiguration

All Implemented Interfaces:

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

public class DistributedConfiguration
extends Entity

The DistributedConfiguration class represents a Splunk distributed search configuration, providing access to Splunk's distributed search options.

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

protected java.lang.String	actionPath(java.lang.String action) Returns the action path.
boolean	getAutoAddServers() Indicates whether Splunk automatically adds all discovered servers.
java.lang.String	getBlacklistNames() Returns a list of server names that are excluded from being peers.
java.lang.String	getBlacklistUrls() Returns a list of server URLs that are excluded from being peers.
int	getCheckTimedOutServersFrequency() Returns the frequency at which servers that have timed out are rechecked.
int	getConnectionTimeout() Returns the time-out period for connecting to search peers.
int	getHeartbeatFrequency() Returns the period between heartbeat checks on other servers' health.
java.lang.String	getHeartbeatMcastAddress() Returns the multi-cast address where each Splunk server sends and listens for heartbeat messages.
int	getHeartbeatPort() Returns the port where each Splunk server sends and listens for heartbeat messages.
int	getReceiveTimeout() Returns the time-out period for trying to read and receive data from a search peer.
boolean	getRemovedTimedOutServers() Indicates whether timed-out servers are removed from the distributed configuration.
int	getSendTimeout() Returns the time-out period for trying to write or send data to a search peer.
java.lang.String	getServers() Returns a list of peer servers.
int	getServerTimeout() Deprecated. Use specific getConnectionTimeout, getReceiveTimeout, and getSendTimeout. Returns the server time-out period.
boolean	getShareBundles() Indicates whether this server uses bundle replication to share search-time configuration with search peers.
boolean	getSkipOurselves() Indicates whether this server participates in a search.
int	getStatusTimeout() Returns the time-out period for gathering a search peer's basic info (/services/server/info).
int	getTtl() Returns the time-to-live (ttl) of heartbeat messages.
boolean	isDistSearchEnabled() Indicates whether distributed search is enabled.

Methods inherited from class com.splunk.Entity

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

actionPath

protected java.lang.String actionPath(java.lang.String action)

Returns the action path.

Overrides:

actionPath in class Entity

Parameters:

action - The requested action.

Returns:

The action path.

getAutoAddServers

public boolean getAutoAddServers()

Indicates whether Splunk automatically adds all discovered servers.

Returns:

true if Splunk automatically adds servers, false if not.

getBlacklistNames

public java.lang.String getBlacklistNames()

Returns a list of server names that are excluded from being peers.

Returns:

A comma-separated list of excluded servers by name, or null if not available.

getBlacklistUrls

public java.lang.String getBlacklistUrls()

Returns a list of server URLs that are excluded from being peers.

Returns:

A comma-separated list of excluded servers by URL in the format "x.x.x.x:port", or null if not available.

getConnectionTimeout

public int getConnectionTimeout()

Returns the time-out period for connecting to search peers.

Returns:

The connection time-out period, in seconds, or -1 if not specified.

getCheckTimedOutServersFrequency

public int getCheckTimedOutServersFrequency()

Returns the frequency at which servers that have timed out are rechecked. If removeTimedOutServers is false, this setting has no effect.

Returns:

The frequency, in seconds, to recheck timed-out servers. If 0, servers are not rechecked. The default is 60 seconds.

getHeartbeatFrequency

public int getHeartbeatFrequency()

Returns the period between heartbeat checks on other servers' health.

Returns:

The heartbeat period, in seconds. If 0, heartbeat checks are disabled.

getHeartbeatMcastAddress

public java.lang.String getHeartbeatMcastAddress()

Returns the multi-cast address where each Splunk server sends and listens for heartbeat messages.

Returns:

The multi-cast address for discovery and heartbeat messages, or null if not available.

getHeartbeatPort

public int getHeartbeatPort()

Returns the port where each Splunk server sends and listens for heartbeat messages.

Returns:

The heartbeat port.

getReceiveTimeout

public int getReceiveTimeout()

Returns the time-out period for trying to read and receive data from a search peer.

Returns:

The receive time-out period, in seconds, or -1 if not specified.

getRemovedTimedOutServers

public boolean getRemovedTimedOutServers()

Indicates whether timed-out servers are removed from the distributed configuration.

Returns:

true if timed-out servers are removed from the distributed configuration, false if not.

getServerTimeout

public int getServerTimeout()

Deprecated. Use specific getConnectionTimeout, getReceiveTimeout, and getSendTimeout. Returns the server time-out period.

Returns:

The server time-out period, in seconds.

getSendTimeout

public int getSendTimeout()

Returns the time-out period for trying to write or send data to a search peer.

Returns:

The send time-out period, in seconds, or -1 if not specified.

getServers

public java.lang.String getServers()

Returns a list of peer servers.

Returns:

The comma-separated list of peer servers, or null if not available.

getShareBundles

public boolean getShareBundles()

Indicates whether this server uses bundle replication to share search-time configuration with search peers. Note: If set to false, the search head assumes that the search peers can access the correct bundles using an NFS share.

Returns:

true if this server uses bundle replication, false if not.

getSkipOurselves

public boolean getSkipOurselves()

Indicates whether this server participates in a search. If set to true, this server does NOT participate as a server in any search or other call. This setting is used for building a node that does nothing but merge the results from other servers.

Returns:

true if the server does not participate as a server in any search, false if it does.

getStatusTimeout

public int getStatusTimeout()

Returns the time-out period for gathering a search peer's basic info (/services/server/info).

Returns:

The time-out period, in seconds.

getTtl

public int getTtl()

Returns the time-to-live (ttl) of heartbeat messages.

Returns:

The time-to-live of heartbeat messages.

isDistSearchEnabled

public boolean isDistSearchEnabled()

Indicates whether distributed search is enabled.

Returns:

true if distributed search is enabled, false if disabled.