com.splunk
Class DeploymentClient

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

public class DeploymentClient
extends Entity

The DeploymentClient class represents a Splunk deployment client, providing access to deployment client configuration and status.


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
protected  java.lang.String actionPath(java.lang.String action)
          Displays the action path.
 void disable()
          Not supported for this endpoint.
 void enable()
          Not supported for this endpoint.
 java.lang.String[] getServerClasses()
          Returns the list of server classes.
 java.lang.String getTargetUri()
          Returns the target URI of the deployment server for this deployment client.
 void reload()
          Reloads the deployment client from the configuration file.
 void setDisabled(boolean disabled)
          Sets whether to enable or disable the deployment client.
 void setTargetUri(java.lang.String targetUri)
          Sets the deployment server's target URI for this deployment client.
 
Methods inherited from class com.splunk.Entity
clear, containsKey, containsValue, 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

actionPath

protected java.lang.String actionPath(java.lang.String action)
Displays the action path.

Overrides:
actionPath in class Entity
Parameters:
action - The requested action.
Returns:
The action path.

disable

public void disable()
Not supported for this endpoint.

Overrides:
disable in class Entity

enable

public void enable()
Not supported for this endpoint.

Overrides:
enable in class Entity

getServerClasses

public java.lang.String[] getServerClasses()
Returns the list of server classes.

Returns:
The list of server classes, or null if not specified.

getTargetUri

public java.lang.String getTargetUri()
Returns the target URI of the deployment server for this deployment client.

Returns:
The target URI of the deployment server in the format "server:port", or null if not specified.

reload

public void reload()
Reloads the deployment client from the configuration file.


setDisabled

public void setDisabled(boolean disabled)
Sets whether to enable or disable the deployment client.

Note: Using this method requires you to restart Splunk before this setting takes effect. To avoid restarting Splunk, use the Entity.disable and Entity.enable methods instead, which take effect immediately.

Parameters:
disabled - true to disable the deployment client, false to enable it.
See Also:
Entity.disable(), Entity.enable()

setTargetUri

public void setTargetUri(java.lang.String targetUri)
Sets the deployment server's target URI for this deployment client. The form of this URI is "deployment_server_uir:port".

Parameters:
targetUri - The target URI of the deployment server.