hasObject

splunkjs.Service.DataModel.hasObject

Returns a boolean of whether this exists in this data model or not.

Syntax

hasObject: function(name)

Return

Boolean.

Returns true if this data model has object with specified name, false otherwise.

init

splunkjs.Service.DataModel.init

Constructor for splunkjs.Service.DataModel.

Syntax

init: function(service, name, namespace, props)

Parameters

Name Type Description
service splunkjs.Service

A Service instance.

name String

The name for the new data model.

namespace Object

(Optional) namespace information:
- owner (string): The Splunk username, such as "admin". A value of "nobody" means no specific user. The "-" wildcard means all users.
- app (string): The app context for this resource (such as "search"). The "-" wildcard means all apps.
- sharing (string): A mode that indicates how the resource is shared. The sharing mode can be "user", "app", "global", or "system".

props Object

Properties of this data model:
- acceleration (string): A JSON object with an enabled key, representing if acceleration is enabled or not.
- concise (string): Indicates whether to list a concise JSON description of the data model, should always be "0".
- description (string): The JSON describing the data model.
- displayName (string): The name displayed for the data model in Splunk Web.

isAccelerated

splunkjs.Service.DataModel.isAccelerated

Returns a boolean indicating whether acceleration is enabled or not.

Syntax

isAccelerated: function()

Return

Boolean.

true if acceleration is enabled, false otherwise.

objectByName

splunkjs.Service.DataModel.objectByName

Returns a data model object from this data model with the specified name if it exists, null otherwise.

Syntax

objectByName: function(name)

Return

Object,null.

a data model object.

path

splunkjs.Service.DataModel.path

Retrieves the REST endpoint path for this resource (with no namespace).

Syntax

path: function()

update

splunkjs.Service.DataModel.update

Updates the data model on the server, used to update acceleration settings.

Syntax

update: function(props, callback)

Parameters

Name Type Description
props Object

A dictionary of properties to update the object with:
- acceleration (object): The acceleration settings for the data model.
Valid keys are: enabled, earliestTime, cronSchedule.
Any keys not set will be pulled from the acceleration settings already
set on this data model.

callback Function

A function to call when the data model is updated: (err, dataModel).

_load

splunkjs.Service.Entity._load

Loads the entity and stores the properties.

Syntax

_load: function(properties)

Parameters

Name Type Description
properties Object

The properties for this entity.

acl

splunkjs.Service.Entity.acl

Retrieves the access control list (ACL) information for this entity, which contains the permissions for accessing the entity.

Syntax

acl: function()

Return

Object.

The ACL.

author

splunkjs.Service.Entity.author

Retrieves the author information for this entity.

Syntax

author: function()

Return

String.

The author.

del

splunkjs.Service.Endpoint.del

Performs a relative DELETE request on an endpoint's path, combined with the parameters and a relative path if specified.

Syntax

del: function(relpath, params, callback)

Parameters

Name Type Description
relpath String

A relative path to append to the endpoint path.

params Object

A dictionary of entity-specific parameters to add to the query string.

callback Function

A function to call when the request is complete: (err, response).

Examples

 // 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"))});

disable

splunkjs.Service.Entity.disable

Disables the entity on the server.

Syntax

disable: function(callback)

Parameters

Name Type Description
callback Function

A function to call when the object is disabled: (err, entity).

enable

splunkjs.Service.Entity.enable

Enables the entity on the server.

Syntax

enable: function(callback)

Parameters

Name Type Description
callback Function

A function to call when the object is enabled: (err, entity).

fetch

splunkjs.Service.Entity.fetch

Refreshes the entity by fetching the object from the server and loading it.

Syntax

fetch: function(options, callback)

Parameters

Name Type Description
options Object

An optional dictionary of collection filtering and pagination options:
- count (integer): The maximum number of items to return.
- offset (integer): The offset of the first item to return.
- search (string): The search query to filter responses.
- sort_dir (string): The direction to sort returned items: “asc” or “desc”.
- sort_key (string): The field to use for sorting (optional).
- sort_mode (string): The collating sequence for sorting returned items: “auto”, “alpha”, “alpha_case”, or “num”.

callback Function

A function to call when the object is retrieved: (err, resource).

fetchOnUpdate

splunkjs.Service.Entity.fetchOnUpdate

A static property that indicates whether to call fetch after an update to get the updated entity. By default, the entity is not fetched because the endpoint returns (echoes) the updated entity.

fields

splunkjs.Service.Entity.fields

Retrieves the fields information for this entity, indicating which fields are wildcards, required, and optional.

Syntax

fields: function()

Return

Object.

The fields information.

get

splunkjs.Service.Endpoint.get

Performs a relative GET request on an endpoint's path, combined with the parameters and a relative path if specified.

Syntax

get: function(relpath, params, callback)

Parameters

Name Type Description
relpath String

A relative path to append to the endpoint path.

params Object

A dictionary of entity-specific parameters to add to the query string.

callback Function

A function to call when the request is complete: (err, response).

Examples

 // 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"))});

post

splunkjs.Service.Endpoint.post

Performs a relative POST request on an endpoint's path, combined with the parameters and a relative path if specified.

Syntax

post: function(relpath, params, callback)

Parameters

Name Type Description
relpath String

A relative path to append to the endpoint path.

params Object

A dictionary of entity-specific parameters to add to the body.

callback Function

A function to call when the request is complete: (err, response).

Examples

 // 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"))});

properties

splunkjs.Service.Resource.properties

Retrieves the current properties for this resource.

Syntax

properties: function()

Return

Object.

The properties.

published

splunkjs.Service.Entity.published

Retrieves the published time for this entity.

Syntax

published: function()

Return

String.

The published time.

reload

splunkjs.Service.Entity.reload

Reloads the entity on the server.

Syntax

reload: function(callback)

Parameters

Name Type Description
callback Function

A function to call when the object is reloaded: (err, entity).

remove

splunkjs.Service.Entity.remove

Deletes the entity from the server.

Syntax

remove: function(callback)

Parameters

Name Type Description
callback Function

A function to call when the object is deleted: (err).

state

splunkjs.Service.Resource.state

Retrieves the current full state (properties and metadata) of this resource.

Syntax

state: function()

Return

Object.

The current full state of this resource.

updated

splunkjs.Service.Entity.updated

Retrieves the updated time for this entity.

Syntax

updated: function()

Return

String.

The updated time.