com.splunk
Enum JobArgs.ExecutionMode

java.lang.Object
  java.lang.Enum<JobArgs.ExecutionMode>
      com.splunk.JobArgs.ExecutionMode

All Implemented Interfaces:

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

Enclosing class:

JobArgs

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

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

Enum Constant Summary

BLOCKING
Runs a search synchronously and does not return a search job until the search has finished.

NORMAL
Runs a search asynchronously and returns a search job immediately.

ONESHOT
Runs a blocking search that is scheduled to run immediately, then returns the results of the search once completed.

Method Summary

java.lang.String	toString()
static JobArgs.ExecutionMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobArgs.ExecutionMode[]	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.ExecutionMode NORMAL

Runs a search asynchronously and returns a search job immediately.

BLOCKING

public static final JobArgs.ExecutionMode BLOCKING

Runs a search synchronously and does not return a search job until the search has finished.

ONESHOT

public static final JobArgs.ExecutionMode ONESHOT

Runs a blocking search that is scheduled to run immediately, then returns the results of the search once completed.

Method Detail

values

public static JobArgs.ExecutionMode[] 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.ExecutionMode c : JobArgs.ExecutionMode.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.ExecutionMode 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.ExecutionMode>

Returns:

The REST API value for this enumerated constant.