Package com.seeq.model
Class FormulaItemInputV1
java.lang.Object
com.seeq.model.FormulaItemInputV1
List of children associated with an asset for the asset group editor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) addDependenciesItem
(FormulaDependencyInputV1 dependenciesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addParametersItem
(FormulaParameterInputV1 parametersItem) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) dependencies
(List<FormulaDependencyInputV1> dependencies) description
(String description) boolean
Additional properties to set on this item.The data ID of this item.Along with the Datasource ID, the Datasource Class uniquely identifies a datasource.Along with the Datasource Class, the Datasource ID uniquely identifies a datasource.List of items the formula is dependent onClarifying 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.getId()
The Seeq id of the formula itemgetName()
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.The ID of the workbook to which this item will be scoped.Security string containing all identities and their permissions for the item.The security string as it was originally found on the source (for debugging ACLs only)An arbitrary token (often a date or random ID) that is used during metadata syncs.getType()
The item subtype for a Formula Function.int
hashCode()
packageName
(String packageName) parameters
(List<FormulaParameterInputV1> parameters) securityString
(String securityString) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDependencies
(List<FormulaDependencyInputV1> dependencies) void
setDescription
(String description) void
setFormula
(String formula) void
void
void
void
setPackageName
(String packageName) void
setParameters
(List<FormulaParameterInputV1> parameters) void
setScopedTo
(String scopedTo) void
setSecurityString
(String securityString) void
setSourceSecurityString
(String sourceSecurityString) void
setSyncToken
(String syncToken) void
sourceSecurityString
(String sourceSecurityString) toString()
-
Constructor Details
-
FormulaItemInputV1
public FormulaItemInputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
-
getAdditionalProperties
Additional properties to set on this item. A property consists of a name, a value, and a unit of measure.- 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
-
datasourceClass
-
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
-
datasourceId
-
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
-
dependencies
-
addDependenciesItem
-
getDependencies
List of items the formula is dependent on- Returns:
- dependencies
-
setDependencies
-
description
-
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
-
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
-
id
-
getId
The Seeq id of the formula item- Returns:
- id
-
setId
-
name
-
getName
Human readable name. Null or whitespace names are not permitted.- Returns:
- name
-
setName
-
packageName
-
getPackageName
The name of the package that contains this function. Valid only for UserDefinedFormulaFunctions.- 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.- Returns:
- parameters
-
setParameters
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item will be scoped.- Returns:
- scopedTo
-
setScopedTo
-
securityString
-
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
-
sourceSecurityString
-
getSourceSecurityString
The security string as it was originally found on the source (for debugging ACLs only)- Returns:
- sourceSecurityString
-
setSourceSecurityString
-
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 a Formula Function. Valid types include 'AggregatingFormulaFunction', 'UserDefinedFormulaFunction', and 'Chart'- Returns:
- type
-
setType
-
equals
-
hashCode
public int hashCode() -
toString
-