com.splunk
Class DistributedPeer

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

public class DistributedPeer
extends Entity

The DistributedPeer class represents a Splunk distributed peer, providing distributed peer server management.


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
toUpdate
 
Fields inherited from class com.splunk.Resource
actions, path, refreshArgs, service, title
 
Method Summary
 int getBuild()
          Returns this peer's build number.
 java.lang.String[] getBundleVersions()
          Returns a list of bundle versions.
 java.lang.String getGuid()
          Returns this peer's GUID.
 java.lang.String getLicenseSignature()
          Returns this peer's license signature.
 java.lang.String getPeerName()
          Returns this peer's name.
 java.lang.String getPeerType()
          Returns this peer's type.
 java.lang.String getReplicationStatus()
          Returns this peer's replication status.
 java.lang.String getStatus()
          Return this peer's overall status.
 java.lang.String getVersion()
          Returns this peer's version.
 boolean isHttps()
          Indicates whether this peer is using HTTPS.
 void setRemotePassword(java.lang.String password)
          Sets the remote password.
 void setRemoteUsername(java.lang.String username)
          Sets the remote username.
 
Methods inherited from class com.splunk.Entity
actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, 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

getBuild

public int getBuild()
Returns this peer's build number.

Returns:
The build number.

getBundleVersions

public java.lang.String[] getBundleVersions()
Returns a list of bundle versions.

Returns:
The bundle versions, or null if not specified.

getGuid

public java.lang.String getGuid()
Returns this peer's GUID.

Returns:
The GUID, or null if not specified.

getLicenseSignature

public java.lang.String getLicenseSignature()
Returns this peer's license signature.

Returns:
The license signature, or null if not specified.

getPeerName

public java.lang.String getPeerName()
Returns this peer's name.

Returns:
The name, or null if not specified.

getPeerType

public java.lang.String getPeerType()
Returns this peer's type.

Returns:
The type, or null if not specified.

getReplicationStatus

public java.lang.String getReplicationStatus()
Returns this peer's replication status.

Returns:
The replication status, or null if not specified.

getStatus

public java.lang.String getStatus()
Return this peer's overall status.

Returns:
The overall status, or null if not specified.

getVersion

public java.lang.String getVersion()
Returns this peer's version.

Returns:
The version, or null if not specified.

isHttps

public boolean isHttps()
Indicates whether this peer is using HTTPS.

Returns:
true if this peer is using HTTPS, false if not.

setRemotePassword

public void setRemotePassword(java.lang.String password)
Sets the remote password.

Note: The username and password must be set at the same time.

Parameters:
password - The remote password.
See Also:
setRemoteUsername(java.lang.String)

setRemoteUsername

public void setRemoteUsername(java.lang.String username)
Sets the remote username.

Note: The username and password must be set at the same time.

Parameters:
username - The remote username.
See Also:
setRemotePassword(java.lang.String)