Class SignalWithIdInputV1

java.lang.Object
com.seeq.model.SignalWithIdInputV1

public class SignalWithIdInputV1 extends Object
The signals to create or update
  • Constructor Details

    • SignalWithIdInputV1

      public SignalWithIdInputV1()
  • Method Details

    • additionalProperties

      public SignalWithIdInputV1 additionalProperties(List<ScalarPropertyV1> additionalProperties)
    • addAdditionalPropertiesItem

      public SignalWithIdInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

      public List<ScalarPropertyV1> getAdditionalProperties()
      Additional properties to set on this signal. A property consists of a name, a value, and a unit of measure.
      Returns:
      additionalProperties
    • setAdditionalProperties

      public void setAdditionalProperties(List<ScalarPropertyV1> additionalProperties)
    • dataId

      public SignalWithIdInputV1 dataId(String dataId)
    • getDataId

      public String 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

      public void setDataId(String dataId)
    • datasourceClass

      public SignalWithIdInputV1 datasourceClass(String datasourceClass)
    • getDatasourceClass

      public String 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

      public void setDatasourceClass(String datasourceClass)
    • datasourceId

      public SignalWithIdInputV1 datasourceId(String datasourceId)
    • getDatasourceId

      public String 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

      public void setDatasourceId(String datasourceId)
    • description

      public SignalWithIdInputV1 description(String description)
    • getDescription

      public String getDescription()
      A description of the signal.
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • formula

      public SignalWithIdInputV1 formula(String formula)
    • getFormula

      public String getFormula()
      For a calculated signal, the Seeq Formula defining the signal.
      Returns:
      formula
    • setFormula

      public void setFormula(String formula)
    • formulaParameters

      public SignalWithIdInputV1 formulaParameters(List<String> formulaParameters)
    • addFormulaParametersItem

      public SignalWithIdInputV1 addFormulaParametersItem(String formulaParametersItem)
    • getFormulaParameters

      public List<String> getFormulaParameters()
      Get formulaParameters
      Returns:
      formulaParameters
    • setFormulaParameters

      public void setFormulaParameters(List<String> formulaParameters)
    • historicalDataVersion

      public SignalWithIdInputV1 historicalDataVersion(String historicalDataVersion)
    • getHistoricalDataVersion

      public String 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

      public void setHistoricalDataVersion(String historicalDataVersion)
    • interpolationMethod

      public SignalWithIdInputV1 interpolationMethod(String interpolationMethod)
    • getInterpolationMethod

      public String 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

      public void setInterpolationMethod(String interpolationMethod)
    • keyUnitOfMeasure

      public SignalWithIdInputV1 keyUnitOfMeasure(String keyUnitOfMeasure)
    • getKeyUnitOfMeasure

      public String 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

      public void setKeyUnitOfMeasure(String keyUnitOfMeasure)
    • maximumInterpolation

      public SignalWithIdInputV1 maximumInterpolation(String maximumInterpolation)
    • getMaximumInterpolation

      public String 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

      public void setMaximumInterpolation(String maximumInterpolation)
    • name

      public SignalWithIdInputV1 name(String name)
    • getName

      public String getName()
      The name of the signal.
      Returns:
      name
    • setName

      public void setName(String name)
    • numberFormat

      public SignalWithIdInputV1 numberFormat(String numberFormat)
    • getNumberFormat

      public String 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

      public void setNumberFormat(String numberFormat)
    • previousDataId

      public SignalWithIdInputV1 previousDataId(String previousDataId)
    • getPreviousDataId

      public String 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

      public void setPreviousDataId(String previousDataId)
    • scopedTo

      public SignalWithIdInputV1 scopedTo(String scopedTo)
    • getScopedTo

      public String 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

      public void setScopedTo(String scopedTo)
    • securityString

      public SignalWithIdInputV1 securityString(String securityString)
    • getSecurityString

      public String 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

      public void setSecurityString(String securityString)
    • sourceSecurityString

      public SignalWithIdInputV1 sourceSecurityString(String sourceSecurityString)
    • getSourceSecurityString

      public String getSourceSecurityString()
      The security string as it was originally found on the source (for debugging ACLs only)
      Returns:
      sourceSecurityString
    • setSourceSecurityString

      public void setSourceSecurityString(String sourceSecurityString)
    • syncToken

      public SignalWithIdInputV1 syncToken(String syncToken)
    • getSyncToken

      public String 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

      public void setSyncToken(String syncToken)
    • valueUnitOfMeasure

      public SignalWithIdInputV1 valueUnitOfMeasure(String valueUnitOfMeasure)
    • getValueUnitOfMeasure

      public String getValueUnitOfMeasure()
      The unit of measure for the signal's values. The default is unitless.
      Returns:
      valueUnitOfMeasure
    • setValueUnitOfMeasure

      public void setValueUnitOfMeasure(String valueUnitOfMeasure)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object