com.splunk

Class Entity

java.lang.Object

com.splunk.Resource

com.splunk.Entity

All Implemented Interfaces:

Map<String,Object>

Direct Known Subclasses:

Application, ApplicationArchive, ApplicationSetup, ApplicationUpdate, DataModel, DeploymentClient, DeploymentServer, DeploymentServerClass, DeploymentTenant, DistributedConfiguration, DistributedPeer, EventType, FiredAlert, FiredAlertGroup, Index, Input, Job, License, LicenseGroup, LicenseMessage, LicensePool, LicenseSlave, LicenseStack, Logger, Message, ModularInputKind, OutputDefault, OutputGroup, OutputServer, OutputServerAllConnections, OutputSyslog, Password, Role, SavedSearch, ServiceInfo, Settings, TcpConnections, UdpConnections, Upload, User

public class Entity
extends Resource
implements Map<String,Object>

The Entity class represents a Splunk entity.

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Record	content
protected HashMap<String,Object>	toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Constructor Summary

Constructors

Constructor and Description
Entity(Service service, String path) Class constructor.

Method Summary

Modifier and Type	Method and Description
protected String	actionPath(String action) Returns the path that corresponds to the requested action.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
void	disable() Disables the entity that is named by this endpoint.
void	enable() Enables the entity that is named by this endpoint.
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
protected Record	getContent()
EntityMetadata	getMetadata() Returns the metadata (eai:acl) of this entity.
boolean	isDisabled() Indicates whether this entity is disabled.
boolean	isEmpty()
protected boolean	isNameChangeAllowed() Returns whether this entity's name can be changed via update(java.util.Map<java.lang.String, java.lang.Object>).
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,? extends Object> map)
Entity	refresh() Refreshes the local state of this resource.
void	remove() Removes this entity from its corresponding collection.
Object	remove(Object key)
int	size()
void	update() Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
void	update(Map<String,Object> args) Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
Entity	validate() Ensures that the local state of the resource is current, calling refresh if necessary.
Collection<Object>	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

Field Detail

content

protected Record content

toUpdate

protected HashMap<String,Object> toUpdate

Constructor Detail

Entity

public Entity(Service service,
              String path)

Class constructor.

Parameters:

service - The connected Service instance.

path - The entity's endpoint.

Method Detail

actionPath

protected String actionPath(String action)

Returns the path that corresponds to the requested action.

Parameters:

action - The requested action.

Returns:

The return path.

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

disable

public void disable()

Disables the entity that is named by this endpoint. This method is available on almost every endpoint.

enable

public void enable()

Enables the entity that is named by this endpoint. This method is available on almost every endpoint.

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

getContent

protected Record getContent()

getMetadata

public EntityMetadata getMetadata()

Returns the metadata (eai:acl) of this entity. This data includes permissions for accessing the resource, and values that indicate which resource fields are wildcards, required, and optional.

Returns:

The metadata of this entity, or null if none exist.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

isDisabled

public boolean isDisabled()

Indicates whether this entity is disabled. This method is available on almost every endpoint.

Returns:

true if this entity is disabled, false if enabled.

isNameChangeAllowed

protected boolean isNameChangeAllowed()

Returns whether this entity's name can be changed via update(java.util.Map<java.lang.String, java.lang.Object>). Most entity names cannot be changed in this way.

Returns:

false.

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,? extends Object> map)

Specified by:

putAll in interface Map<String,Object>

refresh

public Entity refresh()

Refreshes the local state of this resource.

Specified by:

refresh in class Resource

Returns:

The current Resource instance.

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

size

public int size()

Specified by:

size in interface Map<String,Object>

update

public void update(Map<String,Object> args)

Updates the entity with the values you previously set using the setter methods, and any additional specified arguments. The specified arguments take precedent over the values that were set using the setter methods.

Parameters:

args - The arguments to update.

update

public void update()

Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.

remove

public void remove()

Removes this entity from its corresponding collection.

validate

public Entity validate()

Ensures that the local state of the resource is current, calling refresh if necessary.

Overrides:

validate in class Resource

Returns:

The current Resource instance.

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>