com.splunk
Class SavedSearchCollection

java.lang.Object
  extended by com.splunk.Resource
      extended by com.splunk.ResourceCollection<T>
          extended by com.splunk.EntityCollection<SavedSearch>
              extended by com.splunk.SavedSearchCollection
All Implemented Interfaces:
java.util.Map<java.lang.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
java.util.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
 
Method Summary
 SavedSearch create(java.lang.String name)
          Creates an entity in this collection.
 SavedSearch create(java.lang.String name, java.lang.String search)
          Creates a saved search from a name and search query.
 SavedSearch create(java.lang.String name, java.lang.String search, java.util.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, invalidate
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public SavedSearch create(java.lang.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(java.lang.String name,
                          java.lang.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(java.lang.String name,
                          java.lang.String search,
                          java.util.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.