Package com.seeq.model
Class SignalWithIdInputV1
java.lang.Object
com.seeq.model.SignalWithIdInputV1
The signals to create or update
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) addFormulaParametersItem
(String formulaParametersItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) description
(String description) boolean
formulaParameters
(List<String> formulaParameters) Additional properties to set on this signal.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.A description of the signal.For a calculated signal, the Seeq Formula defining the signal.Get formulaParametersThis property tells Seeq that certain, and thus potentially cached, samples in the past have been changed.The interpolation method used to represent the values between samples in the signal.The unit of measure for the signal's keys.The maximum spacing between adjacent sample keys that can be interpolated across.getName()
The name of the signal.The format string used for numbers associated with this signal.Previous Data ID for the item within its datasource; ignored if null.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.The unit of measure for the signal's values.int
hashCode()
historicalDataVersion
(String historicalDataVersion) interpolationMethod
(String interpolationMethod) keyUnitOfMeasure
(String keyUnitOfMeasure) maximumInterpolation
(String maximumInterpolation) numberFormat
(String numberFormat) previousDataId
(String previousDataId) 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
setFormulaParameters
(List<String> formulaParameters) void
setHistoricalDataVersion
(String historicalDataVersion) void
setInterpolationMethod
(String interpolationMethod) void
setKeyUnitOfMeasure
(String keyUnitOfMeasure) void
setMaximumInterpolation
(String maximumInterpolation) void
void
setNumberFormat
(String numberFormat) void
setPreviousDataId
(String previousDataId) void
setScopedTo
(String scopedTo) void
setSecurityString
(String securityString) void
setSourceSecurityString
(String sourceSecurityString) void
setSyncToken
(String syncToken) void
setValueUnitOfMeasure
(String valueUnitOfMeasure) sourceSecurityString
(String sourceSecurityString) toString()
valueUnitOfMeasure
(String valueUnitOfMeasure)
-
Constructor Details
-
SignalWithIdInputV1
public SignalWithIdInputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
-
getAdditionalProperties
Additional properties to set on this signal. 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
-
description
-
getDescription
A description of the signal.- Returns:
- description
-
setDescription
-
formula
-
getFormula
For a calculated signal, the Seeq Formula defining the signal.- Returns:
- formula
-
setFormula
-
formulaParameters
-
addFormulaParametersItem
-
getFormulaParameters
Get formulaParameters- Returns:
- formulaParameters
-
setFormulaParameters
-
historicalDataVersion
-
getHistoricalDataVersion
This property tells Seeq that certain, and thus potentially cached, samples in the past have been changed. Changing the value of this property will will clear the cache of this signal and all formulas that depend on it. It should not be changed when new uncached samples are coming in.- Returns:
- historicalDataVersion
-
setHistoricalDataVersion
-
interpolationMethod
-
getInterpolationMethod
The interpolation method used to represent the values between samples in the signal. The possibilities are: Linear, PILinear, and Step. If not specified, Linear will be used.- Returns:
- interpolationMethod
-
setInterpolationMethod
-
keyUnitOfMeasure
-
getKeyUnitOfMeasure
The unit of measure for the signal's keys. The default is a time-keyed signal, with key units of 'ns'.- Returns:
- keyUnitOfMeasure
-
setKeyUnitOfMeasure
-
maximumInterpolation
-
getMaximumInterpolation
The maximum spacing between adjacent sample keys that can be interpolated across. If two samples are spaced by more than maximum interpolation, there will be a hole in the signal between them.- Returns:
- maximumInterpolation
-
setMaximumInterpolation
-
name
-
getName
The name of the signal.- 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
-
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
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item will be scoped. If not provided, the signal will have global scope.- 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
-
valueUnitOfMeasure
-
getValueUnitOfMeasure
The unit of measure for the signal's values. The default is unitless.- Returns:
- valueUnitOfMeasure
-
setValueUnitOfMeasure
-
equals
-
hashCode
public int hashCode() -
toString
-