com.splunk

Class JobEventsArgs

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

com.splunk.Args

com.splunk.JobEventsArgs

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class JobEventsArgs
extends Args

The JobEventsArgs class contains arguments for getting events using the Job.getEvents() method.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobEventsArgs.OutputMode Specifies the format for the returned output.
static class	JobEventsArgs.TruncationMode Specifies how to truncate lines to achieve the value in setMaximumLines(int).

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

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

Constructor Summary

Constructors

Constructor and Description
JobEventsArgs() Class constructor.

Method Summary

Modifier and Type	Method and Description
void	setCount(int count) Sets the maximum number of results to return.
void	setEarliestTime(String earliestTime) Specifies the earliest time in the time range to search.
void	setFieldList(String[] fieldList) Sets a list of fields to return for the event set.
void	setLatestTime(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	setOffset(int offset) Specifies the index of the first result (inclusive) from which to begin returning data.
void	setOutputMode(JobEventsArgs.OutputMode outputMode) Sets the format of the output.
void	setOutputTimeFormat(String outputTimeFormat) Sets a UTC time format.
void	setSearch(String search) Sets the post-processing search to apply to results.
void	setSegmentation(String segmentation) Sets the type of segmentation to perform on the data, including an option to perform k/v segmentation.
void	setTimeFormat(String timeFormat) Specifies an expression to convert a formatted time string from {start,end}_time into UTC seconds.
void	setTruncationMode(JobEventsArgs.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, 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

JobEventsArgs

public JobEventsArgs()

Class constructor.

Method Detail

setCount

public void setCount(int count)

Sets the maximum number of results to return. To return all available results, specify 0. The default value is 100.

Parameters:

count - The maximum number of results.

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.

setFieldList

public void setFieldList(String[] fieldList)

Sets a list of fields to return for the event set.

Parameters:

fieldList - A list of fields.

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.

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.

setOffset

public void setOffset(int offset)

Specifies the index of the first result (inclusive) from which to begin returning data. This value is 0-indexed.

In Splunk 4.1+, negative offsets are allowed and are added to the count to compute the absolute offset (for example, offset=-1 is the last available offset). Offsets in the results are always absolute and never negative. The default value is 0.

Parameters:

offset - The index of the first result to return.

setOutputMode

public void setOutputMode(JobEventsArgs.OutputMode outputMode)

Sets the format of the output.

Parameters:

outputMode - The output format.

setOutputTimeFormat

public void setOutputTimeFormat(String outputTimeFormat)

Sets a UTC time format.

Parameters:

outputTimeFormat - A UTC time format.

setSearch

public void setSearch(String search)

Sets the post-processing search to apply to results.

Parameters:

search - The post-processing search query.

setSegmentation

public void setSegmentation(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.

setTimeFormat

public void setTimeFormat(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.

setTruncationMode

public void setTruncationMode(JobEventsArgs.TruncationMode truncationMode)

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

Parameters:

truncationMode - The truncation mode.