Package com.seeq.model
Class FormulaRunInputV1
java.lang.Object
com.seeq.model.FormulaRunInputV1
FormulaRunInputV1
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The format to output time fields as. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddFragmentsItem
(String fragmentsItem) addParametersItem
(String parametersItem) boolean
getEnd()
A string representing the ending index of the data to be returned.The formula to be appliedGet fragmentsThe ID of a function item for calling formulas with unbound valuesgetLimit()
The pagination limit, the total number of collection items that will be returned in this page of results.The pagination offset, the index of the first collection item that will be returned in this page of results.Get parametersUsed when running a formula across assets, this is a formula that can further reduce the results of each asset result.getRoot()
Used to run a formula across assets, this is the ID of the root asset whose immediate children will be iterated.getStart()
A string representing the starting index of the data to be returned.The format to output time fields as.int
hashCode()
parameters
(List<String> parameters) reduceFormula
(String reduceFormula) void
void
setFormula
(String formula) void
setFragments
(List<String> fragments) void
setFunction
(String function) void
void
void
setParameters
(List<String> parameters) void
setReduceFormula
(String reduceFormula) void
void
void
setTimeFormat
(FormulaRunInputV1.TimeFormatEnum timeFormat) timeFormat
(FormulaRunInputV1.TimeFormatEnum timeFormat) toString()
-
Constructor Details
-
FormulaRunInputV1
public FormulaRunInputV1()
-
-
Method Details
-
end
-
getEnd
A string representing the ending index of the data to be returned. The contents and whether or not it is required depends on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) keys: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\"- Returns:
- end
-
setEnd
-
formula
-
getFormula
The formula to be applied- Returns:
- formula
-
setFormula
-
fragments
-
addFragmentsItem
-
getFragments
Get fragments- Returns:
- fragments
-
setFragments
-
function
-
getFunction
The ID of a function item for calling formulas with unbound values- Returns:
- function
-
setFunction
-
limit
-
getLimit
The pagination limit, the total number of collection items that will be returned in this page of results. Defaults to 1000- Returns:
- limit
-
setLimit
-
offset
-
getOffset
The pagination offset, the index of the first collection item that will be returned in this page of results. Defaults to 0- Returns:
- offset
-
setOffset
-
parameters
-
addParametersItem
-
getParameters
Get parameters- Returns:
- parameters
-
setParameters
-
reduceFormula
-
getReduceFormula
Used when running a formula across assets, this is a formula that can further reduce the results of each asset result. The variable $result must be used to reference the data. Example of sorting the aggregated results: $result.sort('temperature')'- Returns:
- reduceFormula
-
setReduceFormula
-
root
-
getRoot
Used to run a formula across assets, this is the ID of the root asset whose immediate children will be iterated. The formula must produce a table.- Returns:
- root
-
setRoot
-
start
-
getStart
A string representing the starting index of the data to be returned. The contents and whether or not it is required depends on the series type. For time series: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) keys: a double-precision number, optionally including units. For example: \"2.5ft\" or \"10 °C\"- Returns:
- start
-
setStart
-
timeFormat
-
getTimeFormat
The format to output time fields as. One of ISO8601, Nanoseconds, or Legacy, which outputs whatever the default was before this field was added. Defaults to \"Legacy\".- Returns:
- timeFormat
-
setTimeFormat
-
equals
-
hashCode
public int hashCode() -
toString
-