Application Framework Reference

Splunk API

setSearchId()

The setSearchId() method sets the current job search identifier to the specified value. This method is automatically called when Splunk creates a search job.

Synopsis

setSearchId( searchID )

Parameters

searchID

String

Search identifier.

Example 

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

search.job.setSearchId("TEST_HARNESS_MODE_ID_" + (20000*Math.random()));

See Also

getSearchId()
 getSID()
 setSID()

Programming Reference


Extension point dictionary

class Splunk.Context
class Splunk.Job
     constructor
     areResultsTransformed()
     canBeAutoCancelled()
     cancel()
     finalize()
     getCreateTime()
     getCursorTime()
     getDoneProgress()
     getEventAvailableCount()
     getEventCount()
     getEventFieldCount()
     getEventSearch()
     getEventSorting()
     getResultCount()
     getScanCount()
     getSearch()
     getSearchId()
     getSID()
     getStatusBuckets()
     getTimeRange()
     getTimeSinceLastProgress()
     isCanceled()
     isDone()
     isEventStreaming()
     isFinalized()
     isPaused()
     isPreviewable()
     isRealTimeSearch()
     isRunning()
     isSaved()
     makeWorldReadable()
     pause()
     save()
     setAsAutoCancellable()
     setLastProgressTime()
     setPreviewable()
     setSearchId()
     setSID()
     setTTL()
     touch()
     undoWorldReadable()
     unpause()
     unsave()
class Splunk.Search
class Splunk.TimeRange
Splunk Utilities
class Splunk.Module
class Splunk.Module.DispatchingModule
class ModuleController
class ModuleHandler
class BaseController
class SplunkRESTModel
class SplunkAppObjModel
class ObjectMetadataModel
class SplunkRESTManager
class SplunkQuerySet
Decorators
Template Utilities
App Server Utilities
 

Questions?

Splunk and our developer community are here to help.