Application Framework Reference

Splunk API

isFinalized()

The isFinalized() method checks the current job was stopped (finalized) before it completed.

Synopsis

results = isFinalized()

Return Value

Boolean

Job finalized state:

true = Job stopped before it completed.

false = Job was not stopped before it completed.

Example

var context = this.getContext();
var search = context.get('search');
if (search.job.isFinalized()) {
    console.log('job stopped before it completed!');
} else {
    console.log('job was NOT stopped before it completed!');
}
 

See Also

isCanceled()
isDone()
isEventStreaming()
isPaused()
isPreviewable()
isRealTimeSearch()
isRunning()
isSaved()