CustomMonitoringSignal interface
- Extends
Properties
component |
[Required] Reference to the component asset used to calculate the custom metrics. |
input |
Monitoring assets to take as input. Key is the component input port name, value is the data asset. |
inputs | Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value. |
metric |
[Required] A list of metrics to calculate and their associated thresholds. |
signal |
Polymorphic discriminator, which specifies the different types this object can be |
Inherited Properties
notification |
The current notification mode for this signal. |
properties | Property dictionary. Properties can be added, but not removed or altered. |
Property Details
componentId
[Required] Reference to the component asset used to calculate the custom metrics.
componentId: string
Property Value
string
inputAssets
Monitoring assets to take as input. Key is the component input port name, value is the data asset.
inputAssets?: {[propertyName: string]: MonitoringInputDataBaseUnion | null}
Property Value
{[propertyName: string]: MonitoringInputDataBaseUnion | null}
inputs
Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.
inputs?: {[propertyName: string]: JobInputUnion | null}
Property Value
{[propertyName: string]: JobInputUnion | null}
metricThresholds
[Required] A list of metrics to calculate and their associated thresholds.
metricThresholds: CustomMetricThreshold[]
Property Value
signalType
Polymorphic discriminator, which specifies the different types this object can be
signalType: "Custom"
Property Value
"Custom"
Inherited Property Details
notificationTypes
The current notification mode for this signal.
notificationTypes?: string[]
Property Value
string[]
Inherited From MonitoringSignalBase.notificationTypes
properties
Property dictionary. Properties can be added, but not removed or altered.
properties?: {[propertyName: string]: string | null}
Property Value
{[propertyName: string]: string | null}
Inherited From MonitoringSignalBase.properties