T
- The type of members in the collection.public class EntityCollection<T extends Entity> extends ResourceCollection<T>
EntityCollection
class represents a collection of Splunk
entities.itemClass, items
Constructor and Description |
---|
EntityCollection(Service service,
java.lang.String path,
java.lang.Class itemClass,
Args args)
Class constructor.
|
Modifier and Type | Method and Description |
---|---|
T |
create(java.lang.String name)
Creates an entity in this collection.
|
T |
create(java.lang.String name,
java.util.Map args)
Creates an entity in this collection.
|
T |
remove(java.lang.String key)
Removes an entity from this collection.
|
T |
remove(java.lang.String key,
Args namespace)
Removes an entity from this collection, with a namespace restriction.
|
clear, containsKey, containsKey, containsValue, createItem, createItem, entrySet, equals, get, get, hashCode, isEmpty, itemKey, itemPath, keySet, list, put, putAll, refresh, remove, size, validate, values, valueSize
getName, getPath, getService, getTitle, getUpdated, invalidate
public EntityCollection(Service service, java.lang.String path, java.lang.Class itemClass, Args args)
service
- The connected Service
instance.path
- The entity's endpoint.itemClass
- The entity's class.args
- Collection arguments that specify the number of entities to
return and how to sort them (see CollectionArgs
).public T create(java.lang.String name)
name
- The name of the entity.public T create(java.lang.String name, java.util.Map args)
name
- The name of the entity.args
- Arguments for creating the entity.public T remove(java.lang.String key)
key
- The name of the entity to remove.SplunkException
- The exception "AMBIGUOUS" if the collection
contains more than one entity with the specified key. Disambiguation is
done through a similar method,
remove(Object key, HashMap<String,String>namespace
, which uses
the namespace to perform the disambiguation.