Class SignalOutputV1

java.lang.Object
com.seeq.model.SignalOutputV1

public class SignalOutputV1 extends Object
SignalOutputV1
  • Constructor Details

    • SignalOutputV1

      public SignalOutputV1()
  • Method Details

    • additionalProperties

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

      public SignalOutputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

      public List<ScalarPropertyV1> getAdditionalProperties()
      Additional properties of the item
      Returns:
      additionalProperties
    • setAdditionalProperties

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

      public SignalOutputV1 dataId(String dataId)
    • getDataId

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

      public void setDataId(String dataId)
    • datasourceClass

      public SignalOutputV1 datasourceClass(String datasourceClass)
    • getDatasourceClass

      public String getDatasourceClass()
      The datasource class, which is the type of system holding the item, such as OSIsoft PI
      Returns:
      datasourceClass
    • setDatasourceClass

      public void setDatasourceClass(String datasourceClass)
    • datasourceId

      public SignalOutputV1 datasourceId(String datasourceId)
    • getDatasourceId

      public String getDatasourceId()
      The datasource identifier, which is how the datasource holding this item identifies itself
      Returns:
      datasourceId
    • setDatasourceId

      public void setDatasourceId(String datasourceId)
    • description

      public SignalOutputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • effectivePermissions

      public SignalOutputV1 effectivePermissions(PermissionsV1 effectivePermissions)
    • getEffectivePermissions

      public PermissionsV1 getEffectivePermissions()
      Get effectivePermissions
      Returns:
      effectivePermissions
    • setEffectivePermissions

      public void setEffectivePermissions(PermissionsV1 effectivePermissions)
    • formula

      public SignalOutputV1 formula(String formula)
    • getFormula

      public String getFormula()
      The formula for the calculated item
      Returns:
      formula
    • setFormula

      public void setFormula(String formula)
    • id

      public SignalOutputV1 id(String id)
    • getId

      public String getId()
      The ID that can be used to interact with the item
      Returns:
      id
    • setId

      public void setId(String id)
    • interpolationMethod

      public SignalOutputV1 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.
      Returns:
      interpolationMethod
    • setInterpolationMethod

      public void setInterpolationMethod(String interpolationMethod)
    • isArchived

      public SignalOutputV1 isArchived(Boolean isArchived)
    • getIsArchived

      public Boolean getIsArchived()
      Whether item is archived
      Returns:
      isArchived
    • setIsArchived

      public void setIsArchived(Boolean isArchived)
    • isRedacted

      public SignalOutputV1 isRedacted(Boolean isRedacted)
    • getIsRedacted

      public Boolean getIsRedacted()
      Whether item is redacted
      Returns:
      isRedacted
    • setIsRedacted

      public void setIsRedacted(Boolean isRedacted)
    • keyUnitOfMeasure

      public SignalOutputV1 keyUnitOfMeasure(String keyUnitOfMeasure)
    • getKeyUnitOfMeasure

      public String getKeyUnitOfMeasure()
      The unit of measure for the signal's keys
      Returns:
      keyUnitOfMeasure
    • setKeyUnitOfMeasure

      public void setKeyUnitOfMeasure(String keyUnitOfMeasure)
    • maximumInterpolation

      public SignalOutputV1 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 SignalOutputV1 name(String name)
    • getName

      public String getName()
      The human readable name
      Returns:
      name
    • setName

      public void setName(String name)
    • numberFormat

      public SignalOutputV1 numberFormat(String numberFormat)
    • getNumberFormat

      public String getNumberFormat()
      The format string used for numbers associated with this signal.
      Returns:
      numberFormat
    • setNumberFormat

      public void setNumberFormat(String numberFormat)
    • packageName

      public SignalOutputV1 packageName(String packageName)
    • getPackageName

      public String getPackageName()
      The name of the package that contains this function.
      Returns:
      packageName
    • setPackageName

      public void setPackageName(String packageName)
    • parameters

      public SignalOutputV1 parameters(List<FormulaParameterOutputV1> parameters)
    • addParametersItem

      public SignalOutputV1 addParametersItem(FormulaParameterOutputV1 parametersItem)
    • getParameters

      public List<FormulaParameterOutputV1> getParameters()
      Parameters that are used in the context of executing the formula
      Returns:
      parameters
    • setParameters

      public void setParameters(List<FormulaParameterOutputV1> parameters)
    • permissionsFromDatasource

      public SignalOutputV1 permissionsFromDatasource(Boolean permissionsFromDatasource)
    • getPermissionsFromDatasource

      public Boolean getPermissionsFromDatasource()
      True if permissions are managed by the datasource, false if they are managed in Seeq
      Returns:
      permissionsFromDatasource
    • setPermissionsFromDatasource

      public void setPermissionsFromDatasource(Boolean permissionsFromDatasource)
    • scopedTo

      public SignalOutputV1 scopedTo(String scopedTo)
    • getScopedTo

      public String getScopedTo()
      The ID of the workbook to which this item is scoped or null if it is in the global scope.
      Returns:
      scopedTo
    • setScopedTo

      public void setScopedTo(String scopedTo)
    • securityString

      public SignalOutputV1 securityString(String securityString)
    • getSecurityString

      public String getSecurityString()
      Security string in Seeq format provided by datasource
      Returns:
      securityString
    • setSecurityString

      public void setSecurityString(String securityString)
    • sourceSecurityString

      public SignalOutputV1 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)
    • statusMessage

      public SignalOutputV1 statusMessage(String statusMessage)
    • getStatusMessage

      public String getStatusMessage()
      A plain language status message with information about any issues that may have been encountered during an operation
      Returns:
      statusMessage
    • setStatusMessage

      public void setStatusMessage(String statusMessage)
    • storageLocation

      public SignalOutputV1 storageLocation(SignalOutputV1.StorageLocationEnum storageLocation)
    • getStorageLocation

      public SignalOutputV1.StorageLocationEnum getStorageLocation()
      The location this signal is stored in, if it is stored in Seeq
      Returns:
      storageLocation
    • setStorageLocation

      public void setStorageLocation(SignalOutputV1.StorageLocationEnum storageLocation)
    • syncToken

      public SignalOutputV1 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)
    • translationKey

      public SignalOutputV1 translationKey(String translationKey)
    • getTranslationKey

      public String getTranslationKey()
      The item's translation key, if any
      Returns:
      translationKey
    • setTranslationKey

      public void setTranslationKey(String translationKey)
    • type

      public SignalOutputV1 type(String type)
    • getType

      public String getType()
      The type of the item
      Returns:
      type
    • setType

      public void setType(String type)
    • valueUnitOfMeasure

      public SignalOutputV1 valueUnitOfMeasure(String valueUnitOfMeasure)
    • getValueUnitOfMeasure

      public String getValueUnitOfMeasure()
      The unit of measure for the signal's values
      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