Creates a search job with a given search query and optional parameters, including exec_mode
to specify the type of search:
Use exec_mode=normal
to return a search job ID immediately (default). Poll for completion to find out when you can retrieve search results.
Use exec_mode=blocking
to return the search job ID when the search has finished.
To run a oneshot search, which does not create a job but rather returns the search results, use Service.Jobs.oneshotSearch
.
create: function(query, params, response_timeout) {
if (utils.isObject(query) && (utils.isNumber(params) || !params) && !response_timeout) {
response_timeout = params;
params = query;
query = params.search;
}
params = params || {};
params.search = query;
if ((params.exec_mode || "").toLowerCase() === "oneshot") {
return Promise.reject(new Error("Please use splunkjs.Service.Jobs.oneshotSearch for exec_mode=oneshot"));
}
if (!params.search) {
return Promise.reject("Must provide a query to create a search job");
}
var that = this;
return this.post("", params, response_timeout).then((response) => {
let job = new root.Job(that.service, response.data.sid, that.namespace);
return job;
});
},