Creates a configuration file.
Creates a configuration file.
| Name | Type | Description |
|---|---|---|
| filename | String | A name for this configuration file. |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
let configurations = service.configurations();
let newFile = await configurations.create("myprops");
console.log("CREATED");
create: function(filename, response_timeout) {
if (utils.isObject(filename)) {
filename = filename["__conf"];
}
var that = this;
let req = this.post("", {__conf: filename}, response_timeout).then((response) => {
let entity = new root.ConfigurationFile(that.service, filename);
return entity.fetch({}, response_timeout);
});
return req;
},Creates/Updates a configuration file and stanza.
| Name | Type | Description |
|---|---|---|
| filename | String | A name for this configuration file to be created/updated. |
| stanzaName | String | A name for the stanza to be created/updated. |
| keyValueMap | String | A key-value map of properties to be put under the stanza. |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
createAsync: async function (filename, stanzaName, keyValueMap, response_timeout) {
let that = this;
// 1. Check if the file exists
let configFile = await this.getConfFile(filename);
// 2. If the file doesn't exist, create a new file
if(configFile == undefined) {
await that.create( { __conf: filename }, response_timeout);
configFile = new root.ConfigurationFile( that.service, filename );
configFile = await configFile.fetchAsync(response_timeout);
}
// 3. Check if the stanza exists
let configStanza = await this.getStanza(configFile, stanzaName);
// 4. If the stanza doesn't exist, create a new stanza with given keyValueMap
if(configStanza == undefined) {
return await configFile.create(stanzaName, keyValueMap, response_timeout);
}
// 5. If the stanza exists, update it with the keyValueMap
else {
return configStanza.update(keyValueMap, response_timeout);
}
},
});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: true,Fetch a configuration file.
| Name | Type | Description |
|---|---|---|
| file | String | A name for configuration file. |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
if exists or null
getConfFile: async function(filename, response_timeout) {
var that = this;
// 1. Fetch files list
let response = await this.get("", {__conf: filename}, response_timeout, true);
// 2. Filter the files
let files = response
&& response.body
&& response.body.entry
&& response.body.entry.filter(f => f.name === filename);
// 3. Check if the file exists
if(files && files.length == 0) {
return null;
}
// 4. Create a local instance
let configurationFile = new root.ConfigurationFile(that.service, filename);
// 5. Load the file content
let fetchedFile = await configurationFile.fetchAsync(response_timeout);
return fetchedFile;
},Fetch a configuration stanza.
| Name | Type | Description |
|---|---|---|
| file | String | A configuration file. |
| stanza | String | A configuration stanza. |
if exists or null
getStanza: async function(file, stanza) {
// 1. check if the stanza exists
let fetchedStanza = file.item(stanza);
if(fetchedStanza == undefined) {
return null;
}
else {
return fetchedStanza;
}
},Constructor for splunkjs.Service.Configurations.
| Name | Type | Description |
|---|---|---|
| service | splunkjs.Service | A |
| namespace | Object | Namespace information: |
A new splunkjs.Service.Configurations instance.
init: function(service, namespace) {
if (!namespace || namespace.owner === "-" || namespace.app === "-") {
throw new Error("Configurations requires a non-wildcard owner/app");
}
this._super(service, this.path(), namespace);
},Creates a local instance of a configuration file.
| Name | Type | Description |
|---|---|---|
| props | Object | The properties for this configuration file. |
A new splunkjs.Service.ConfigurationFile instance.
instantiateEntity: function(props) {
return new root.ConfigurationFile(this.service, props.name, this.namespace);
},Retrieves the REST endpoint path for this resource (with no namespace).
path: function() {
return Paths.properties;
},Create the URL for the get and post methods This is to allow v1 fallback if the service was instantiated with v2+ and a relpath v1 was provided
| Name | Type | Description |
|---|---|---|
| qualifiedPath | String | A fully-qualified relative endpoint path (for example, "/services/search/jobs"). |
| relpath | String | A relative path to append to the endpoint path. |
// Parameters
v2 example:
qualifiedPath = "/servicesNS/admin/foo/search/v2/jobs/id5_1649796951725"
qualifiedPath = "/services/search/v2/jobs/id5_1649796951725"
relpath = "search/v2/jobs/id5_1649796951725/events"
relpath = "events"
// Step 1:
Specifically for splunkjs.Service.Job method, the service endpoint may be provided
Retrieve the service prefix and suffix
servicesNS:
- servicePrefix = "/servicesNS/admin/foo"
- serviceSuffix = "foo/v2/jobs/id5_1649796951725"
services:
- servicePrefix = "/services"
- serviceSuffix = "search/v2/jobs/id5_1649796951725"
// Step 2:
Retrieve Service API version
If version can't be detected, default to 1 (v1)
qualifiedPathVersion = 2
// Step 3:
Retrieve relpath version
If version can't be detected, default to 1 (v1)
relpath = "search/v2/jobs/id5_1649796951725/events"
=> relPathVersion = 2
Check if relpath is a one segment relative path, if so, set to -1
relpath = "events"
=> relPathVersion = -1
// Step 4:
Create the URL based on set criteria
url = "/servicesNS/admin/foo/search/v2/jobs/id5_1649796951725/events"
url = "/services/search/v2/jobs/id5_1649796951725/events"
createUrl: function (qualifiedPath, relpath) {
var url = qualifiedPath,
servicePrefix = qualifiedPath.replace(/(\/services|\/servicesNS\/[^/]+\/[^/]+)\/(.*)/, "$1"),
serviceSuffix = qualifiedPath.replace(/(\/services|\/servicesNS\/[^/]+\/[^/]+)\/(.*)/, "$2"),
qualifiedPathVersionMatch = qualifiedPath.match(/\/(?:servicesNS\/[^/]+\/[^/]+|services)\/[^/]+\/v(\d+)\//),
qualifiedPathVersionMatch = qualifiedPathVersionMatch ? qualifiedPathVersionMatch.length : 0,
qualifiedPathVersion = qualifiedPathVersionMatch || 1,
relPathVersionMatch = relpath.match(/^[^/]+\/v(\d+)\//),
relPathVersionMatch = relPathVersionMatch ? relPathVersionMatch.length : 0,
relPathVersion = relPathVersionMatch || 1;
if (relpath.indexOf('/') == -1) {
relPathVersion = -1;
}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 endpoint path. |
| params | Object | A dictionary of entity-specific parameters to add to the query string. |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
// Will make a request to {service.prefix}/search/jobs/123456
let endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
let res = await endpoint.delete("", {});
console.log("DELETED");
del: function(relpath, params, response_timeout) {
let 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,
response_timeout
);
}
});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: |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
fetch: function(options, response_timeout) {
if (utils.isNumber(options) && !response_timeout) {
response_timeout = options;
options = {};
}
options = options || {};
if (!options.count) {
options.count = 0;
}
var that = this;
let req = that.get("", options, response_timeout);
return req.then((res) => {
that._load(res.data);
return that;
}).catch((err) => {
throw err;
});
},It's an asynchronous version of fetch(options, response_timeout) function.
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: |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
fetchAsync: async function(options, response_timeout) {
if (utils.isNumber(options) && !response_timeout) {
response_timeout = options;
options = {};
}
options = options || {};
if (!options.count) {
options.count = 0;
}
var that = this;
let response = await that.get("", options, response_timeout, true);
that._load(response.body);
return that;
},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 endpoint path. |
| params | Object | A dictionary of entity-specific parameters to add to the query string. |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
// Will make a request to {service.prefix}/search/jobs/123456/results?offset=1
let endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
let res = await endpoint.get("results", {offset: 1});
console.log("DONE");
get: function(relpath, params, response_timeout, isAsync) {
let url = this.createUrl(this.qualifiedPath, relpath);
return this.service.get(
url,
params,
response_timeout,
isAsync
);
},Returns a specific entity from the collection.
| Name | Type | Description |
|---|---|---|
| id | String | The name of the entity to retrieve. |
| namespace | Object | Namespace information: |
let apps = service.apps();
let res = await apps.fetch();
let app = res.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.");
}
if (namespace && (namespace.app === '-' || namespace.owner === '-')) {
throw new Error("When searching for an entity, wildcards are not allowed in the namespace. Please refine your search.");
}
let fullPath = null;
if (this._entitiesByName.hasOwnProperty(id)) {
let 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(let i = 0; i < entities.length; i++) {
let 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.
let apps = service.apps();
let res = await apps.fetch();
let appList = res.list();
console.log(appList.length);
list: 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 endpoint path. |
| params | Object | A dictionary of entity-specific parameters to add to the body. |
| response_timeout | Number | A timeout period for aborting a request in milisecs (0 means no timeout). |
// Will make a request to {service.prefix}/search/jobs/123456/control
let endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
let res = await endpoint.post("control", {action: "cancel"});
console.log("CANCELLED");
post: function(relpath, params, response_timeout) {
let url = this.createUrl(this.qualifiedPath, relpath);
return this.service.post(
url,
params,
response_timeout
);
},Retrieves the current properties for this resource.
The properties.
properties: function() {
return this._properties;
},Retrieves the current full state (properties and metadata) 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;
},