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>

Field Summary

Fields inherited from class com.splunk.Resource

actions, path, service, title

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.
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.

Methods inherited from class com.splunk.Entity

actionPath, 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

getDescription

public java.lang.String getDescription()

Returns the description of this license pool.

Returns:

This 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 long getSlavesUsageBytes()

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

Returns:

The overall license slave usage, in bytes.

getStackId

public java.lang.String getStackId()

Returns the stack ID for this license pool. Valid values are: download-trial, enterprise, forwarder, and 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.