com.splunk
Class ServiceInfo

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

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.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

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

Method Summary

int	getBuild() Returns the build number of this Splunk instance.
java.lang.String	getCpuArch() Returns the CPU architecture of this Splunk instance.
java.lang.String	getGuid() Returns a GUID identifying this Splunk instance.
java.lang.String[]	getLicenseKeys() Returns an array of the license keys for this Splunk instance.
java.lang.String[]	getLicenseLabels() Returns an array of the service's license labels.
java.lang.String	getLicenseSignature() Returns the license signature for this Splunk instance.
java.lang.String	getLicenseState() Returns the current license state of this Splunk instance.
java.lang.String	getMasterGuid() Returns a GUID identifying the license master for this Splunk instance.
java.lang.String	getMode() Returns the current mode of this Splunk instance.
java.lang.String	getOsBuild() Returns the OS build of this Splunk instance.
java.lang.String	getOsName() Returns the service's OS name (type).
java.lang.String	getOsVersion() Returns the OS version of this Splunk instance.
java.lang.String	getServerName() Returns the server name of this Splunk instance.
java.lang.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

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

getBuild

public int getBuild()

Returns the build number of this Splunk instance.

Returns:

The build number.

getCpuArch

public java.lang.String getCpuArch()

Returns the CPU architecture of this Splunk instance.

Returns:

The CPU architecture.

getGuid

public java.lang.String getGuid()

Returns a GUID identifying this Splunk instance.

Returns:

The Splunk instance GUID.

getLicenseLabels

public java.lang.String[] getLicenseLabels()

Returns an array of the service's license labels.

Returns:

An array of license labels.

getLicenseKeys

public java.lang.String[] getLicenseKeys()

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

Returns:

An array of license keys.

getLicenseSignature

public java.lang.String getLicenseSignature()

Returns the license signature for this Splunk instance.

Returns:

The license signature.

getLicenseState

public java.lang.String getLicenseState()

Returns the current license state of this Splunk instance.

Returns:

The license state.

getMasterGuid

public java.lang.String getMasterGuid()

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

Returns:

The license master GUID.

getMode

public java.lang.String getMode()

Returns the current mode of this Splunk instance.

Returns:

The mode.

getOsBuild

public java.lang.String getOsBuild()

Returns the OS build of this Splunk instance.

Returns:

The OS build.

getOsName

public java.lang.String getOsName()

Returns the service's OS name (type).

Returns:

The OS name.

getOsVersion

public java.lang.String getOsVersion()

Returns the OS version of this Splunk instance.

Returns:

The OS version.

getServerName

public java.lang.String getServerName()

Returns the server name of this Splunk instance.

Returns:

The server name.

getVersion

public java.lang.String getVersion()

Returns the version number of this Splunk instance.

Returns:

The Splunk version number.

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.