Class ThresholdMetricInputV1

java.lang.Object
com.seeq.model.ThresholdMetricInputV1

public class ThresholdMetricInputV1 extends Object
ThresholdMetricInputV1
  • Constructor Details

    • ThresholdMetricInputV1

      public ThresholdMetricInputV1()
  • Method Details

    • additionalProperties

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

      public ThresholdMetricInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

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

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

      public ThresholdMetricInputV1 aggregationFunction(String aggregationFunction)
    • getAggregationFunction

      public String getAggregationFunction()
      Aggregation formula function that can aggregate the measured item and used when evaluating the thresholds as well as for display in outputs such as scorecard.
      Returns:
      aggregationFunction
    • setAggregationFunction

      public void setAggregationFunction(String aggregationFunction)
    • boundingCondition

      public ThresholdMetricInputV1 boundingCondition(String boundingCondition)
    • getBoundingCondition

      public String getBoundingCondition()
      Used when measuring a batch process, the ID of a condition that will be used to aggregate the measured item and to break scorecard output into multiple columns, one per capsule.
      Returns:
      boundingCondition
    • setBoundingCondition

      public void setBoundingCondition(String boundingCondition)
    • boundingConditionMaximumDuration

      public ThresholdMetricInputV1 boundingConditionMaximumDuration(String boundingConditionMaximumDuration)
    • getBoundingConditionMaximumDuration

      public String getBoundingConditionMaximumDuration()
      If bounding condition is used and does not have a Maximum Capsule Duration this value must be supplied to allow aggregation.
      Returns:
      boundingConditionMaximumDuration
    • setBoundingConditionMaximumDuration

      public void setBoundingConditionMaximumDuration(String boundingConditionMaximumDuration)
    • dataId

      public ThresholdMetricInputV1 dataId(String dataId)
    • getDataId

      public String getDataId()
      A unique identifier for the metric within its datasource.
      Returns:
      dataId
    • setDataId

      public void setDataId(String dataId)
    • datasourceClass

      public ThresholdMetricInputV1 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 ThresholdMetricInputV1 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)
    • duration

      public ThresholdMetricInputV1 duration(String duration)
    • getDuration

      public String getDuration()
      Used when measuring a continuous process, the duration over which to calculate a moving aggregation. Example: 1day
      Returns:
      duration
    • setDuration

      public void setDuration(String duration)
    • measuredItem

      public ThresholdMetricInputV1 measuredItem(String measuredItem)
    • getMeasuredItem

      public String getMeasuredItem()
      ID of an input Signal or Condition to measure. This item is measured using the thresholds to find deviations.
      Returns:
      measuredItem
    • setMeasuredItem

      public void setMeasuredItem(String measuredItem)
    • name

      public ThresholdMetricInputV1 name(String name)
    • getName

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

      public void setName(String name)
    • neutralColor

      public ThresholdMetricInputV1 neutralColor(String neutralColor)
    • getNeutralColor

      public String getNeutralColor()
      A hex code that specifies a color that will override the neutral (level 0) priority color
      Returns:
      neutralColor
    • setNeutralColor

      public void setNeutralColor(String neutralColor)
    • numberFormat

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

      public ThresholdMetricInputV1 period(String period)
    • getPeriod

      public String getPeriod()
      Used when measuring a continuous process, the period at which to sample when creating the moving aggregation. Example: 30min
      Returns:
      period
    • setPeriod

      public void setPeriod(String period)
    • scopedTo

      public ThresholdMetricInputV1 scopedTo(String scopedTo)
    • getScopedTo

      public String getScopedTo()
      The ID of the workbook to which this item will be scoped.
      Returns:
      scopedTo
    • setScopedTo

      public void setScopedTo(String scopedTo)
    • syncToken

      public ThresholdMetricInputV1 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 will be archived using the Datasources clean-up API.
      Returns:
      syncToken
    • setSyncToken

      public void setSyncToken(String syncToken)
    • thresholds

      public ThresholdMetricInputV1 thresholds(List<String> thresholds)
    • addThresholdsItem

      public ThresholdMetricInputV1 addThresholdsItem(String thresholdsItem)
    • getThresholds

      public List<String> getThresholds()
      Get thresholds
      Returns:
      thresholds
    • setThresholds

      public void setThresholds(List<String> thresholds)
    • 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