Application Framework Reference

Splunk API

setMaxEvents()

The setMaxEvents() method sets the maxEvents property for a search, specifying the maximum number of events that each of a search job status buckets can contain.

Note: If the search is dispatched with status_buckets>=1 , the maxEvents setting is ignored by splunkd.

Synopsis

setMaxEvents( maxEvents )

Parameters

maxEvents

Integer

Maximum number of events in job status bucket. Default = 10,000.

Return Value

Undefined

Example

var context = this.getContext();var search  = context.get("search");
search.setMaxEvents(31337);
context.set('search', search);
return context;