com.splunk

Class ServiceInfo

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.ServiceInfo

All Implemented Interfaces:

Map<String,Object>

public class ServiceInfo
extends Entity

The ServiceInfo class contains information about a running Splunk Service instance (Splunkd).

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
String	getBuild() Returns the build number of this Splunk instance.
String	getCpuArch() Returns the CPU architecture of this Splunk instance.
String	getGuid() Returns a GUID identifying this Splunk instance.
String	getInstanceType()
String[]	getLicenseKeys() Returns an array of the license keys for this Splunk instance.
String[]	getLicenseLabels() Returns an array of the service's license labels.
String	getLicenseSignature() Returns the license signature for this Splunk instance.
String	getLicenseState() Returns the current license state of this Splunk instance.
String	getMasterGuid() Returns a GUID identifying the license master for this Splunk instance.
String	getMode() Returns the current mode of this Splunk instance.
String	getOsBuild() Returns the OS build of this Splunk instance.
String	getOsName() Returns the service's OS name (type).
String	getOsVersion() Returns the OS version of this Splunk instance.
String	getServerName() Returns the server name of this Splunk instance.
String	getVersion() Returns the version number of this Splunk instance.
boolean	isFree() Indicates whether this Splunk instance is running under a free license.
boolean	isRtSearchEnabled() Indicates whether real-time search is enabled for the service.
boolean	isTrial() Indicates whether this Splunk instance is running under a trial 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

getBuild

public String getBuild()

Returns the build number of this Splunk instance.

Returns:

The build number.

getCpuArch

public String getCpuArch()

Returns the CPU architecture of this Splunk instance.

Returns:

The CPU architecture.

getGuid

public String getGuid()

Returns a GUID identifying this Splunk instance.

Returns:

The Splunk instance GUID.

getLicenseLabels

public String[] getLicenseLabels()

Returns an array of the service's license labels.

Returns:

An array of license labels.

getLicenseKeys

public String[] getLicenseKeys()

Returns an array of the license keys for this Splunk instance.

Returns:

An array of license keys.

getLicenseSignature

public String getLicenseSignature()

Returns the license signature for this Splunk instance.

Returns:

The license signature.

getLicenseState

public String getLicenseState()

Returns the current license state of this Splunk instance.

Returns:

The license state.

getMasterGuid

public String getMasterGuid()

Returns a GUID identifying the license master for this Splunk instance.

Returns:

The license master GUID.

getMode

public String getMode()

Returns the current mode of this Splunk instance.

Returns:

The mode.

getOsBuild

public String getOsBuild()

Returns the OS build of this Splunk instance.

Returns:

The OS build.

getOsName

public String getOsName()

Returns the service's OS name (type).

Returns:

The OS name.

getOsVersion

public String getOsVersion()

Returns the OS version of this Splunk instance.

Returns:

The OS version.

getServerName

public String getServerName()

Returns the server name of this Splunk instance.

Returns:

The server name.

getVersion

public String getVersion()

Returns the version number of this Splunk instance.

Returns:

The Splunk version number.

getInstanceType

public String getInstanceType()

isFree

public boolean isFree()

Indicates whether this Splunk instance is running under a free license.

Returns:

true if the current license is a free license, false if not.

isRtSearchEnabled

public boolean isRtSearchEnabled()

Indicates whether real-time search is enabled for the service.

Returns:

true if real-time search is enabled, false if not.

isTrial

public boolean isTrial()

Indicates whether this Splunk instance is running under a trial license.

Returns:

true if the current license is a trial license, false if not.