Application Framework Reference

Splunk API

pause()

The pause() method suspends processing for the current job until either unpause(), save(), finalize(), or cancel() is requested.

Because you cannot predict when jobs are polled, it is possible to request that a job be paused that has already completed. The first time the server detects a job is paused triggers a jobPaused event. If the server also detects a job has completed, jobProgress and jobDone events are triggered.

Synopsis

pause( onSuccess , onFailure )

Parameters

onSuccess

Function

(Optional) Function to execute upon successful operation.

onFailure

Function

(Optional) Function to execute upon unsuccessful operation.

Example

var context = this.getContext();
var search = context.get('search');

if (!search.job.isDone()) {
   search.job.pause(
      function() { console.log('Current job successfully paused!'); },
      function() { console.log('Failed to pause current job!'); } );
} else {
   console.log('Current job has already completed!');
}
 

See Also

isDone()
isPaused()
isRunning()
unPause()