Class FormulaRunInputV1

java.lang.Object
com.seeq.model.FormulaRunInputV1

public class FormulaRunInputV1 extends Object
FormulaRunInputV1
  • Constructor Details

    • FormulaRunInputV1

      public FormulaRunInputV1()
  • Method Details

    • end

      public FormulaRunInputV1 end(String end)
    • getEnd

      public String 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

      public void setEnd(String end)
    • formula

      public FormulaRunInputV1 formula(String formula)
    • getFormula

      public String getFormula()
      The formula to be applied
      Returns:
      formula
    • setFormula

      public void setFormula(String formula)
    • fragments

      public FormulaRunInputV1 fragments(List<String> fragments)
    • addFragmentsItem

      public FormulaRunInputV1 addFragmentsItem(String fragmentsItem)
    • getFragments

      public List<String> getFragments()
      Get fragments
      Returns:
      fragments
    • setFragments

      public void setFragments(List<String> fragments)
    • function

      public FormulaRunInputV1 function(String function)
    • getFunction

      public String getFunction()
      The ID of a function item for calling formulas with unbound values
      Returns:
      function
    • setFunction

      public void setFunction(String function)
    • limit

      public FormulaRunInputV1 limit(Integer limit)
    • getLimit

      public Integer 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

      public void setLimit(Integer limit)
    • offset

      public FormulaRunInputV1 offset(Integer offset)
    • getOffset

      public Integer 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

      public void setOffset(Integer offset)
    • parameters

      public FormulaRunInputV1 parameters(List<String> parameters)
    • addParametersItem

      public FormulaRunInputV1 addParametersItem(String parametersItem)
    • getParameters

      public List<String> getParameters()
      Get parameters
      Returns:
      parameters
    • setParameters

      public void setParameters(List<String> parameters)
    • reduceFormula

      public FormulaRunInputV1 reduceFormula(String reduceFormula)
    • getReduceFormula

      public String 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

      public void setReduceFormula(String reduceFormula)
    • root

      public FormulaRunInputV1 root(String root)
    • getRoot

      public String 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

      public void setRoot(String root)
    • start

      public FormulaRunInputV1 start(String start)
    • getStart

      public String 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

      public void setStart(String start)
    • timeFormat

      public FormulaRunInputV1 timeFormat(FormulaRunInputV1.TimeFormatEnum timeFormat)
    • getTimeFormat

      public FormulaRunInputV1.TimeFormatEnum 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

      public void setTimeFormat(FormulaRunInputV1.TimeFormatEnum timeFormat)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object