com.splunk

Enum JobArgs.SearchMode

java.lang.Object

java.lang.Enum<JobArgs.SearchMode>

com.splunk.JobArgs.SearchMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobArgs.SearchMode>

Enclosing class:

JobArgs

public static enum JobArgs.SearchMode
extends java.lang.Enum<JobArgs.SearchMode>

Specifies how to create a job using the JobCollection.create(java.lang.String) method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NORMAL Searches historical data.
REALTIME Searches live data.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static JobArgs.SearchMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobArgs.SearchMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final JobArgs.SearchMode NORMAL

Searches historical data.

REALTIME

public static final JobArgs.SearchMode REALTIME

Searches live data. A real-time search may also be specified by setting the "earliest_time" and "latest_time" parameters to begin with "rt", even if the search_mode is set to "normal" or is not set.

If both the "earliest_time" and "latest_time" parameters are set to "rt", the search represents all appropriate live data that was received since the start of the search.

If both the "earliest_time" and "latest_time" parameters are set to "rt" followed by a relative time specifier, a sliding window is used where the time bounds of the window are determined by the relative time specifiers and are continuously updated based on current time.

Method Detail

values

public static JobArgs.SearchMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JobArgs.SearchMode c : JobArgs.SearchMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JobArgs.SearchMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<JobArgs.SearchMode>

Returns:

The REST API value for this enumerated constant.