Class FormulaItemInputV1

java.lang.Object
com.seeq.model.FormulaItemInputV1

public class FormulaItemInputV1 extends Object
List of children associated with an asset for the asset group editor
  • Constructor Details

    • FormulaItemInputV1

      public FormulaItemInputV1()
  • Method Details

    • additionalProperties

      public FormulaItemInputV1 additionalProperties(List<ScalarPropertyV1> additionalProperties)
    • addAdditionalPropertiesItem

      public FormulaItemInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

      public List<ScalarPropertyV1> getAdditionalProperties()
      Additional properties to set on this item. A property consists of a name, a value, and a unit of measure.
      Returns:
      additionalProperties
    • setAdditionalProperties

      public void setAdditionalProperties(List<ScalarPropertyV1> additionalProperties)
    • dataId

      public FormulaItemInputV1 dataId(String dataId)
    • getDataId

      public String getDataId()
      The data ID of this item. Note: This is not the Seeq ID, but the unique identifier that the remote datasource uses.
      Returns:
      dataId
    • setDataId

      public void setDataId(String dataId)
    • datasourceClass

      public FormulaItemInputV1 datasourceClass(String datasourceClass)
    • getDatasourceClass

      public String getDatasourceClass()
      Along with the Datasource ID, the Datasource Class uniquely identifies a datasource. For example, a datasource may be a particular instance of an OSIsoft PI historian.
      Returns:
      datasourceClass
    • setDatasourceClass

      public void setDatasourceClass(String datasourceClass)
    • datasourceId

      public FormulaItemInputV1 datasourceId(String datasourceId)
    • getDatasourceId

      public String getDatasourceId()
      Along with the Datasource Class, the Datasource ID uniquely identifies a datasource. For example, a datasource may be a particular instance of an OSIsoft PI historian.
      Returns:
      datasourceId
    • setDatasourceId

      public void setDatasourceId(String datasourceId)
    • dependencies

      public FormulaItemInputV1 dependencies(List<FormulaDependencyInputV1> dependencies)
    • addDependenciesItem

      public FormulaItemInputV1 addDependenciesItem(FormulaDependencyInputV1 dependenciesItem)
    • getDependencies

      public List<FormulaDependencyInputV1> getDependencies()
      List of items the formula is dependent on
      Returns:
      dependencies
    • setDependencies

      public void setDependencies(List<FormulaDependencyInputV1> dependencies)
    • description

      public FormulaItemInputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item. An input of just whitespace is equivalent to a null input.
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • formula

      public FormulaItemInputV1 formula(String formula)
    • getFormula

      public String getFormula()
      The formula that represents the body of the function
      Returns:
      formula
    • setFormula

      public void setFormula(String formula)
    • hostId

      public FormulaItemInputV1 hostId(String hostId)
    • getHostId

      public String getHostId()
      The ID of the datasource hosting this item. Note that this is a Seeq-generated ID, not the way that the datasource identifies itself.
      Returns:
      hostId
    • setHostId

      public void setHostId(String hostId)
    • id

      public FormulaItemInputV1 id(String id)
    • getId

      public String getId()
      The Seeq id of the formula item
      Returns:
      id
    • setId

      public void setId(String id)
    • name

      public FormulaItemInputV1 name(String name)
    • getName

      public String getName()
      Human readable name. Null or whitespace names are not permitted.
      Returns:
      name
    • setName

      public void setName(String name)
    • packageName

      public FormulaItemInputV1 packageName(String packageName)
    • getPackageName

      public String getPackageName()
      The name of the package that contains this function. Valid only for UserDefinedFormulaFunctions.
      Returns:
      packageName
    • setPackageName

      public void setPackageName(String packageName)
    • parameters

      public FormulaItemInputV1 parameters(List<FormulaParameterInputV1> parameters)
    • addParametersItem

      public FormulaItemInputV1 addParametersItem(FormulaParameterInputV1 parametersItem)
    • getParameters

      public List<FormulaParameterInputV1> getParameters()
      Any parameters that should be placed in the context of the executing formula. At least one unbound parameter is required.
      Returns:
      parameters
    • setParameters

      public void setParameters(List<FormulaParameterInputV1> parameters)
    • scopedTo

      public FormulaItemInputV1 scopedTo(String scopedTo)
    • getScopedTo

      public String getScopedTo()
      The ID of the workbook to which this item will be scoped.
      Returns:
      scopedTo
    • setScopedTo

      public void setScopedTo(String scopedTo)
    • securityString

      public FormulaItemInputV1 securityString(String securityString)
    • getSecurityString

      public String getSecurityString()
      Security string containing all identities and their permissions for the item. If set, permissions can only be managed by the connector and not in Seeq.
      Returns:
      securityString
    • setSecurityString

      public void setSecurityString(String securityString)
    • sourceSecurityString

      public FormulaItemInputV1 sourceSecurityString(String sourceSecurityString)
    • getSourceSecurityString

      public String getSourceSecurityString()
      The security string as it was originally found on the source (for debugging ACLs only)
      Returns:
      sourceSecurityString
    • setSourceSecurityString

      public void setSourceSecurityString(String sourceSecurityString)
    • syncToken

      public FormulaItemInputV1 syncToken(String syncToken)
    • getSyncToken

      public String getSyncToken()
      An arbitrary token (often a date or random ID) that is used during metadata syncs. At the end of a full sync, items with mismatching sync tokens are identified as stale and may be archived using the Datasources clean-up API.
      Returns:
      syncToken
    • setSyncToken

      public void setSyncToken(String syncToken)
    • type

      public FormulaItemInputV1 type(String type)
    • getType

      public String getType()
      The item subtype for a Formula Function. Valid types include 'AggregatingFormulaFunction', 'UserDefinedFormulaFunction', and 'Chart'
      Returns:
      type
    • setType

      public void setType(String type)
    • 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