com.splunk
Class JobResultsPreviewArgs

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

All Implemented Interfaces:

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

public class JobResultsPreviewArgs
extends Args

The JobResultsPreviewArgs class contains arguments for getting job results previews using the Job.getResultsPreview() method.

See Also:

Serialized Form

Nested Class Summary

static class

JobResultsPreviewArgs.OutputMode Specifies the format for the returned output.

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

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

Constructor Summary

JobResultsPreviewArgs()
Class constructor.

Method Summary

void	setCount(int count) Sets the maximum number of results to return.
void	setFieldList(java.lang.String[] fieldList) Sets a list of fields to return for the event set.
void	setOffset(int offset) Specifies the index of the first result (inclusive) from which to begin returning data.
void	setOutputMode(JobResultsPreviewArgs.OutputMode outputMode) Sets the format of the output.
void	setSearch(java.lang.String search) Sets the post-processing search to apply to results.

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

JobResultsPreviewArgs

public JobResultsPreviewArgs()

Class constructor.

Method Detail

setCount

public void setCount(int count)

Sets the maximum number of results to return.

Parameters:

count - The maximum number of results. To return all available results, specify 0.

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.

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(JobResultsPreviewArgs.OutputMode outputMode)

Sets the format of the output.

Parameters:

outputMode - The output format.

setSearch

public void setSearch(java.lang.String search)

Sets the post-processing search to apply to results.

Parameters:

search - The post-processing search query.