Class FunctionInputV1

java.lang.Object
com.seeq.model.FunctionInputV1

public class FunctionInputV1 extends Object
The list of functions to be added or modified
  • Constructor Details

    • FunctionInputV1

      public FunctionInputV1()
  • Method Details

    • additionalProperties

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

      public FunctionInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

      public List<ScalarPropertyV1> getAdditionalProperties()
      Get additionalProperties
      Returns:
      additionalProperties
    • setAdditionalProperties

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

      public FunctionInputV1 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)
    • description

      public FunctionInputV1 description(String description)
    • getDescription

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

      public void setDescription(String description)
    • formula

      public FunctionInputV1 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 FunctionInputV1 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)
    • name

      public FunctionInputV1 name(String name)
    • getName

      public String getName()
      Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.
      Returns:
      name
    • setName

      public void setName(String name)
    • packageName

      public FunctionInputV1 packageName(String packageName)
    • getPackageName

      public String getPackageName()
      The name of the package that contains this function. Valid only for UserDefinedFormulaFunctions when creating the function, cannot be changed for existing UDFs.
      Returns:
      packageName
    • setPackageName

      public void setPackageName(String packageName)
    • parameters

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

      public FunctionInputV1 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 for AggregatingFormulaFunctions and Charts.
      Returns:
      parameters
    • setParameters

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

      public FunctionInputV1 properties(List<ScalarPropertyV1> properties)
    • addPropertiesItem

      public FunctionInputV1 addPropertiesItem(ScalarPropertyV1 propertiesItem)
    • getProperties

      public List<ScalarPropertyV1> getProperties()
      Get properties
      Returns:
      properties
    • setProperties

      public void setProperties(List<ScalarPropertyV1> properties)
    • scopedTo

      public FunctionInputV1 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)
    • syncToken

      public FunctionInputV1 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 FunctionInputV1 type(String type)
    • getType

      public String getType()
      The item subtype for this 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