Package com.seeq.model
Class SignalOutputV1
java.lang.Object
com.seeq.model.SignalOutputV1
SignalOutputV1
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The location this signal is stored in, if it is stored in Seeq -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addParametersItem
(FormulaParameterOutputV1 parametersItem) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) description
(String description) effectivePermissions
(PermissionsV1 effectivePermissions) boolean
Additional properties of the itemThe data ID of this asset.The datasource class, which is the type of system holding the item, such as OSIsoft PIThe datasource identifier, which is how the datasource holding this item identifies itselfClarifying information or other plain language description of this itemGet effectivePermissionsThe formula for the calculated itemgetId()
The ID that can be used to interact with the itemThe interpolation method used to represent the values between samples in the signal.Whether item is archivedWhether item is redactedThe unit of measure for the signal's keysThe maximum spacing between adjacent sample keys that can be interpolated across.getName()
The human readable nameThe format string used for numbers associated with this signal.The name of the package that contains this function.Parameters that are used in the context of executing the formulaTrue if permissions are managed by the datasource, false if they are managed in SeeqThe ID of the workbook to which this item is scoped or null if it is in the global scope.Security string in Seeq format provided by datasourceThe security string as it was originally found on the source (for debugging ACLs only)A plain language status message with information about any issues that may have been encountered during an operationThe location this signal is stored in, if it is stored in SeeqAn arbitrary token (often a date or random ID) that is used during metadata syncs.The item's translation key, if anygetType()
The type of the itemThe unit of measure for the signal's valuesint
hashCode()
interpolationMethod
(String interpolationMethod) isArchived
(Boolean isArchived) isRedacted
(Boolean isRedacted) keyUnitOfMeasure
(String keyUnitOfMeasure) maximumInterpolation
(String maximumInterpolation) numberFormat
(String numberFormat) packageName
(String packageName) parameters
(List<FormulaParameterOutputV1> parameters) permissionsFromDatasource
(Boolean permissionsFromDatasource) securityString
(String securityString) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDescription
(String description) void
setEffectivePermissions
(PermissionsV1 effectivePermissions) void
setFormula
(String formula) void
void
setInterpolationMethod
(String interpolationMethod) void
setIsArchived
(Boolean isArchived) void
setIsRedacted
(Boolean isRedacted) void
setKeyUnitOfMeasure
(String keyUnitOfMeasure) void
setMaximumInterpolation
(String maximumInterpolation) void
void
setNumberFormat
(String numberFormat) void
setPackageName
(String packageName) void
setParameters
(List<FormulaParameterOutputV1> parameters) void
setPermissionsFromDatasource
(Boolean permissionsFromDatasource) void
setScopedTo
(String scopedTo) void
setSecurityString
(String securityString) void
setSourceSecurityString
(String sourceSecurityString) void
setStatusMessage
(String statusMessage) void
setStorageLocation
(SignalOutputV1.StorageLocationEnum storageLocation) void
setSyncToken
(String syncToken) void
setTranslationKey
(String translationKey) void
void
setValueUnitOfMeasure
(String valueUnitOfMeasure) sourceSecurityString
(String sourceSecurityString) statusMessage
(String statusMessage) storageLocation
(SignalOutputV1.StorageLocationEnum storageLocation) toString()
translationKey
(String translationKey) valueUnitOfMeasure
(String valueUnitOfMeasure)
-
Constructor Details
-
SignalOutputV1
public SignalOutputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
-
getAdditionalProperties
Additional properties of the item- Returns:
- additionalProperties
-
setAdditionalProperties
-
dataId
-
getDataId
The data ID of this asset. Note: This is not the Seeq ID, but the unique identifier that the remote datasource uses.- Returns:
- dataId
-
setDataId
-
datasourceClass
-
getDatasourceClass
The datasource class, which is the type of system holding the item, such as OSIsoft PI- Returns:
- datasourceClass
-
setDatasourceClass
-
datasourceId
-
getDatasourceId
The datasource identifier, which is how the datasource holding this item identifies itself- Returns:
- datasourceId
-
setDatasourceId
-
description
-
getDescription
Clarifying information or other plain language description of this item- Returns:
- description
-
setDescription
-
effectivePermissions
-
getEffectivePermissions
Get effectivePermissions- Returns:
- effectivePermissions
-
setEffectivePermissions
-
formula
-
getFormula
The formula for the calculated item- Returns:
- formula
-
setFormula
-
id
-
getId
The ID that can be used to interact with the item- Returns:
- id
-
setId
-
interpolationMethod
-
getInterpolationMethod
The interpolation method used to represent the values between samples in the signal. The possibilities are: Linear, PILinear, and Step.- Returns:
- interpolationMethod
-
setInterpolationMethod
-
isArchived
-
getIsArchived
Whether item is archived- Returns:
- isArchived
-
setIsArchived
-
isRedacted
-
getIsRedacted
Whether item is redacted- Returns:
- isRedacted
-
setIsRedacted
-
keyUnitOfMeasure
-
getKeyUnitOfMeasure
The unit of measure for the signal's keys- 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 human readable name- Returns:
- name
-
setName
-
numberFormat
-
getNumberFormat
The format string used for numbers associated with this signal.- Returns:
- numberFormat
-
setNumberFormat
-
packageName
-
getPackageName
The name of the package that contains this function.- Returns:
- packageName
-
setPackageName
-
parameters
-
addParametersItem
-
getParameters
Parameters that are used in the context of executing the formula- Returns:
- parameters
-
setParameters
-
permissionsFromDatasource
-
getPermissionsFromDatasource
True if permissions are managed by the datasource, false if they are managed in Seeq- Returns:
- permissionsFromDatasource
-
setPermissionsFromDatasource
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item is scoped or null if it is in the global scope.- Returns:
- scopedTo
-
setScopedTo
-
securityString
-
getSecurityString
Security string in Seeq format provided by datasource- Returns:
- securityString
-
setSecurityString
-
sourceSecurityString
-
getSourceSecurityString
The security string as it was originally found on the source (for debugging ACLs only)- Returns:
- sourceSecurityString
-
setSourceSecurityString
-
statusMessage
-
getStatusMessage
A plain language status message with information about any issues that may have been encountered during an operation- Returns:
- statusMessage
-
setStatusMessage
-
storageLocation
-
getStorageLocation
The location this signal is stored in, if it is stored in Seeq- Returns:
- storageLocation
-
setStorageLocation
-
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
-
translationKey
-
getTranslationKey
The item's translation key, if any- Returns:
- translationKey
-
setTranslationKey
-
type
-
getType
The type of the item- Returns:
- type
-
setType
-
valueUnitOfMeasure
-
getValueUnitOfMeasure
The unit of measure for the signal's values- Returns:
- valueUnitOfMeasure
-
setValueUnitOfMeasure
-
equals
-
hashCode
public int hashCode() -
toString
-