com.splunk

Class SavedSearchDispatchArgs

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

com.splunk.Args

com.splunk.SavedSearchDispatchArgs

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class SavedSearchDispatchArgs
extends Args

The SavedSearchDispatchArgs class contains arguments for dispatching a saved search using the SavedSearch.dispatch() method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
SavedSearchDispatchArgs() Class constructor.

Method Summary

Modifier and Type	Method and Description
void	setDispatchBuckets(int dispatchBuckets) Sets the maximum number of timeline buckets.
void	setDispatchEarliestTime(Date dispatchEarliestTime) Sets the earliest time for this search.
void	setDispatchEarliestTime(String dispatchEarliestTime) Specifies the earliest time for this search.
void	setDispatchLatestTime(Date dispatchLatestTime) Sets the latest time for this search.
void	setDispatchLatestTime(String dispatchLatestTime) Specifies the latest time for this search.
void	setDispatchLookups(boolean dispatchLookups) Indicates whether to enable lookups for this search.
void	setDispatchMaximumCount(int dispatchMaximumCount) Sets the maximum number of results before finalizing the search.
void	setDispatchMaximumTime(int dispatchMaximumTime) Sets the the maximum amount of time before finalizing the search.
void	setDispatchNow(String dispatchNow) Sets a time that dispatches the search as though the specified time were the current time.
void	setDispatchRealTimeBackfill(boolean dispatchRealTimeBackfill) Indicates whether to back fill the real-time window for this search.
void	setDispatchReduceFrequency(int dispatchReduceFrequency) Set the frequency for how often Splunk should run the MapReduce reduce phase on accumulated map values.
void	setDispatchSpawnProcess(boolean dispatchSpawnProcess) Indicates whether the search should run in a separate spawned process.
void	setDispatchTimeFormat(String dispatchTimeFormat) Sets a time format for Splunk to use to specify the earliest and latest times.
void	setDispatchTtl(String dispatchTtl) Indicates the time to live (TTL) for the artifacts of the scheduled search, if no actions are triggered.
void	setForceDispatch(boolean forceDispatch) Indicates whether to start a new search, even if another instance of this search is already running.
void	setTriggerActions(boolean triggerActions) Indicates whether to trigger alert actions.

Methods inherited from class com.splunk.Args

add, create, create, create, encode, encode, encode, get

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

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

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

SavedSearchDispatchArgs

public SavedSearchDispatchArgs()

Class constructor.

Method Detail

setDispatchNow

public void setDispatchNow(String dispatchNow)

Sets a time that dispatches the search as though the specified time were the current time.

Parameters:

dispatchNow - A string with the specified time.

setDispatchBuckets

public void setDispatchBuckets(int dispatchBuckets)

Sets the maximum number of timeline buckets.

Parameters:

dispatchBuckets - The maximum number of timeline buckets.

setDispatchEarliestTime

public void setDispatchEarliestTime(String dispatchEarliestTime)

Specifies the earliest time for this search. This value can be a relative or absolute time. If this value is an absolute time, use setDispatchTimeFormat(java.lang.String) to format the value.

Parameters:

dispatchEarliestTime - A time string that specifies the earliest time for this search.

setDispatchEarliestTime

public void setDispatchEarliestTime(Date dispatchEarliestTime)

Sets the earliest time for this search.

Parameters:

dispatchEarliestTime - A date that specifies the earliest time for this search.

setDispatchLatestTime

public void setDispatchLatestTime(String dispatchLatestTime)

Specifies the latest time for this search. This value can be a relative or absolute time. If this value is an absolute time, use setDispatchTimeFormat(java.lang.String) to format the value.

Parameters:

dispatchLatestTime - A time string that specifies the latest time for this search.

setDispatchLatestTime

public void setDispatchLatestTime(Date dispatchLatestTime)

Sets the latest time for this search.

Parameters:

dispatchLatestTime - A date that specifies the latest time for this saved search.

setDispatchLookups

public void setDispatchLookups(boolean dispatchLookups)

Indicates whether to enable lookups for this search.

Parameters:

dispatchLookups - true to enable lookups, false if not.

setDispatchMaximumCount

public void setDispatchMaximumCount(int dispatchMaximumCount)

Sets the maximum number of results before finalizing the search.

Parameters:

dispatchMaximumCount - The maximum number of results.

setDispatchMaximumTime

public void setDispatchMaximumTime(int dispatchMaximumTime)

Sets the the maximum amount of time before finalizing the search.

Parameters:

dispatchMaximumTime - The maximum amount of time, in seconds.

setDispatchReduceFrequency

public void setDispatchReduceFrequency(int dispatchReduceFrequency)

Set the frequency for how often Splunk should run the MapReduce reduce phase on accumulated map values.

Parameters:

dispatchReduceFrequency - The frequency, in seconds.

setDispatchRealTimeBackfill

public void setDispatchRealTimeBackfill(boolean dispatchRealTimeBackfill)

Indicates whether to back fill the real-time window for this search. This value only applies to real-time searches.

Parameters:

dispatchRealTimeBackfill - true to back fill the real-time window, false if not.

setDispatchSpawnProcess

public void setDispatchSpawnProcess(boolean dispatchSpawnProcess)

Indicates whether the search should run in a separate spawned process. Searches against indexes must run in a separate process.

Parameters:

dispatchSpawnProcess - true to run the search in a separate process, false if not.

setDispatchTimeFormat

public void setDispatchTimeFormat(String dispatchTimeFormat)

Sets a time format for Splunk to use to specify the earliest and latest times.

Parameters:

dispatchTimeFormat - A time format string.

setDispatchTtl

public void setDispatchTtl(String dispatchTtl)

Indicates the time to live (TTL) for the artifacts of the scheduled search, if no actions are triggered. If an action is triggered, Splunk changes the TTL to that action's TTL. If multiple actions are triggered, Splunk applies the maximum TTL to the artifacts. To set the action's TTL, refer to alert_actions.conf.spec.

Parameters:

dispatchTtl - The time to live, in seconds. If the value is a number followed by "p", it is the number of scheduled search periods.

setTriggerActions

public void setTriggerActions(boolean triggerActions)

Indicates whether to trigger alert actions.

Parameters:

triggerActions - true to trigger alert actions, false if not.

setForceDispatch

public void setForceDispatch(boolean forceDispatch)

Indicates whether to start a new search, even if another instance of this search is already running.

Parameters:

forceDispatch - true to start a new search, false if not.