Package com.seeq.model
Class FunctionInputV1
java.lang.Object
com.seeq.model.FunctionInputV1
The list of functions to be added or modified
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addParametersItem
(FormulaParameterInputV1 parametersItem) addPropertiesItem
(ScalarPropertyV1 propertiesItem) description
(String description) boolean
Get additionalPropertiesThe data ID of this item.Clarifying information or other plain language description of this item.The formula that represents the body of the functionThe ID of the datasource hosting this item.getName()
Human readable name.The name of the package that contains this function.Any parameters that should be placed in the context of the executing formula.Get propertiesThe ID of the workbook to which this item will be scoped.An arbitrary token (often a date or random ID) that is used during metadata syncs.getType()
The item subtype for this function.int
hashCode()
packageName
(String packageName) parameters
(List<FormulaParameterInputV1> parameters) properties
(List<ScalarPropertyV1> properties) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
void
setDescription
(String description) void
setFormula
(String formula) void
void
void
setPackageName
(String packageName) void
setParameters
(List<FormulaParameterInputV1> parameters) void
setProperties
(List<ScalarPropertyV1> properties) void
setScopedTo
(String scopedTo) void
setSyncToken
(String syncToken) void
toString()
-
Constructor Details
-
FunctionInputV1
public FunctionInputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
-
getAdditionalProperties
Get additionalProperties- Returns:
- additionalProperties
-
setAdditionalProperties
-
dataId
-
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
-
description
-
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
-
formula
-
getFormula
The formula that represents the body of the function- Returns:
- formula
-
setFormula
-
hostId
-
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
-
name
-
getName
Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.- Returns:
- name
-
setName
-
packageName
-
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
-
parameters
-
addParametersItem
-
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
-
properties
-
addPropertiesItem
-
getProperties
Get properties- Returns:
- properties
-
setProperties
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item will be scoped.- Returns:
- scopedTo
-
setScopedTo
-
syncToken
-
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
-
type
-
getType
The item subtype for this function. Valid types include AggregatingFormulaFunction, UserDefinedFormulaFunction, and Chart- Returns:
- type
-
setType
-
equals
-
hashCode
public int hashCode() -
toString
-