Application Framework Reference

Splunk API

isEventStreaming()

The isEventStreaming() method checks if the current job permits partial events and results retrieval.

Synopsis

status = isEventStreaming()

Return Value

Boolean

Job permits retrieval of partial events and results indication:

true = Job permits partial event or result streaming.

false = Job does not permit partial event or result streaming.

Example

var context = this.getContext();
var search = context.get('search');
if (search.job.isEventStreaming()) {
   console.log('Job permits partial event streaming!');
} else {
   console.log('Job does not permit partial event streaming!');
}
 

See Also

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