com.splunk

Class License

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.License

All Implemented Interfaces:

Map<String,Object>

public class License
extends Entity

The License class represents a license, providing access to the licenses for this Splunk instance. Splunk licenses specify how much data you can index per calendar day (from midnight to midnight by the clock on the license master).

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method and Description
Date	getCreationTime() Returns the time and date the license was created.
Date	getExpirationTime() Returns the time and date this license expires.
String[]	getFeatures() Returns a list of enabled features for this license.
String	getGroupId() Returns the group ID for this license.
String	getLabel() Returns the label for this license.
String	getLicenseHash() Returns the hash value for this license.
int	getMaxViolations() Returns the maximum number of violations allowed for this license.
long	getQuota() Returns the daily indexing quota, which is the maximum bytes per day of indexing volume for this license.
String[]	getSourceTypes() Returns the source types that, when indexed, count against the indexing volume for this license.
String	getStackId() Returns the stack ID for this license.
String	getStatus() Returns the status of this license.
String	getType() Returns the license type.
int	getWindowPeriod() Returns the number of days remaining in the rolling time window for this license.

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

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

getCreationTime

public Date getCreationTime()

Returns the time and date the license was created.

Returns:

The creation time and date.

getExpirationTime

public Date getExpirationTime()

Returns the time and date this license expires.

Returns:

The expiration time and date.

getFeatures

public String[] getFeatures()

Returns a list of enabled features for this license.

Returns:

The feature list.

getGroupId

public String getGroupId()

Returns the group ID for this license.

Returns:

The license group ID, or null if not available.

getLabel

public String getLabel()

Returns the label for this license.

Returns:

This license label, or null if not available.

getLicenseHash

public String getLicenseHash()

Returns the hash value for this license.

Returns:

The license hash value.

getMaxViolations

public int getMaxViolations()

Returns the maximum number of violations allowed for this license. A violation occurs when you exceed the maximum indexing volume allowed for your license. Exceeding the maximum violations will disable search.

Returns:

The maximum number of license violations.

getQuota

public long getQuota()

Returns the daily indexing quota, which is the maximum bytes per day of indexing volume for this license.

Returns:

The daily indexing quota, in bytes.

getSourceTypes

public String[] getSourceTypes()

Returns the source types that, when indexed, count against the indexing volume for this license. All source types are allowed if none are explicitly specified.

Returns:

The license source types, or null if not specified.

getStackId

public String getStackId()

Returns the stack ID for this license.

Returns:

The license stack ID.

getStatus

public String getStatus()

Returns the status of this license.

Returns:

The license status.

getType

public String getType()

Returns the license type.

Returns:

The license type.

getWindowPeriod

public int getWindowPeriod()

Returns the number of days remaining in the rolling time window for this license. A license violation occurs when you have exceeded the number of allowed warnings within this period of time.

Returns:

The number of days in the rolling window.