Role

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.splunk
Class Role

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

All Implemented Interfaces:: java.util.Map<java.lang.String,java.lang.Object>

public class Role
extends Entity
extends Entity

The Role class represents a Splunk role, which is a collection of permissions and capabilities. The user's role determines what the user can see and interact with in Splunk.

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[]`	`getCapabilities()` Returns an array of capabilities assigned to this role.
`java.lang.String`	`getDefaultApp()` Returns the app to use as the default app for this role.
`java.lang.String[]`	`getImportedCapabilities()` Returns an array of capabilities imported for this role.
`java.lang.String[]`	`getImportedIndexesAllowed()` Returns an array of indexes that a user with this role has permissions to search.
`java.lang.String[]`	`getImportedIndexesDefault()` Returns an array of indexes to search by default when no index is specified for a user with this role.
`java.lang.String[]`	`getImportedRoles()` Returns an array of roles used to import attributes from, such as capabilities and allowed indexes to search.
`int`	`getImportedRtSearchJobsQuota()` Returns the maximum number of concurrent real-time search jobs a user with this role is allowed to run.
`int`	`getImportedSearchDiskQuota()` Returns the maximum disk space that can be used for search jobs by a user with this role.
`java.lang.String`	`getImportedSearchFilter()` Returns a search string that restricts the scope of searches run by this role.
`int`	`getImportedSearchJobsQuota()` Returns the maximum number of concurrent searches a user with this role is allowed to run.
`int`	`getRtSearchJobsQuota()` Returns the maximum number of concurrent real-time search jobs a user with this role is allowed to run.
`int`	`getSearchDiskQuota()` Returns the maximum disk space that can be used for search jobs by a user with this role.
`java.lang.String`	`getSearchFilter()` Returns a search string that restricts the scope of searches run by this role.
`java.lang.String[]`	`getSearchIndexesAllowed()` Returns an array of indexes that a user with this role has permissions to search.
`java.lang.String[]`	`getSearchIndexesDefault()` Returns an array of indexes to search by default when no index is specified for a user with this role.
`int`	`getSearchJobsQuota()` Returns the maximum number of concurrent searches a user with this role is allowed to run.
`int`	`getSearchTimeWin()` Returns the maximum time span of a search that is allowed for users in this role.

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

getCapabilities

public java.lang.String[] getCapabilities()

Returns an array of capabilities assigned to this role.

Returns:: An array of capabilities.

getDefaultApp

public java.lang.String getDefaultApp()

Returns the app to use as the default app for this role. The user can override this setting.

Returns:: The default app for this role.

getImportedCapabilities

public java.lang.String[] getImportedCapabilities()

Returns an array of capabilities imported for this role.

Returns:: An array of capabilities.

getImportedRoles

public java.lang.String[] getImportedRoles()

Returns an array of roles used to import attributes from, such as capabilities and allowed indexes to search.

Returns:: An array of roles.

getImportedRtSearchJobsQuota

public int getImportedRtSearchJobsQuota()

Returns the maximum number of concurrent real-time search jobs a user with this role is allowed to run.

Returns:: The imported quota for real-time search jobs.

getImportedSearchDiskQuota

public int getImportedSearchDiskQuota()

Returns the maximum disk space that can be used for search jobs by a user with this role.

Returns:: The imported search disk quota, in megabytes.

getImportedSearchFilter

public java.lang.String getImportedSearchFilter()

Returns a search string that restricts the scope of searches run by this role. Only those events that also match this search string are shown to the user. If a user has multiple roles with different search filters, they are combined with an OR.

Returns:: The imported search filter.

getImportedIndexesAllowed

public java.lang.String[] getImportedIndexesAllowed()

Returns an array of indexes that a user with this role has permissions to search.

Returns:: The imported array of allowed indexes.

getImportedIndexesDefault

public java.lang.String[] getImportedIndexesDefault()

Returns an array of indexes to search by default when no index is specified for a user with this role.

Returns:: The imported array of default indexes.

getImportedSearchJobsQuota

public int getImportedSearchJobsQuota()

Returns the maximum number of concurrent searches a user with this role is allowed to run.

Returns:: The imported quota for normal search jobs.

getRtSearchJobsQuota

public int getRtSearchJobsQuota()