com.splunk
Class JobSummaryArgs

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.JobSummaryArgs
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class JobSummaryArgs
extends Args

The JobSummaryArgs class contains arguments for getting a job summary using the Job.getSummary() method.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.util.AbstractMap
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
 
Constructor Summary
JobSummaryArgs()
          Class constructor.
 
Method Summary
 void setEarliestTime(java.lang.String earliestTime)
          Specifies the earliest time in the time range to search.
 void setFieldList(java.lang.String[] fieldList)
          Sets a list of fields to return for the event set.
 void setHistogram(boolean histogram)
          Indicates whether to add histogram data to the summary output.
 void setLatestTime(java.lang.String latestTime)
          Specifies the latest time in the time range to search.
 void setMinimumFrequency(double minimumFrequency)
          Sets the fraction of results for each key that this key must occur in to be displayed.
 void setOutputTimeFormat(java.lang.String outputTimeFormat)
          Sets a UTC time format.
 void setSearch(java.lang.String search)
          Sets a search query to filter the response.
 void setTimeFormat(java.lang.String timeFormat)
          Specifies an expression to convert a formatted time string from {start,end}_time into UTC seconds.
 void setTopCount(int topCount)
          Sets for each key how many of the most frequent items to return.
 
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
 
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
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

JobSummaryArgs

public JobSummaryArgs()
Class constructor.

Method Detail

setEarliestTime

public void setEarliestTime(java.lang.String earliestTime)
Specifies the earliest time in the time range to search. The time string can be a UTC time (with fractional seconds), a relative time specifier (to now), or a formatted time string.

Parameters:
earliestTime - The earliest time.

setFieldList

public void setFieldList(java.lang.String[] fieldList)
Sets a list of fields to return for the event set.

Parameters:
fieldList - A list of fields.

setHistogram

public void setHistogram(boolean histogram)
Indicates whether to add histogram data to the summary output.

Parameters:
histogram - true to add histogram data, false if not.

setLatestTime

public void setLatestTime(java.lang.String latestTime)
Specifies the latest time in the time range to search. The time string can be a UTC time (with fractional seconds), a relative time specifier (to now), or a formatted time string.

Parameters:
latestTime - The latest time.

setMinimumFrequency

public void setMinimumFrequency(double minimumFrequency)
Sets the fraction of results for each key that this key must occur in to be displayed.

Parameters:
minimumFrequency - The frequency, as a fraction (a value between 0 and 1).

setOutputTimeFormat

public void setOutputTimeFormat(java.lang.String outputTimeFormat)
Sets a UTC time format.

Parameters:
outputTimeFormat - A UTC time format.

setSearch

public void setSearch(java.lang.String search)
Sets a search query to filter the response. The response matches field values against the search query. For example, "foo" matches any object that has "foo" as a substring in a field, and "field_name=field_value" restricts the match to a single field.

Parameters:
search - A search substring.

setTimeFormat

public void setTimeFormat(java.lang.String timeFormat)
Specifies an expression to convert a formatted time string from {start,end}_time into UTC seconds. The default format is "%m/%d/%Y:%H:%M:%S".

Parameters:
timeFormat - The time format.

setTopCount

public void setTopCount(int topCount)
Sets for each key how many of the most frequent items to return.

Parameters:
topCount - The number of items to return.