com.splunk
Class DeploymentTenant

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

public class DeploymentTenant
extends Entity

The DeploymentTenant class represents a Splunk deployment tenant, and provides access to the multi-tenants configuration for this Splunk instance.


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
 java.lang.String getWhitelistByIndex(int index)
          Returns inclusive criteria for determining deployment client access to this deployment server.
 void setDisabled(boolean disabled)
          Sets whether the deployment tenant is enabled or disabled.
 
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, 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

getWhitelistByIndex

public java.lang.String getWhitelistByIndex(int index)
Returns inclusive criteria for determining deployment client access to this deployment server.

Parameters:
index - The whitelist index. The only valid index is 0.
Returns:
Criteria for determining deployment client access to this deployment server.

setDisabled

public void setDisabled(boolean disabled)
Sets whether the deployment tenant is enabled or disabled.

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 disabled to deployment client, false to enable.
See Also:
Entity.disable(), Entity.enable()