Splunk® Enterprise

Module System Reference

Acrobat logo Download manual as PDF


Splunk Enterprise version 7.3 will no longer be supported as of June 4, 2021. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Acrobat logo Download topic as PDF

Splunk.Context

Important notice: As part of Advanced XML deprecation, the Module System is officially deprecated beginning with Splunk Enterprise 6.3. For more information, see Advanced XML Deprecation.

clone()

The clone() method gets an exact copy of a module context.

Synopsis

contextCopy = someContext.clone()

Return Value

Object Duplicate of the current context object.

Example

dupCurrentContext: function() {
   var context = this.getContext()
   return = context.clone();

}

enforceByValue()

The enforceByValue() method ensures that the get() and getAll() methods return objects by value instead of by reference.

Note: This method usually does not need to be called because the getter and setter methods already enforce return by-value.

Synopsis

eValue = enforceByValue( value )

Parameters

value Object Value to be checked for references.

Return Value

Object Enforced value.

See Also

get()
getAll()
set()

get()

The get() method is a generic getter that gets the value associated with the named key, provided the key is defined for the context. A context is a user-defined dictionary of name-value pairs.

Synopsis

value = get( name )

Parameters

name String Context dictionary key.

Return Value

Object Value corresponding to the name key. If name does not exist, the method returns null.

Note that this method returns a value and not a reference.

Example

getSearch: function() {

   var context = this.getContext()
   return context.get('search');

}

See Also

enforceByValue()
getAll()
set()

getAll()

The getAll() method is a generic getter that gets all values at or below the name namespace.

For example, given charting.chart.stackMode and charting.chart keys, calling getAll("charting") returns a map of hash values for the chart.stackMode and chart keys.

Synopsis

hash = getAll( name )

Parameters

name String key name for which the corresponding values are returned.

Return Value

Object List of corresponding values at or below the name key. If name had no matching values, null is returned.

Note that this method returns values and not a references to the values.

Example

getResultsDict: function() {
   var context = this.getContext()
   return context.getAll("results");

}

See Also

enforceByValue()
get()
set()

has()

The has() method checks if the context contains the name key.

Synopsis

status = has( name )

Parameters

name String Key name to test.

Return Value

Boolean Requested name key found indication:
true = Key with specified name exists.
false = Key with specified name does not exist.

Example

hasSearch: function() {
   var context = this.getContext();
   if (context.has("search")) { 
       return true;
   else
       return false; 
   }

}

set()

The set() method is a generic setter that stores the specified name - value pair, by value, in the context.

The method never assigns a reference value but copies the referenced object.

Synopsis

set( name, value)

Parameters

name String Key name to associate with value.
value Object Value to be set for key name.

Note that this method overwrites the current value if name already exists.

Example

setBaseSearch: function(baseSearch) {

   var context = this.getContext();
   var search = context.get('search');
   search.setBaseSearch(baseSearch);
   context.set('search', search);

}

See Also

enforceByValue()
get()
getAll()

Last modified on 12 August, 2019
PREVIOUS
Extension dictionary
  NEXT
Splunk.Job

This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.4.11, 6.5.0, 6.5.1, 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.5.10, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 6.6.12, 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters