Creates an asyncronous search job.
Creates an asyncronous search job.
| Name | Type | Description |
|---|---|---|
| query | String | The search query. |
| params | Object | A dictionary of properties for the search job. For details, see the POST search/jobs endpoint in the REST API documentation. |
| callback | Function | A function to call with the created job: |
create: function(query, params, callback) {
// If someone called us with the default style of (params, callback),
// lets make it work
if (utils.isObject(query) && utils.isFunction(params) && !callback) {
callback = params;
params = query;
query = params.search;
}
callback = callback || function() {};
params = params || {};
params.search = query;
if ((params.exec_mode || "").toLowerCase() === "oneshot") {
throw new Error("Please use splunkjs.Service.Jobs.oneshotSearch for exec_mode=oneshot");
}
if (!params.search) {
callback("Must provide a query to create a search job");
return;
}
var that = this;
return this.post("", params, function(err, response) {
if (err) {
callback(err);
}
else {
var job = new root.Job(that.service, response.data.sid, that.namespace);
callback(null, job);
}
});
},Constructor for splunkjs.Service.Jobs.
| Name | Type | Description |
|---|---|---|
| service | splunkjs.Service | A |
| namespace | Object | Namespace information (owner, app, sharing). |
A new splunkjs.Service.Jobs instance.
init: function(service, namespace) {
this._super(service, this.path(), namespace);
// We perform the bindings so that every function works
// properly when it is passed as a callback.
this.create = utils.bind(this, this.create);
},Creates a local instance of an entity.
| Name | Type | Description |
|---|---|---|
| props | Object | The properties for this entity. For details, see the POST search/jobs endpoint in the REST API documentation. |
A new splunkjs.Service.Job instance.
instantiateEntity: function(props) {
var sid = props.content.sid;
var entityNamespace = utils.namespaceFromProperties(props);
return new root.Job(this.service, sid, entityNamespace);
},Creates a oneshot search job from a given search query and parameters.
| Name | Type | Description |
|---|---|---|
| query | String | The search query. |
| params | Object | A dictionary of properties for the search job. For details, see the POST search/jobs endpoint in the REST API documentation. |
| callback | Function | A function to call with the results of the search job: |
var jobs = service.jobs();
jobs.oneshotSearch("search ERROR", {id: "myjob_123"}, function(err, results) {
console.log("RESULT FIELDS": results.fields);
});
oneshotSearch: function(query, params, callback) {
// If someone called us with the default style of (params, callback),
// lets make it work
if (utils.isObject(query) && utils.isFunction(params) && !callback) {
callback = params;
params = query;
query = params.search;
}
callback = callback || function() {};
params = params || {};
params.search = query;
params.exec_mode = "oneshot";
if (!params.search) {
callback("Must provide a query to create a search job");
}
var outputMode = params.output_mode || "json_rows";
var path = this.qualifiedPath;
var method = "POST";
var headers = {};
var post = params;
var get = {output_mode: outputMode};
var body = null;
var req = this.service.request(
path,
method,
get,
post,
body,
headers,
function(err, response) {
if (err) {
callback(err);
}
else {
callback(null, response.data);
}
}
);
return req;
}
});
})();Retrieves the REST endpoint path for this resource (with no namespace).
path: function() {
return Paths.jobs;
},Creates an asyncronous search job with a given search query and parameters.
| Name | Type | Description |
|---|---|---|
| query | String | The search query. |
| params | Object | A dictionary of properties for the search job. For details, see the POST search/jobs endpoint in the REST API documentation. |
| callback | Function | A function to call with the new search job: |
var jobs = service.jobs();
jobs.search("search ERROR", {id: "myjob_123"}, function(err, newJob) {
console.log("CREATED": newJob.sid);
});
search: function(query, params, callback) {
return this.create(query, params, callback);
},Performs a relative DELETE request on an endpoint's path, combined with the parameters and a relative path if specified.
| Name | Type | Description |
|---|---|---|
| relpath | String | A relative path to append to the path. |
| params | Object | A dictionary of parameters to add to the query string. |
| callback | Function | A function to call when the request is complete: |
// Will make a request to {service.prefix}/search/jobs/123456
var endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
endpoint.delete("", {}, function() { console.log("DELETED"))});
del: function(relpath, params, callback) {
var url = this.qualifiedPath;
// If we have a relative path, we will append it with a preceding
// slash.
if (relpath) {
url = url + "/" + relpath;
}
return this.service.del(
url,
params,
callback
);
}
});Refreshes the resource by fetching the object from the server and loading it.
| Name | Type | Description |
|---|---|---|
| options | Object | A dictionary of collection filtering and pagination options. |
| callback | Function | A function to call when the object is retrieved: |
fetch: function(options, callback) {
if (!callback && utils.isFunction(options)) {
callback = options;
options = {};
}
callback = callback || function() {};
options = options || {};
if (!options.count) {
options.count = 0;
}
var that = this;
var req = that.get("", options, function(err, response) {
if (err) {
callback(err);
}
else {
that._load(response.data);
callback(null, that);
}
});
return req;
},Indicates whether to call fetch after an entity has been created. By default, the entity is not fetched because the endpoint returns (echoes) the new entity.
fetchOnEntityCreation: false,Performs a relative GET request on an endpoint's path, combined with the parameters and a relative path if specified.
| Name | Type | Description |
|---|---|---|
| relpath | String | A relative path to append to the path. |
| params | Object | A dictionary of parameters to add to the query string. |
| callback | Function | A function to call when the request is complete: |
// Will make a request to {service.prefix}/search/jobs/123456/results?offset=1
var endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
endpoint.get("results", {offset: 1}, function() { console.log("DONE"))});
get: function(relpath, params, callback) {
var url = this.qualifiedPath;
// If we have a relative path, we will append it with a preceding
// slash.
if (relpath) {
url = url + "/" + relpath;
}
return this.service.get(
url,
params,
callback
);
},Returns a specific entity from the collection.
| Name | Type | Description |
|---|---|---|
| id | String | The name of the entity to retrieve. |
| namespace | Object | Namespace information (owner, app, sharing). |
var apps = service.apps();
apps.fetch(function(err, apps) {
var app = apps.item("search");
console.log("Search App Found: " + !!app);
// `app` is an Application object.
});
item: function(id, namespace) {
if (utils.isEmpty(namespace)) {
namespace = null;
}
if (!id) {
throw new Error("Must suply a non-empty name.");
}
var fullPath = null;
if (this._entitiesByName.hasOwnProperty(id)) {
var entities = this._entitiesByName[id];
if (entities.length === 1 && !namespace) {
// If there is only one entity with the
// specified name and the user did not
// specify a namespace, then we just
// return it
return entities[0];
}
else if (entities.length === 1 && namespace) {
// If we specified a namespace, then we
// only return the entity if it matches
// the full path
fullPath = this.service.fullpath(entities[0].path(), namespace);
if (entities[0].qualifiedPath === fullPath) {
return entities[0];
}
else {
return null;
}
}
else if (entities.length > 1 && !namespace) {
// If there is more than one entity and we didn't
// specify a namespace, then we return an error
// saying the match is ambiguous
throw new Error("Ambiguous match for name '" + id + "'");
}
else {
// There is more than one entity, and we do have
// a namespace, so we try and find it
for(var i = 0; i < entities.length; i++) {
var entity = entities[i];
fullPath = this.service.fullpath(entities[i].path(), namespace);
if (entity.qualifiedPath === fullPath) {
return entity;
}
}
}
}
else {
return null;
}
},Retrieves the links information for this collection, which is the URI of the resource relative to the management port of a Splunk instance.
The links information.
links: function() {
return this._links;
},Retrieves a list of all entities in the collection.
| Name | Type | Description |
|---|---|---|
| callback | Function | A function to call with the list of entities: |
var apps = service.apps();
apps.fetch(function(err, apps) {
var appList = apps.list();
console.log(appList.length);
});
list: function(callback) {
callback = callback || function() {};
return utils.clone(this._entities);
}
});Retrieves the author information for this collection.
The author.
paging: function() {
return this._paging;
},Performs a relative POST request on an endpoint's path, combined with the parameters and a relative path if specified.
| Name | Type | Description |
|---|---|---|
| relpath | String | A relative path to append to the path. |
| params | Object | A dictionary of parameters to add to the body. |
| callback | Function | A function to call when the request is complete: |
// Will make a request to {service.prefix}/search/jobs/123456/control
var endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
endpoint.post("control", {action: "cancel"}, function() { console.log("CANCELLED"))});
post: function(relpath, params, callback) {
var url = this.qualifiedPath;
// If we have a relative path, we will append it with a preceding
// slash.
if (relpath) {
url = url + "/" + relpath;
}
return this.service.post(
url,
params,
callback
);
},Retrieves the current properties for this resource.
The properties for this resource.
properties: function() {
return this._properties;
},Retrieves the current full state of this resource.
The current full state of this resource.
state: function() {
return this._state;
}
});Retrieves the updated time for this collection.
The updated time.
updated: function() {
return this._updated;
},