public class Entity extends Resource implements java.util.Map<java.lang.String,java.lang.Object>
Entity
class represents a Splunk entity.Modifier and Type | Field and Description |
---|---|
protected Record |
content |
protected java.util.HashMap<java.lang.String,java.lang.Object> |
toUpdate |
Constructor and Description |
---|
Entity(Service service,
java.lang.String path)
Class constructor.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
actionPath(java.lang.String action)
Returns the path that corresponds to the requested action.
|
void |
clear() |
boolean |
containsKey(java.lang.Object key) |
boolean |
containsValue(java.lang.Object value) |
void |
disable()
Disables the entity that is named by this endpoint.
|
void |
enable()
Enables the entity that is named by this endpoint.
|
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> |
entrySet() |
java.lang.Object |
get(java.lang.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>) . |
java.util.Set<java.lang.String> |
keySet() |
java.lang.Object |
put(java.lang.String key,
java.lang.Object value) |
void |
putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map) |
Entity |
refresh()
Refreshes the local state of this resource.
|
void |
remove()
Removes this entity from its corresponding collection.
|
java.lang.Object |
remove(java.lang.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(java.util.Map<java.lang.String,java.lang.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. |
java.util.Collection<java.lang.Object> |
values() |
getName, getPath, getService, getTitle, getUpdated, invalidate
protected Record content
protected java.util.HashMap<java.lang.String,java.lang.Object> toUpdate
public Entity(Service service, java.lang.String path)
service
- The connected Service
instance.path
- The entity's endpoint.protected java.lang.String actionPath(java.lang.String action)
action
- The requested action.public void clear()
clear
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean containsValue(java.lang.Object value)
containsValue
in interface java.util.Map<java.lang.String,java.lang.Object>
public void disable()
public void enable()
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
entrySet
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.lang.Object get(java.lang.Object key)
get
in interface java.util.Map<java.lang.String,java.lang.Object>
protected Record getContent()
public EntityMetadata getMetadata()
null
if none exist.public boolean isEmpty()
isEmpty
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean isDisabled()
true
if this entity is disabled, false
if
enabled.protected boolean isNameChangeAllowed()
update(java.util.Map<java.lang.String, java.lang.Object>)
.
Most entity names cannot be changed in this way.public java.util.Set<java.lang.String> keySet()
keySet
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.lang.Object put(java.lang.String key, java.lang.Object value)
put
in interface java.util.Map<java.lang.String,java.lang.Object>
public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map)
putAll
in interface java.util.Map<java.lang.String,java.lang.Object>
public Entity refresh()
public java.lang.Object remove(java.lang.Object key)
remove
in interface java.util.Map<java.lang.String,java.lang.Object>
public int size()
size
in interface java.util.Map<java.lang.String,java.lang.Object>
public void update(java.util.Map<java.lang.String,java.lang.Object> args)
args
- The arguments to update.public void update()
public void remove()
public Entity validate()
refresh
if necessary.public java.util.Collection<java.lang.Object> values()
values
in interface java.util.Map<java.lang.String,java.lang.Object>