Class ThresholdMetricOutputV1

java.lang.Object
com.seeq.model.ThresholdMetricOutputV1

public class ThresholdMetricOutputV1 extends Object
ThresholdMetricOutputV1
  • Constructor Details

    • ThresholdMetricOutputV1

      public ThresholdMetricOutputV1()
  • Method Details

    • additionalProperties

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

      public ThresholdMetricOutputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

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

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

      public ThresholdMetricOutputV1 aggregationConditionId(String aggregationConditionId)
    • getAggregationConditionId

      public String getAggregationConditionId()
      The ID of the aggregation condition representing metric value information
      Returns:
      aggregationConditionId
    • setAggregationConditionId

      public void setAggregationConditionId(String aggregationConditionId)
    • aggregationFunction

      public ThresholdMetricOutputV1 aggregationFunction(String aggregationFunction)
    • getAggregationFunction

      public String getAggregationFunction()
      Aggregation formula that aggregates the measured item
      Returns:
      aggregationFunction
    • setAggregationFunction

      public void setAggregationFunction(String aggregationFunction)
    • boundingCondition

      public ThresholdMetricOutputV1 boundingCondition(ItemPreviewWithAssetsV1 boundingCondition)
    • getBoundingCondition

      public ItemPreviewWithAssetsV1 getBoundingCondition()
      Get boundingCondition
      Returns:
      boundingCondition
    • setBoundingCondition

      public void setBoundingCondition(ItemPreviewWithAssetsV1 boundingCondition)
    • boundingConditionMaximumDuration

      public ThresholdMetricOutputV1 boundingConditionMaximumDuration(ScalarValueOutputV1 boundingConditionMaximumDuration)
    • getBoundingConditionMaximumDuration

      public ScalarValueOutputV1 getBoundingConditionMaximumDuration()
      Get boundingConditionMaximumDuration
      Returns:
      boundingConditionMaximumDuration
    • setBoundingConditionMaximumDuration

      public void setBoundingConditionMaximumDuration(ScalarValueOutputV1 boundingConditionMaximumDuration)
    • dataId

      public ThresholdMetricOutputV1 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 ThresholdMetricOutputV1 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 ThresholdMetricOutputV1 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 ThresholdMetricOutputV1 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)
    • displayItem

      public ThresholdMetricOutputV1 displayItem(ItemPreviewV1 displayItem)
    • getDisplayItem

      public ItemPreviewV1 getDisplayItem()
      Get displayItem
      Returns:
      displayItem
    • setDisplayItem

      public void setDisplayItem(ItemPreviewV1 displayItem)
    • duration

      public ThresholdMetricOutputV1 duration(ScalarValueOutputV1 duration)
    • getDuration

      public ScalarValueOutputV1 getDuration()
      Get duration
      Returns:
      duration
    • setDuration

      public void setDuration(ScalarValueOutputV1 duration)
    • effectivePermissions

      public ThresholdMetricOutputV1 effectivePermissions(PermissionsV1 effectivePermissions)
    • getEffectivePermissions

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

      public void setEffectivePermissions(PermissionsV1 effectivePermissions)
    • id

    • getId

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

      public void setId(String id)
    • isArchived

      public ThresholdMetricOutputV1 isArchived(Boolean isArchived)
    • getIsArchived

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

      public void setIsArchived(Boolean isArchived)
    • isRedacted

      public ThresholdMetricOutputV1 isRedacted(Boolean isRedacted)
    • getIsRedacted

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

      public void setIsRedacted(Boolean isRedacted)
    • measuredItem

      public ThresholdMetricOutputV1 measuredItem(ItemPreviewWithAssetsV1 measuredItem)
    • getMeasuredItem

      public ItemPreviewWithAssetsV1 getMeasuredItem()
      Get measuredItem
      Returns:
      measuredItem
    • setMeasuredItem

      public void setMeasuredItem(ItemPreviewWithAssetsV1 measuredItem)
    • name

      public ThresholdMetricOutputV1 name(String name)
    • getName

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

      public void setName(String name)
    • neutralColor

      public ThresholdMetricOutputV1 neutralColor(String neutralColor)
    • getNeutralColor

      public String getNeutralColor()
      Either the custom-set neutral color for this metric or the color of the neutral Priority
      Returns:
      neutralColor
    • setNeutralColor

      public void setNeutralColor(String neutralColor)
    • numberFormat

      public ThresholdMetricOutputV1 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)
    • period

    • getPeriod

      public ScalarValueOutputV1 getPeriod()
      Get period
      Returns:
      period
    • setPeriod

      public void setPeriod(ScalarValueOutputV1 period)
    • processType

    • getProcessType

      public ThresholdMetricOutputV1.ProcessTypeEnum getProcessType()
      The process type of threshold metric. Will be Continuous if duration and period are specified, Condition if boundingCondition is specified, and otherwise Simple.
      Returns:
      processType
    • setProcessType

      public void setProcessType(ThresholdMetricOutputV1.ProcessTypeEnum processType)
    • scopedTo

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

      public ThresholdMetricOutputV1 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)
    • thresholds

      public ThresholdMetricOutputV1 thresholds(List<ThresholdOutputV1> thresholds)
    • addThresholdsItem

      public ThresholdMetricOutputV1 addThresholdsItem(ThresholdOutputV1 thresholdsItem)
    • getThresholds

      public List<ThresholdOutputV1> getThresholds()
      The list of thresholds that are scalars, signals, or conditions along with the associated priority. These thresholds are those that were used as inputs and which are used to generate the condition thresholds
      Returns:
      thresholds
    • setThresholds

      public void setThresholds(List<ThresholdOutputV1> thresholds)
    • translationKey

      public ThresholdMetricOutputV1 translationKey(String translationKey)
    • getTranslationKey

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

      public void setTranslationKey(String translationKey)
    • type

      public ThresholdMetricOutputV1 type(String type)
    • getType

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

      public void setType(String type)
    • valueUnitOfMeasure

      public ThresholdMetricOutputV1 valueUnitOfMeasure(String valueUnitOfMeasure)
    • getValueUnitOfMeasure

      public String getValueUnitOfMeasure()
      The unit of measure of the metric
      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