com.splunk
Class LicensePool

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

All Implemented Interfaces:

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

public class LicensePool
extends Entity

The LicensePool class represents a license pool, which is made up of a single license master and zero or more license slave instances of Splunk that are configured to use the licensing volume from a set license or license stack.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

java.lang.String	getDescription() Returns the description of this license pool.
java.lang.String	getQuota() Returns the indexing quota for this license pool.
java.lang.String[]	getSlaves() Returns the list of slaves for this license pool.
java.util.Map<java.lang.String,java.lang.Long>	getSlavesUsageBytes() Returns the usage of indexing volume by slave licenses in this license pool.
java.lang.String	getStackId() Returns the stack ID for this license pool.
long	getUsedBytes() Returns the usage of indexing volume for this license pool.
void	setAppendSlaves(boolean appendSlaves) Sets whether to append or overwrite slaves to this license pool.
void	setDescription(java.lang.String description) Sets the description of this license pool.
void	setQuota(java.lang.String quota) Sets the byte quota of this license pool.
void	setSlaves(java.lang.String slaves) Sets the list of slaves that are members of this license pool.
void	setSlaves(java.lang.String[] slaves) Sets the list of slaves that are members of this license pool.

Methods inherited from class com.splunk.Entity

clear, containsKey, containsValue, disable, enable, entrySet, get, getMetadata, isDisabled, isEmpty, 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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of this license pool.

Returns:

The description, or null if not specified.

getQuota

public java.lang.String getQuota()

Returns the indexing quota for this license pool.

Returns:

A string containing the indexing quota in bytes, or "MAX" to indicate the maximum amount that is allowed.

getSlaves

public java.lang.String[] getSlaves()

Returns the list of slaves for this license pool.

Returns:

A comma-separated list of slaves by ID, or null if not specified.

getSlavesUsageBytes

public java.util.Map<java.lang.String,java.lang.Long> getSlavesUsageBytes()

Returns the usage of indexing volume by slave licenses in this license pool.

Returns:

A map from each slave GUID to the number of bytes it is using.

getStackId

public java.lang.String getStackId()

Returns the stack ID for this license pool. Valid values are:

• "download-trial"
• "enterprise"
• "forwarder"
• "free"

Returns:

The license pool stack ID, or null if not specified.

getUsedBytes

public long getUsedBytes()

Returns the usage of indexing volume for this license pool.

Returns:

This license pool's usage, in bytes.

setAppendSlaves

public void setAppendSlaves(boolean appendSlaves)

Sets whether to append or overwrite slaves to this license pool.

Parameters:

appendSlaves - true to append slaves, false to overwrite slaves.

setDescription

public void setDescription(java.lang.String description)

Sets the description of this license pool.

Parameters:

description - The description.

setQuota

public void setQuota(java.lang.String quota)

Sets the byte quota of this license pool.

Parameters:

quota - The indexing quota of this license pool, specified as:

• number
• number followed by "MB" or "GB" (for example, "10GB")
• "MAX" (Only one license pool can have "MAX" size in a stack.)

setSlaves

public void setSlaves(java.lang.String slaves)

Sets the list of slaves that are members of this license pool.

Parameters:

slaves - The comma-separated list of slaves. Use an asterisk ("*") to accept all slaves.

setSlaves

public void setSlaves(java.lang.String[] slaves)

Sets the list of slaves that are members of this license pool.

Parameters:

slaves - The array of slaves. To accept all slaves, use an array with a single asterisk element ("*").