com.splunk
Class JobExportArgs

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class JobExportArgs
extends Args

The JobExportArgs class contains arguments for exporting events using the Service.export(java.lang.String) method.

See Also:

Serialized Form

Nested Class Summary

static class	JobExportArgs.OutputMode Specifies the format for the returned output.
static class	JobExportArgs.SearchMode Specifies how to create a job using the JobCollection.create(java.lang.String) method.
static class	JobExportArgs.TruncationMode Specifies how to truncate lines to achieve the value in setMaximumLines(int).

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

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

Constructor Summary

JobExportArgs()
Class constructor.

Method Summary

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(java.lang.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	setForceBundleReplication(boolean forceBundleReplication) Specifies whether this search should cause (and wait depending on the value of setSynchronizeBundleReplication) bundle synchronization with all search peers.
void	setIndexEarliest(java.lang.String indexEarliest) Specifies the earliest time in the time range to search, based on the index time.
void	setIndexLatest(java.lang.String indexLatest) Specifies the latest time in the time range to search, based on the index time.
void	setLatestTime(java.lang.String latestTime) Specifies the latest time in the time range to search.
void	setMaximumLines(int maximumLines) Sets the maximum number of lines that any single event's _raw field should contain.
void	setMaximumTime(int maximumTime) Sets the number of seconds to run this search before finalizing.
void	setNamespace(java.lang.String namespace) Specifies the application namespace in which to restrict searches.
void	setNow(java.lang.String now) Specifies a time string that sets the absolute time used for any relative time specifier in the search.
void	setOutputMode(JobExportArgs.OutputMode outputMode) Sets the format of the output.
void	setOutputTimeFormat(java.lang.String outputTimeFormat) Sets a UTC time format.
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(java.lang.String[] remoteServerList) Sets a list of (possibly wildcarded) servers from which to pull raw events.
void	setRequiredFieldList(java.lang.String[] requiredFieldList) Sets one or more required fields to the search.
void	setSearchListener(java.lang.String searchListener) Sets a string that registers a search state listener with the search.
void	setSearchMode(JobExportArgs.SearchMode searchMode) Sets the search mode ("normal" or "realtime").
void	setSegmentation(java.lang.String segmentation) Sets the type of segmentation to perform on the data, including an option to perform k/v segmentation.
void	setSynchronizeBundleReplication(boolean synchronizeBundleReplication) Indicates whether this search should wait for bundle replication to complete.
void	setTimeFormat(java.lang.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.
void	setTruncationMode(JobExportArgs.TruncationMode truncationMode) Specifies how to truncate lines to achieve the value in setMaximumLines(int).

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

JobExportArgs

public JobExportArgs()

Class constructor.

Method Detail

setIndexEarliest

public void setIndexEarliest(java.lang.String indexEarliest)

Specifies the earliest time in the time range to search, based on the index time. The time string can be a UTC time (with fractional seconds), a relative time specifier (to now), or a formatted time string.

Parameters:

indexEarliest - The earliest time.

setIndexLatest

public void setIndexLatest(java.lang.String indexLatest)

Specifies the latest time in the time range to search, based on the index time. The time string can be a UTC time (with fractional seconds), a relative time specifier (to now), or a formatted time string.

Parameters:

indexLatest - The latest time.

setOutputMode

public void setOutputMode(JobExportArgs.OutputMode outputMode)

Sets the format of the output.

Parameters:

outputMode - The output format.

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(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.

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.

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.

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.

setMaximumTime

public void setMaximumTime(int maximumTime)

Sets the 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(java.lang.String namespace)

Specifies the application namespace in which to restrict searches.

Parameters:

namespace - The namespace.

setNow

public void setNow(java.lang.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 - A 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(java.lang.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 - A list of servers.

setRequiredFieldList

public void setRequiredFieldList(java.lang.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(java.lang.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(JobExportArgs.SearchMode searchMode)

Sets the search mode ("normal" or "realtime").

Parameters:

searchMode - The search mode.

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(java.lang.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.

setMaximumLines

public void setMaximumLines(int maximumLines)

Sets the maximum number of lines that any single event's _raw field should contain.

Parameters:

maximumLines - The maximum number of lines. For no limit, specify 0.

setOutputTimeFormat

public void setOutputTimeFormat(java.lang.String outputTimeFormat)

Sets a UTC time format.

Parameters:

outputTimeFormat - A UTC time format.

setSegmentation

public void setSegmentation(java.lang.String segmentation)

Sets the type of segmentation to perform on the data, including an option to perform k/v segmentation.

Parameters:

segmentation - The segmentation type.

setTruncationMode

public void setTruncationMode(JobExportArgs.TruncationMode truncationMode)

Specifies how to truncate lines to achieve the value in setMaximumLines(int).

Parameters:

truncationMode - The truncation mode.