com.splunk
Class IndexCollectionArgs

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<K,V>
          extended by java.util.LinkedHashMap<java.lang.String,java.lang.Object>
              extended by com.splunk.Args
                  extended by com.splunk.CollectionArgs
                      extended by com.splunk.IndexCollectionArgs
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class IndexCollectionArgs
extends CollectionArgs

The IndexCollectionArgs class contains arguments for retrieving indexes from a collection (see Service.getIndexes()).

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.splunk.CollectionArgs
CollectionArgs.SortDirection, CollectionArgs.SortMode
 
Nested classes/interfaces inherited from class java.util.AbstractMap
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
 
Constructor Summary
IndexCollectionArgs()
          Class constructor.
 
Method Summary
 void setCount(int count)
          Sets the maximum number of entries to return.
 void setSummarize(boolean summarize)
          Sets whether to omits certain index details to provide a faster response.
 
Methods inherited from class com.splunk.CollectionArgs
setApp, setOffset, setOwner, setSearch, setSharing, setSortDirection, setSortKey, setSortMode
 
Methods inherited from class com.splunk.Args
add, create, create, create, encode, encode, encode, get
 
Methods inherited from class java.util.LinkedHashMap
clear, containsValue, get, removeEldestEntry
 
Methods inherited from class java.util.HashMap
clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Constructor Detail

IndexCollectionArgs

public IndexCollectionArgs()
Class constructor.

Method Detail

setCount

public void setCount(int count)
Sets the maximum number of entries to return.

Overrides:
setCount in class CollectionArgs
Parameters:
count - The maximum number of entries to return. To return all entries, specify -1.

setSummarize

public void setSummarize(boolean summarize)
Sets whether to omits certain index details to provide a faster response.

Parameters:
summarize - true to omit index details for a faster response, false if not.