init

splunkjs.Service.DataModelCalculation.init

Constructor for a data model calculation. SDK users are not expected to invoke this constructor directly.

Syntax

init: function(props)

Parameters

Name	Type	Description
props	Object	A dictionary of properties to set: - calculationID (string): The ID of this calculation. - calculationType (string): The type of this calculation, see class docs for valid types. - editable (boolean): Whether this calculation can be edited. - comment (string): A comment for this calculation, or null if there isn't one. - owner (string): The lineage of the data model object on which this calculation is defined, items are delimited by a dot. This is converted into an array of strings upon construction. - outputFields (array): An array of the fields this calculation generates. - expression (string): The expression to use for this calculation; exclusive to Eval and Rex calculations (optional) - inputField (string): The field to use for calculation; exclusive to GeoIP and Rex calculations (optional) - lookupName (string): The name of the lookup to perform; exclusive to Lookup calculations (optional) - inputFieldMappings (array): One element array containing an object with the mappings from fields in the events to fields in the lookup; exclusive to Lookup calculations (optional)

Source (lib/service.js:4272)

init: function(props) {
    props = props || {};
    props.owner = props.owner || "";

    this.id             = props.calculationID;
    this.type           = props.calculationType;
    this.comment        = props.comment || null;
    this.editable       = props.editable;
    this.lineage        = props.owner.split(".");
    this.owner          = this.lineage[this.lineage.length - 1];

    this.outputFields = [];
    for (var i = 0; i < props.outputFields.length; i++) {
        this.outputFields[props.outputFields[i].fieldName] = new root.DataModelField(props.outputFields[i]);
    }

    if ("Eval" === this.type || "Rex" === this.type) {
        this.expression = props.expression;
    }
    if ("GeoIP" === this.type || "Rex" === this.type) {
        this.inputField = props.inputField;
    }
    if ("Lookup" === this.type) {
        this.lookupName = props.lookupName;
        this.inputFieldMappings = props.lookupInputs[0];
    }
},

isEditable

splunkjs.Service.DataModelCalculation.isEditable

Is this data model calculation editable?

Syntax

isEditable: function()

Return

Boolean.

True if this data model calculation is editable.

Source (lib/service.js:4318)

isEditable: function() {
    return !!this.editable;
},

isEval

splunkjs.Service.DataModelCalculation.isEval

Is this data model calculation of type eval?

Syntax

isEval: function()

Return

Boolean.

True if this data model calculation is of type eval.

Source (lib/service.js:4340)

isEval: function() {
    return "Eval" === this.type;
},

isGeoIP

splunkjs.Service.DataModelCalculation.isGeoIP

Is this data model calculation of type GeoIP?

Syntax

isGeoIP: function()

Return

Boolean.

True if this data model calculation is of type GeoIP.

Source (lib/service.js:4362)

isGeoIP: function() {
        return "GeoIP" === this.type;
    }
});

isLookup

splunkjs.Service.DataModelCalculation.isLookup

Is this data model calculation of type lookup?

Syntax

isLookup: function()

Return

Boolean.

True if this data model calculation is of type lookup.

Source (lib/service.js:4329)

isLookup: function() {
    return "Lookup" === this.type;
},

isRex

splunkjs.Service.DataModelCalculation.isRex

Is this data model calculation of type Rex?

Syntax

isRex: function()

Return

Boolean.

True if this data model calculation is of type Rex.

Source (lib/service.js:4351)

isRex: function() {
    return "Rex" === this.type;
},

outputFieldNames

splunkjs.Service.DataModelCalculation.outputFieldNames

Returns an array of strings of output field names.

Syntax

outputFieldNames: function()

Return

Array.

An array of strings of output field names.

Source (lib/service.js:4307)

outputFieldNames: function() {
    return Object.keys(this.outputFields);
},