Data - Scoped, Global

A Data object contains the results of transform performed by a sn_clotho.Client.transform() method.

Do not use a constructor to create an instance of this class, instead use the object returned by the sn_clotho.Client.transform() method.

The Data class can be used in scoped and global server scripts. When using the Data class, use the sn_clotho namespace identifier.

This class is part of the MetricBase application.

Scoped Data - getEnd()

Returns the end time for data in the Data object.

Table 1. Parameters
Name Type Description
None
Table 2. Returns
Type Description
GlideDateTime The end of the time period.

Scoped Data - getLabel()

Returns the label assigned by the sn_clotho.ClothoTransform.label() method.

Table 3. Parameters
Name Type Description
None
Table 4. Returns
Type Description
String The label assigned to the data.

Scoped Data - getMetricName()

Returns the name of the metric of the data series. Returns null when the data object is associated with multiple data series.

Table 5. Parameters
Name Type Description
None
Table 6. Returns
Type Description
String Name of the metric field. Returns null when the data object is associated with multiple data series.

Scoped Data - getPeriod()

Returns the time period in milliseconds.

Table 7. Parameters
Name Type Description
None
Table 8. Returns
Type Description
Number The elapsed time in seconds.

Scoped Data - getStart()

Returns the start time for data in the Data object.

Table 9. Parameters
Name Type Description
None
Table 10. Returns
Type Description
GlideDateTime The time for the first data point.

Scoped Data - getSubject()

Returns the subject of the data series. Returns null when the data object is associated with multiple data series.

Table 11. Parameters
Name Type Description
None
Table 12. Returns
Type Description
String The subject field value of the subject GlideRecord. This is generally the sys_id of the subject GlideRecord.

Scoped Data - getTableName()

Returns the name of the table assigned in the DataSelector class constructor. Returns null when the data object is associated with multiple data series.

Table 13. Parameters
Name Type Description
None
Table 14. Returns
Type Description
String Table name. Returns null when the data object is associated with multiple data series.

Scoped Data - getValues()

Returns an array of values.

Table 15. Parameters
Name Type Description
None
Table 16. Returns
Type Description
Array An array of numbers.

Scoped Data - size()

Returns the number of values in the Data object.

Table 17. Parameters
Name Type Description
None
Table 18. Returns
Type Description
Number The number of values in the object.