JobArgs (splunk 1.9.1 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<String,Object>
    - - com.splunk.Args
      - com.splunk.JobArgs

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>
```
public class JobArgs
extends Args
```
The JobArgs class contains arguments for creating a Job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JobArgs.ExecutionMode` Specifies how to create a job using the `JobCollection.create(java.lang.String)` method.
`static class`	`JobArgs.SearchMode` Specifies how to create a job using the `JobCollection.create(java.lang.String)` method.

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors
Constructor and Description

JobArgs()
Class constructor.

Constructors
Constructor and Description
`JobArgs()` Class constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`setAutoCancel(int autoCancel)` Sets the number of seconds of inactivity after which to automatically cancel a job.
`void`	`setAutoFinalizeEventCount(int autoFinalizeEventCount)` Sets the number of events to process after which to auto-finalize the search.
`void`	`setAutoPause(int autoPause)` Sets the number of seconds of inactivity after which to automatically pause a job.
`void`	`setEarliestTime(String earliestTime)` Specifies the earliest time in the time range to search.
`void`	`setEnableLookups(boolean enableLookups)` Indicates whether to enable lookups for this search.
`void`	`setExecutionMode(JobArgs.ExecutionMode executionMode)` Sets the type of search to run ("blocking", "oneshot", or "normal").
`void`	`setForceBundleReplication(boolean forceBundleReplication)` Specifies whether this search should cause (and wait depending on the value of `setSynchronizeBundleReplication`) bundle synchronization with all search peers.
`void`	`setId(String id)` Sets a search ID (SID).
`void`	`setLatestTime(String latestTime)` Specifies the latest time in the time range to search.
`void`	`setMaximumCount(int maximumCount)` Sets the number of events that can be accessible in any given status bucket.
`void`	`setMaximumTime(int maximumTime)` Sets the maximum number of seconds to run this search before finalizing.
`void`	`setNamespace(String namespace)` Specifies the application namespace to which to restrict searches.
`void`	`setNow(String now)` Specifies a time string that sets the absolute time used for any relative time specifier in the search.
`void`	`setRealtimeBlocking(boolean realtimeBlocking)` Indicates whether the indexer blocks if the queue for this search is full.
`void`	`setRealtimeIndexFilter(boolean realtimeIndexFilter)` Indicates whether the indexer pre-filters events.
`void`	`setRealtimeMaximumBlockSeconds(int realtimeMaximumBlockSeconds)` Sets the number of seconds indicating the maximum time to block.
`void`	`setRealtimeQueueSize(int realtimeQueueSize)` Sets the number indicating the queue size (in events) that the indexer should use for this search.
`void`	`setReduceFrequency(int reduceFrequency)` Sets the time to wait between running the MapReduce phase on accumulated map values.
`void`	`setReloadMacros(boolean reloadMacros)` Indicates whether to reload macro definitions from the macros.conf configuration file.
`void`	`setRemoteServerList(String[] remoteServerList)` Sets a list of (possibly wildcarded) servers from which to pull raw events.
`void`	`setRequiredFieldList(String[] requiredFieldList)` Sets one or more required fields to the search.
`void`	`setSearchListener(String searchListener)` Sets a string that registers a search state listener with the search.
`void`	`setSearchMode(JobArgs.SearchMode searchMode)` Sets the search mode ("normal" or "realtime").
`void`	`setSpawnProcess(boolean spawnProcess)` Indicates whether the search should run in a separate spawned process.
`void`	`setStatusBuckets(int statusBuckets)` Sets the maximum number of status buckets to generate.
`void`	`setSynchronizeBundleReplication(boolean synchronizeBundleReplication)` Indicates whether this search should wait for bundle replication to complete.
`void`	`setTimeFormat(String timeFormat)` Sets the format for converting a formatted time string from {start,end}_time into UTC seconds.
`void`	`setTimeout(int timeout)` Sets the number of seconds to keep this search after processing has stopped.

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
  - JobArgs
```
public JobArgs()
```
    Class constructor.
- Method Detail
  - setAutoCancel
```
public void setAutoCancel(int autoCancel)
```
    Sets the number of seconds of inactivity after which to automatically cancel a job. A value of 0 means never auto-cancel.
    
    Parameters:
    
    autoCancel - The number of seconds after which to cancel a job.
  - setAutoFinalizeEventCount
```
public void setAutoFinalizeEventCount(int autoFinalizeEventCount)
```
    Sets the number of events to process after which to auto-finalize the search. A value of 0 means no limit.
    
    Parameters:
    
    autoFinalizeEventCount - The number of events.
  - setAutoPause
```
public void setAutoPause(int autoPause)
```
    Sets the number of seconds of inactivity after which to automatically pause a job. A value of 0 means never auto-pause.
    
    Parameters:
    
    autoPause - The number of seconds after which to pause.
  - setEarliestTime
```
public void setEarliestTime(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.
  - setEnableLookups
```
public void setEnableLookups(boolean enableLookups)
```
    Indicates whether to enable lookups for this search. Enabling lookups might slow searches significantly depending on the nature of the lookups.
    
    Parameters:
    
    enableLookups - true to enable lookups, false if not.
  - setExecutionMode
```
public void setExecutionMode(JobArgs.ExecutionMode executionMode)
```
    Sets the type of search to run ("blocking", "oneshot", or "normal").
    
    Parameters:
    
    executionMode - The search type.
  - setForceBundleReplication
```
public void setForceBundleReplication(boolean forceBundleReplication)
```
    Specifies whether this search should cause (and wait depending on the value of setSynchronizeBundleReplication) bundle synchronization with all search peers.
    
    Parameters:
    
    forceBundleReplication - true if this search should cause bundle synchronization, false if not.
  - setId
```
public void setId(String id)
```
    Sets a search ID (SID). If unspecified, a random ID is generated.
    
    Parameters:
    
    id - The search ID.
  - setLatestTime
```
public void setLatestTime(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.
  - setMaximumCount
```
public void setMaximumCount(int maximumCount)
```
    Sets the number of events that can be accessible in any given status bucket. Also, in transforming mode, this sets the maximum number of results to store. Specifically, in all calls, codeoffset + count <= max_count.
    
    Parameters:
    
    maximumCount - The maximum count of events.
  - setMaximumTime
```
public void setMaximumTime(int maximumTime)
```
    Sets the maximum number of seconds to run this search before finalizing. Specify 0 to never finalize.
    
    Parameters:
    
    maximumTime - The maximum time, in seconds.
  - setNamespace
```
public void setNamespace(String namespace)
```
    Specifies the application namespace to which to restrict searches.
    
    Parameters:
    
    namespace - The namespace.
  - setNow
```
public void setNow(String now)
```
    Specifies a time string that sets the absolute time used for any relative time specifier in the search. This value defaults to the current system time.
    You can specify a relative time modifier for this parameter. For example, specify +2d to specify the current time plus two days. If you specify a relative time modifier both in this parameter and in the search string, the search string modifier takes precedence.
    For information about relative time modifiers, see Time modifiers for search in the Search Reference.
    
    Parameters:
    
    now - The time string.
  - setReduceFrequency
```
public void setReduceFrequency(int reduceFrequency)
```
    Sets the time to wait between running the MapReduce phase on accumulated map values.
    
    Parameters:
    
    reduceFrequency - The time to wait, in seconds.
  - setReloadMacros
```
public void setReloadMacros(boolean reloadMacros)
```
    Indicates whether to reload macro definitions from the macros.conf configuration file.
    
    Parameters:
    
    reloadMacros - true to reload macro definitions, false if not.
  - setRemoteServerList
```
public void setRemoteServerList(String[] remoteServerList)
```
    Sets a list of (possibly wildcarded) servers from which to pull raw events. This same server list is used in subsearches.
    
    Parameters:
    
    remoteServerList - The list of servers.
  - setRequiredFieldList
```
public void setRequiredFieldList(String[] requiredFieldList)
```
    Sets one or more required fields to the search. These fields, even if not referenced or used directly by the search, are still included by the events and summary endpoints. Splunk Web uses these fields to prepopulate panels in the Search view.
    
    Parameters:
    
    requiredFieldList - The list of fields.
  - setRealtimeBlocking
```
public void setRealtimeBlocking(boolean realtimeBlocking)
```
    Indicates whether the indexer blocks if the queue for this search is full. Only applies to real-time searches.
    
    Parameters:
    
    realtimeBlocking - true to block the indexer for a full queue, false if not.
  - setRealtimeIndexFilter
```
public void setRealtimeIndexFilter(boolean realtimeIndexFilter)
```
    Indicates whether the indexer pre-filters events. Only applies to real-time searches.
    
    Parameters:
    
    realtimeIndexFilter - true to pre-filter events, false if not.
  - setRealtimeMaximumBlockSeconds
```
public void setRealtimeMaximumBlockSeconds(int realtimeMaximumBlockSeconds)
```
    Sets the number of seconds indicating the maximum time to block. A value of 0 means no limit. For real-time searches with "rt_blocking" set to true.
    
    Parameters:
    
    realtimeMaximumBlockSeconds - The maximum time to block, in seconds.
  - setRealtimeQueueSize
```
public void setRealtimeQueueSize(int realtimeQueueSize)
```
    Sets the number indicating the queue size (in events) that the indexer should use for this search. Only applies to real-time searches.
    
    Parameters:
    
    realtimeQueueSize - The queue size, in events.
  - setSearchListener
```
public void setSearchListener(String searchListener)
```
    Sets a string that registers a search state listener with the search. Use the format: search_state;results_condition;http_method;uri;
    For example:
    search_listener=onResults;true;POST;/servicesNS/admin/search/saved/search/foobar/notify;
    
    Parameters:
    
    searchListener - The search listener string.
  - setSearchMode
```
public void setSearchMode(JobArgs.SearchMode searchMode)
```
    Sets the search mode ("normal" or "realtime").
    
    Parameters:
    
    searchMode - The search mode.
  - setSpawnProcess
```
public void setSpawnProcess(boolean spawnProcess)
```
    Indicates whether the search should run in a separate spawned process. Searches against indexes must run in a separate process.
    
    Parameters:
    
    spawnProcess - true to run the search in a separate process, false if not.
  - setStatusBuckets
```
public void setStatusBuckets(int statusBuckets)
```
    Sets the maximum number of status buckets to generate. A value of 0 means to not generate timeline information.
    
    Parameters:
    
    statusBuckets - The maximum number of buckets.
  - setSynchronizeBundleReplication
```
public void setSynchronizeBundleReplication(boolean synchronizeBundleReplication)
```
    Indicates whether this search should wait for bundle replication to complete.
    
    Parameters:
    
    synchronizeBundleReplication - true to wait for bundle replication, false if not.
  - setTimeFormat
```
public void setTimeFormat(String timeFormat)
```
    Sets the format for converting a formatted time string from {start,end}_time into UTC seconds. The default value is ISO-8601.
    
    Parameters:
    
    timeFormat - The time format string.
  - setTimeout
```
public void setTimeout(int timeout)
```
    Sets the number of seconds to keep this search after processing has stopped.
    
    Parameters:
    
    timeout - The timeout, in seconds.

Class JobArgs

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.splunk.Args

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

JobArgs

Method Detail

setAutoCancel

setAutoFinalizeEventCount

setAutoPause

setEarliestTime

setEnableLookups

setExecutionMode

setForceBundleReplication

setId

setLatestTime

setMaximumCount

setMaximumTime

setNamespace

setNow

setReduceFrequency

setReloadMacros

setRemoteServerList

setRequiredFieldList

setRealtimeBlocking

setRealtimeIndexFilter

setRealtimeMaximumBlockSeconds

setRealtimeQueueSize

setSearchListener

setSearchMode

setSpawnProcess

setStatusBuckets

setSynchronizeBundleReplication

setTimeFormat

setTimeout