App Framework Reference

Splunk API

Splunk.Search

The Splunk.Search class encapsulates a Search object.

Language Binding

JavaScript

Declaration

$SPLUNK_HOME/share/splunk/search_mrsparkle/exposed/js/search.js

Implementation Location

$SPLUNK_HOME/etc/apps/ <appName> /appserver/modules/ <moduleName>

Constructor

Methods

`abandonJob()`	Removes the search object job from the view jobber queue.
`absorbIntentions()`	Flatten the base search and intentions array into a search string.
`addIntention()`	Adds the specified intention dictionary to the previous intentions list.
`clearIntentions()`	Empties the search object intentions list.
`clearTimeRange()`	Resets the search TimeRange object.
`clone()`	Instantiates a search object identical to the current search object.
`dispatchJob()`	Dispatches a search job.
`equalToSearch()`	Tests if a context current search is equal to the specified search.
`getBaseSearch()`	Gets the base search.
`getDistributedServerList()`	Gets the list of search peers.
`getEventAvailableCount()`	Gets the current count of available events.
`getEventCount()`	Gets the current count of available events.
`getIntentionReference()`	Gets a reference to the specified intentions.
`getMaxCount()`	Gets the search max count setting.
`getMaxEvents()`	Gets the max events setting for a search.
`getMaxTime()`	Gets the max time setting for a search.
`getMinimumStatusBuckets()`	Gets the value of the status buckets setting for a search.
`getPostProcess()`	Gets the post process value of the current search.
`getRequiredFieldList()`	Gets the required field list of the current search.
`getSavedSearchName()`	Gets the saved search name of the current search.
`getTimeRange()`	Gets the current search `Splunk.TimeRange` object.
`getUrl()`	Gets the URI to access resources for the current search job.
`getViewStateId()`	Gets the current search object view state ID property.
`hasIntentions()`	Indicates if the current search object has intentions.
`isJobDispatched()`	Indicates if the current job has been dispatched.
`popIntention()`	Gets the specified intention.
`resurrect()`	Gets a search object containing a previously dispatched job.
`sendToView()`	Redirects the user and current search to the specified view.
`setBaseSearch()`	Replaces the current base search with the specified search string.
`setDistributedServerList()`	Sets the list search peers.
`setIntentions()`	Replaces the current search intentions.
`setMaxCount()`	Sets the search max count property.
`setMaxEvents()`	Sets the max events property for a search.
`setMaxTime()`	Sets the maximum time for a search.
`setMinimumStatusBuckets()`	Specifies the minimum number of status buckets to generate.
`setPostProcess()`	Stores a post-processing string in the current search.
`setRequiredFields()`	Sets the fields that must be present in the event or result set.
`setSavedSearchName()`	Sets the current search saved search name.
`setSelectedEventAvailableCount()`	Sets the search job event available count.
`setSelectedEventCount()`	Sets the current search job event count.
`setTimeRange()`	Sets the current search time range.
`setViewStateId()`	Sets the search object view state.
`toString()`	Gets the current search as a string.