com.splunk

Class SavedSearchCollection

java.lang.Object

com.splunk.Resource

com.splunk.ResourceCollection<T>

com.splunk.EntityCollection<SavedSearch>

com.splunk.SavedSearchCollection

All Implemented Interfaces:

Map<String,SavedSearch>

public class SavedSearchCollection
extends EntityCollection<SavedSearch>

The SavedSearchCollection class represents a collection of saved searches.

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

Method Summary

Modifier and Type	Method and Description
SavedSearch	create(String name) Creates an entity in this collection.
SavedSearch	create(String name, String search) Creates a saved search from a name and search query.
SavedSearch	create(String name, String search, Map args) Creates a saved search from a name, search query, and additional arguments.

Methods inherited from class com.splunk.EntityCollection

create, remove, remove

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

Method Detail

create

public SavedSearch create(String name)

Creates an entity in this collection.

Overrides:

create in class EntityCollection<SavedSearch>

Parameters:

name - The name of the entity.

Returns:

The entity.

create

public SavedSearch create(String name,
                          String search)

Creates a saved search from a name and search query.

Parameters:

name - The name for the search.

search - The search query.

Returns:

The new saved search.

create

public SavedSearch create(String name,
                          String search,
                          Map args)

Creates a saved search from a name, search query, and additional arguments.

Parameters:

name - The name for the search.

search - The search query.

args - Additional arguments. For a list of possible parameters, see Saved search parameters on dev.splunk.com.

Returns:

The new saved search.