Package com.seeq.model
Class PutScalarInputV1
java.lang.Object
com.seeq.model.PutScalarInputV1
A list of scalars to create or update
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addParametersItem
(String parametersItem) addPropertiesItem
(ScalarPropertyV1 propertiesItem) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) description
(String description) boolean
Get additionalPropertiesThe 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.Clarifying information or other plain language description of this item.Information about the formula used to create a calculated item.The ID of the datasource hosting this item.getName()
Human readable name.The format string used for numbers associated with this signal.Get parametersPrevious Data ID for the item within its datasource; ignored if null.Get propertiesThe 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.The unit of measure for this Scalar.int
hashCode()
numberFormat
(String numberFormat) parameters
(List<String> parameters) previousDataId
(String previousDataId) properties
(List<ScalarPropertyV1> properties) securityString
(String securityString) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDescription
(String description) void
setFormula
(String formula) void
void
void
setNumberFormat
(String numberFormat) void
setParameters
(List<String> parameters) void
setPreviousDataId
(String previousDataId) void
setProperties
(List<ScalarPropertyV1> properties) void
setScopedTo
(String scopedTo) void
setSecurityString
(String securityString) void
setSourceSecurityString
(String sourceSecurityString) void
setSyncToken
(String syncToken) void
setUnitOfMeasure
(String unitOfMeasure) sourceSecurityString
(String sourceSecurityString) toString()
unitOfMeasure
(String unitOfMeasure)
-
Constructor Details
-
PutScalarInputV1
public PutScalarInputV1()
-
-
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
-
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
-
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
Information about the formula used to create a calculated item. Not marked as required because this class is extended by classes where it is optional- 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
-
numberFormat
-
getNumberFormat
The format string used for numbers associated with this signal. The format for the string follows ECMA-376 spreadsheet format standards.- Returns:
- numberFormat
-
setNumberFormat
-
parameters
-
addParametersItem
-
getParameters
Get parameters- Returns:
- parameters
-
setParameters
-
previousDataId
-
getPreviousDataId
Previous Data ID for the item within its datasource; ignored if null. It should only be used when the Data ID of an item in a datasource is being changed but should still map to the same item in Seeq - this could be because a datasource item has been moved or to improve logic related to the use of Data IDs- Returns:
- previousDataId
-
setPreviousDataId
-
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
-
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
-
unitOfMeasure
-
getUnitOfMeasure
The unit of measure for this Scalar. Added to its formula if parsable by Seeq- Returns:
- unitOfMeasure
-
setUnitOfMeasure
-
equals
-
hashCode
public int hashCode() -
toString
-