Application Framework Reference

Splunk API

isPaused()

The isPaused() method checks if the current job is paused. A job that has completed is considered not paused.

Synopsis

results = isPaused()

Return Value

Boolean

Job paused state:

true = Job is paused.

false = Job is not paused.

Example

var context = this.getContext();
var search = context.get('search');
if (search.job.isPaused()) {
    console.log('Current job is paused!');
} else {
    console.log('Current job is NOT paused!');
}
 

See Also

isCanceled()
isDone()
isEventStreaming()
isFinalized()
isPreviewable()
isRealTimeSearch()
isRunning()
isSaved()
pause()
unpause()