com.splunk

Class EntityCollection<T extends Entity>

java.lang.Object

com.splunk.Resource

com.splunk.ResourceCollection<T>

com.splunk.EntityCollection<T>

Type Parameters:

T - The type of members in the collection.

All Implemented Interfaces:

Map<String,T>

Direct Known Subclasses:

DataModelCollection, EventTypeCollection, FiredAlertGroupCollection, IndexCollection, InputCollection, JobCollection, LicensePoolCollection, MessageCollection, PasswordCollection, SavedSearchCollection, UserCollection

public class EntityCollection<T extends Entity>
extends ResourceCollection<T>

The EntityCollection class represents a collection of Splunk entities.

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.ResourceCollection

itemClass, items

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Constructor Summary

Constructors

Constructor and Description
EntityCollection(Service service, String path, Class itemClass, Args args) Class constructor.

Method Summary

Modifier and Type	Method and Description
T	create(String name) Creates an entity in this collection.
T	create(String name, Map args) Creates an entity in this collection.
T	remove(String key) Removes an entity from this collection.
T	remove(String key, Args namespace) Removes an entity from this collection, with a namespace restriction.

Methods inherited from class com.splunk.ResourceCollection

clear, containsKey, containsKey, containsValue, createItem, createItem, entrySet, equals, get, get, hashCode, isEmpty, itemKey, itemPath, keySet, list, put, putAll, refresh, remove, size, validate, values, valueSize

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, getUpdated, invalidate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

EntityCollection

public EntityCollection(Service service,
                        String path,
                        Class itemClass,
                        Args args)

Class constructor.

Parameters:

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).

Method Detail

create

public T create(String name)

Creates an entity in this collection.

Parameters:

name - The name of the entity.

Returns:

The entity.

create

public T create(String name,
                Map args)

Creates an entity in this collection.

Parameters:

name - The name of the entity.

args - Arguments for creating the entity.

Returns:

The entity.

remove

public T remove(String key)

Removes an entity from this collection.

Parameters:

key - The name of the entity to remove.

Returns:

The collection.

Throws:

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.

remove

public T remove(String key,
                Args namespace)

Removes an entity from this collection, with a namespace restriction.

Parameters:

key - The name of the entity to remove.

namespace - The namespace restriction within the collection.

Returns:

This collection.