Package com.seeq.model
Class ThresholdMetricOutputV1
java.lang.Object
com.seeq.model.ThresholdMetricOutputV1
ThresholdMetricOutputV1
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The process type of threshold metric. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addThresholdsItem
(ThresholdOutputV1 thresholdsItem) aggregationConditionId
(String aggregationConditionId) aggregationFunction
(String aggregationFunction) boundingCondition
(ItemPreviewWithAssetsV1 boundingCondition) boundingConditionMaximumDuration
(ScalarValueOutputV1 boundingConditionMaximumDuration) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) description
(String description) displayItem
(ItemPreviewV1 displayItem) duration
(ScalarValueOutputV1 duration) effectivePermissions
(PermissionsV1 effectivePermissions) boolean
Additional properties of the itemThe ID of the aggregation condition representing metric value informationAggregation formula that aggregates the measured itemGet boundingConditionGet boundingConditionMaximumDurationThe data ID of this asset.The datasource class, which is the type of system holding the item, such as OSIsoft PIThe datasource identifier, which is how the datasource holding this item identifies itselfClarifying information or other plain language description of this itemGet displayItemGet durationGet effectivePermissionsgetId()
The ID that can be used to interact with the itemWhether item is archivedWhether item is redactedGet measuredItemgetName()
The human readable nameEither the custom-set neutral color for this metric or the color of the neutral PriorityThe format string used for numbers associated with this signal.Get periodThe process type of threshold metric.The ID of the workbook to which this item is scoped or null if it is in the global scope.A plain language status message with information about any issues that may have been encountered during an operationThe list of thresholds that are scalars, signals, or conditions along with the associated priority.The item's translation key, if anygetType()
The type of the itemThe unit of measure of the metricint
hashCode()
isArchived
(Boolean isArchived) isRedacted
(Boolean isRedacted) measuredItem
(ItemPreviewWithAssetsV1 measuredItem) neutralColor
(String neutralColor) numberFormat
(String numberFormat) period
(ScalarValueOutputV1 period) processType
(ThresholdMetricOutputV1.ProcessTypeEnum processType) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
setAggregationConditionId
(String aggregationConditionId) void
setAggregationFunction
(String aggregationFunction) void
setBoundingCondition
(ItemPreviewWithAssetsV1 boundingCondition) void
setBoundingConditionMaximumDuration
(ScalarValueOutputV1 boundingConditionMaximumDuration) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDescription
(String description) void
setDisplayItem
(ItemPreviewV1 displayItem) void
setDuration
(ScalarValueOutputV1 duration) void
setEffectivePermissions
(PermissionsV1 effectivePermissions) void
void
setIsArchived
(Boolean isArchived) void
setIsRedacted
(Boolean isRedacted) void
setMeasuredItem
(ItemPreviewWithAssetsV1 measuredItem) void
void
setNeutralColor
(String neutralColor) void
setNumberFormat
(String numberFormat) void
setPeriod
(ScalarValueOutputV1 period) void
setProcessType
(ThresholdMetricOutputV1.ProcessTypeEnum processType) void
setScopedTo
(String scopedTo) void
setStatusMessage
(String statusMessage) void
setThresholds
(List<ThresholdOutputV1> thresholds) void
setTranslationKey
(String translationKey) void
void
setValueUnitOfMeasure
(String valueUnitOfMeasure) statusMessage
(String statusMessage) thresholds
(List<ThresholdOutputV1> thresholds) toString()
translationKey
(String translationKey) valueUnitOfMeasure
(String valueUnitOfMeasure)
-
Constructor Details
-
ThresholdMetricOutputV1
public ThresholdMetricOutputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
public ThresholdMetricOutputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem) -
getAdditionalProperties
Additional properties of the item- Returns:
- additionalProperties
-
setAdditionalProperties
-
aggregationConditionId
-
getAggregationConditionId
The ID of the aggregation condition representing metric value information- Returns:
- aggregationConditionId
-
setAggregationConditionId
-
aggregationFunction
-
getAggregationFunction
Aggregation formula that aggregates the measured item- Returns:
- aggregationFunction
-
setAggregationFunction
-
boundingCondition
-
getBoundingCondition
Get boundingCondition- Returns:
- boundingCondition
-
setBoundingCondition
-
boundingConditionMaximumDuration
public ThresholdMetricOutputV1 boundingConditionMaximumDuration(ScalarValueOutputV1 boundingConditionMaximumDuration) -
getBoundingConditionMaximumDuration
Get boundingConditionMaximumDuration- Returns:
- boundingConditionMaximumDuration
-
setBoundingConditionMaximumDuration
public void setBoundingConditionMaximumDuration(ScalarValueOutputV1 boundingConditionMaximumDuration) -
dataId
-
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
-
datasourceClass
-
getDatasourceClass
The datasource class, which is the type of system holding the item, such as OSIsoft PI- Returns:
- datasourceClass
-
setDatasourceClass
-
datasourceId
-
getDatasourceId
The datasource identifier, which is how the datasource holding this item identifies itself- Returns:
- datasourceId
-
setDatasourceId
-
description
-
getDescription
Clarifying information or other plain language description of this item- Returns:
- description
-
setDescription
-
displayItem
-
getDisplayItem
Get displayItem- Returns:
- displayItem
-
setDisplayItem
-
duration
-
getDuration
Get duration- Returns:
- duration
-
setDuration
-
effectivePermissions
-
getEffectivePermissions
Get effectivePermissions- Returns:
- effectivePermissions
-
setEffectivePermissions
-
id
-
getId
The ID that can be used to interact with the item- Returns:
- id
-
setId
-
isArchived
-
getIsArchived
Whether item is archived- Returns:
- isArchived
-
setIsArchived
-
isRedacted
-
getIsRedacted
Whether item is redacted- Returns:
- isRedacted
-
setIsRedacted
-
measuredItem
-
getMeasuredItem
Get measuredItem- Returns:
- measuredItem
-
setMeasuredItem
-
name
-
getName
The human readable name- Returns:
- name
-
setName
-
neutralColor
-
getNeutralColor
Either the custom-set neutral color for this metric or the color of the neutral Priority- Returns:
- neutralColor
-
setNeutralColor
-
numberFormat
-
getNumberFormat
The format string used for numbers associated with this signal.- Returns:
- numberFormat
-
setNumberFormat
-
period
-
getPeriod
Get period- Returns:
- period
-
setPeriod
-
processType
-
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
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item is scoped or null if it is in the global scope.- Returns:
- scopedTo
-
setScopedTo
-
statusMessage
-
getStatusMessage
A plain language status message with information about any issues that may have been encountered during an operation- Returns:
- statusMessage
-
setStatusMessage
-
thresholds
-
addThresholdsItem
-
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
-
translationKey
-
getTranslationKey
The item's translation key, if any- Returns:
- translationKey
-
setTranslationKey
-
type
-
getType
The type of the item- Returns:
- type
-
setType
-
valueUnitOfMeasure
-
getValueUnitOfMeasure
The unit of measure of the metric- Returns:
- valueUnitOfMeasure
-
setValueUnitOfMeasure
-
equals
-
hashCode
public int hashCode() -
toString
-