init

splunkjs.Service.DataModelField.init

Constructor for a data model field. 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: - fieldName (string): The name of this field. - displayName (string): A human readable name for this field. - type (string): The type of this field, see valid types in class docs. - multivalue (boolean): Whether this field is multivalued. - required (boolean): Whether this field is required on events in the object - hidden (boolean): Whether this field should be displayed in a data model UI. - editable (boolean): Whether this field can be edited. - comment (string): A comment for this field, or null if there isn't one. - fieldSearch (string): A search query fragment for this field. - lineage (string): The lineage of the data model object on which this field is defined, items are delimited by a dot. This is converted into an array of strings upon construction.

Source (lib/service.js:4086)

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

    this.name           = props.fieldName;
    this.displayName    = props.displayName;
    this.type           = props.type;
    this.multivalued    = props.multivalue;
    this.required       = props.required;
    this.hidden         = props.hidden;
    this.editable       = props.editable;
    this.comment        = props.comment || null;
    this.fieldSearch    = props.fieldSearch;
    this.lineage        = props.owner.split(".");
    this.owner          = this.lineage[this.lineage.length - 1];
},

isBoolean

splunkjs.Service.DataModelField.isBoolean

Is this data model field of type boolean?

Syntax

isBoolean: function()

Return

Boolean.

True if this data model field is of type boolean.

Source (lib/service.js:4176)

isBoolean: function() {
        return "boolean" === this.type;
    }
});

isChildcount

splunkjs.Service.DataModelField.isChildcount

Is this data model field of type child count?

Syntax

isChildcount: function()

Return

Boolean.

True if this data model field is of type child count.

Source (lib/service.js:4154)

isChildcount: function() {
    return "childCount" === this.type;
},

isIPv4

splunkjs.Service.DataModelField.isIPv4

Is this data model field of type ipv4?

Syntax

isIPv4: function()

Return

Boolean.

True if this data model field is of type ipv4.

Source (lib/service.js:4165)

isIPv4: function() {
    return "ipv4" === this.type;
},

isNumber

splunkjs.Service.DataModelField.isNumber

Is this data model field of type number?

Syntax

isNumber: function()

Return

Boolean.

True if this data model field is of type number.

Source (lib/service.js:4121)

isNumber: function() {
    return "number" === this.type;
},

isObjectcount

splunkjs.Service.DataModelField.isObjectcount

Is this data model field of type object count?

Syntax

isObjectcount: function()

Return

Boolean.

True if this data model field is of type object count.

Source (lib/service.js:4143)

isObjectcount: function() {
    return "objectCount" === this.type;
},

isString

splunkjs.Service.DataModelField.isString

Is this data model field of type string?

Syntax

isString: function()

Return

Boolean.

True if this data model field is of type string.

Source (lib/service.js:4110)

isString: function() {
    return "string" === this.type;
},

isTimestamp

splunkjs.Service.DataModelField.isTimestamp

Is this data model field of type timestamp?

Syntax

isTimestamp: function()

Return

Boolean.

True if this data model field is of type timestamp.

Source (lib/service.js:4132)

isTimestamp: function() {
    return "timestamp" === this.type;
},