Package com.seeq.model
Class ThresholdMetricInputV1
java.lang.Object
com.seeq.model.ThresholdMetricInputV1
ThresholdMetricInputV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addThresholdsItem
(String thresholdsItem) aggregationFunction
(String aggregationFunction) boundingCondition
(String boundingCondition) boundingConditionMaximumDuration
(String boundingConditionMaximumDuration) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) boolean
Additional properties to set on this threshold metric.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.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.If bounding condition is used and does not have a Maximum Capsule Duration this value must be supplied to allow aggregation.A unique identifier for the metric within its datasource.Along with the Datasource ID, the Datasource Class uniquely identifies a datasource.Along with the Datasource Class, the Datasource ID uniquely identifies a datasource.Used when measuring a continuous process, the duration over which to calculate a moving aggregation.ID of an input Signal or Condition to measure.getName()
The name of the metric.A hex code that specifies a color that will override the neutral (level 0) priority colorThe format string used for numbers associated with this signal.Used when measuring a continuous process, the period at which to sample when creating the moving aggregation.The ID of the workbook to which this item will be scoped.An arbitrary token (often a date or random ID) that is used during metadata syncs.Get thresholdsint
hashCode()
measuredItem
(String measuredItem) neutralColor
(String neutralColor) numberFormat
(String numberFormat) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
setAggregationFunction
(String aggregationFunction) void
setBoundingCondition
(String boundingCondition) void
setBoundingConditionMaximumDuration
(String boundingConditionMaximumDuration) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDuration
(String duration) void
setMeasuredItem
(String measuredItem) void
void
setNeutralColor
(String neutralColor) void
setNumberFormat
(String numberFormat) void
void
setScopedTo
(String scopedTo) void
setSyncToken
(String syncToken) void
setThresholds
(List<String> thresholds) thresholds
(List<String> thresholds) toString()
-
Constructor Details
-
ThresholdMetricInputV1
public ThresholdMetricInputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
public ThresholdMetricInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem) -
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
-
aggregationFunction
-
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
-
boundingCondition
-
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
-
boundingConditionMaximumDuration
public ThresholdMetricInputV1 boundingConditionMaximumDuration(String boundingConditionMaximumDuration) -
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
-
dataId
-
getDataId
A unique identifier for the metric within its datasource.- Returns:
- dataId
-
setDataId
-
datasourceClass
-
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
-
datasourceId
-
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
-
duration
-
getDuration
Used when measuring a continuous process, the duration over which to calculate a moving aggregation. Example: 1day- Returns:
- duration
-
setDuration
-
measuredItem
-
getMeasuredItem
ID of an input Signal or Condition to measure. This item is measured using the thresholds to find deviations.- Returns:
- measuredItem
-
setMeasuredItem
-
name
-
getName
The name of the metric.- Returns:
- name
-
setName
-
neutralColor
-
getNeutralColor
A hex code that specifies a color that will override the neutral (level 0) priority color- Returns:
- neutralColor
-
setNeutralColor
-
numberFormat
-
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
-
period
-
getPeriod
Used when measuring a continuous process, the period at which to sample when creating the moving aggregation. Example: 30min- Returns:
- period
-
setPeriod
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item will be scoped.- Returns:
- scopedTo
-
setScopedTo
-
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 will be archived using the Datasources clean-up API.- Returns:
- syncToken
-
setSyncToken
-
thresholds
-
addThresholdsItem
-
getThresholds
Get thresholds- Returns:
- thresholds
-
setThresholds
-
equals
-
hashCode
public int hashCode() -
toString
-