com.tencentcloudapi.wedata.v20250806.models

Class AlarmRuleData

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.wedata.v20250806.models.AlarmRuleData

public class AlarmRuleData
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
AlarmRuleData()
AlarmRuleData(AlarmRuleData source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
AlarmGroup[]	getAlarmGroups() Get Describes the Alarm recipient configuration list.
Long	getAlarmLevel() Get Alarm level.
AlarmRuleDetail	getAlarmRuleDetail() Get Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle.
String	getAlarmRuleId() Get Alarm Rule ID
String	getAlarmRuleName() Get Specifies the Alarm rule name.
String[]	getAlarmTypes() Get Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold
String	getBundleId() Get The Alarm rule bound to the bundle client.
String	getBundleInfo() Get bundleId is not empty.
String	getDescription() Get Describes the Alarm rule.
String[]	getMonitorObjectIds() Get Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs.
Long	getMonitorObjectType() Get Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm
String	getOwnerUin() Get Specifies the id of the Alarm rule creator.
Long	getStatus() Get Whether the Alarm rule is enabled.
void	setAlarmGroups(AlarmGroup[] AlarmGroups) Set Describes the Alarm recipient configuration list.
void	setAlarmLevel(Long AlarmLevel) Set Alarm level.
void	setAlarmRuleDetail(AlarmRuleDetail AlarmRuleDetail) Set Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle.
void	setAlarmRuleId(String AlarmRuleId) Set Alarm Rule ID
void	setAlarmRuleName(String AlarmRuleName) Set Specifies the Alarm rule name.
void	setAlarmTypes(String[] AlarmTypes) Set Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold
void	setBundleId(String BundleId) Set The Alarm rule bound to the bundle client.
void	setBundleInfo(String BundleInfo) Set bundleId is not empty.
void	setDescription(String Description) Set Describes the Alarm rule.
void	setMonitorObjectIds(String[] MonitorObjectIds) Set Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs.
void	setMonitorObjectType(Long MonitorObjectType) Set Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm
void	setOwnerUin(String OwnerUin) Set Specifies the id of the Alarm rule creator.
void	setStatus(Long Status) Set Whether the Alarm rule is enabled.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlarmRuleData

public AlarmRuleData()

AlarmRuleData

public AlarmRuleData(AlarmRuleData source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getAlarmRuleId

public String getAlarmRuleId()

Get Alarm Rule ID

Returns:

AlarmRuleId Alarm Rule ID

setAlarmRuleId

public void setAlarmRuleId(String AlarmRuleId)

Set Alarm Rule ID

Parameters:

AlarmRuleId - Alarm Rule ID

getAlarmRuleName

public String getAlarmRuleName()

Get Specifies the Alarm rule name.

Returns:

AlarmRuleName Specifies the Alarm rule name.

setAlarmRuleName

public void setAlarmRuleName(String AlarmRuleName)

Set Specifies the Alarm rule name.

Parameters:

AlarmRuleName - Specifies the Alarm rule name.

getDescription

public String getDescription()

Get Describes the Alarm rule.

Returns:

Description Describes the Alarm rule.

setDescription

public void setDescription(String Description)

Set Describes the Alarm rule.

Parameters:

Description - Describes the Alarm rule.

getMonitorObjectType

public Long getMonitorObjectType()

Get Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm

Returns:

MonitorObjectType Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm

setMonitorObjectType

public void setMonitorObjectType(Long MonitorObjectType)

Set Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm

Parameters:

MonitorObjectType - Monitoring Object Type Task-level Monitoring - Can be configured by Task / Workflow / Project: 1 = Task (default) 2 = Workflow 3 = Project Project-level Monitoring - Monitors overall task fluctuations within a project: 7 = Project fluctuation monitoring alarm

getMonitorObjectIds

public String[] getMonitorObjectIds()

Get Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs. 2 (Workflow): MonitorObjectIds should contain a list of workflow IDs (workflow IDs can be obtained using the ListWorkflows API). 3 (Project): MonitorObjectIds should contain a list of project IDs.

Returns:

MonitorObjectIds Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs. 2 (Workflow): MonitorObjectIds should contain a list of workflow IDs (workflow IDs can be obtained using the ListWorkflows API). 3 (Project): MonitorObjectIds should contain a list of project IDs.

setMonitorObjectIds

public void setMonitorObjectIds(String[] MonitorObjectIds)

Set Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs. 2 (Workflow): MonitorObjectIds should contain a list of workflow IDs (workflow IDs can be obtained using the ListWorkflows API). 3 (Project): MonitorObjectIds should contain a list of project IDs.

Parameters:

MonitorObjectIds - Pass different business IDs depending on the value of MonitorType: 1 (Task): MonitorObjectIds should contain a list of task IDs. 2 (Workflow): MonitorObjectIds should contain a list of workflow IDs (workflow IDs can be obtained using the ListWorkflows API). 3 (Project): MonitorObjectIds should contain a list of project IDs.

getAlarmTypes

public String[] getAlarmTypes()

Get Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold

Returns:

AlarmTypes Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold

setAlarmTypes

public void setAlarmTypes(String[] AlarmTypes)

Set Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold

Parameters:

AlarmTypes - Alarm Rule Monitoring Types: failure: Failure alarm overtime: Timeout alarm success: Success alarm backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds backTrackingOrRerunFailure: Alarm when backfill/rerun fails projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold reconciliationFailure: Alarm when an offline reconciliation task fails reconciliationOvertime: Alarm when an offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold

getStatus

public Long getStatus()

Get Whether the Alarm rule is enabled. Valid values: 0 (disabled), 1 (enabled).

Returns:

Status Whether the Alarm rule is enabled. Valid values: 0 (disabled), 1 (enabled).

setStatus

public void setStatus(Long Status)

Set Whether the Alarm rule is enabled. Valid values: 0 (disabled), 1 (enabled).

Parameters:

Status - Whether the Alarm rule is enabled. Valid values: 0 (disabled), 1 (enabled).

getAlarmRuleDetail

public AlarmRuleDetail getAlarmRuleDetail()

Get Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle.

Returns:

AlarmRuleDetail Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle.

setAlarmRuleDetail

public void setAlarmRuleDetail(AlarmRuleDetail AlarmRuleDetail)

Set Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle.

Parameters:

AlarmRuleDetail - Alarm Rule Configuration Information Success Alarms - No configuration required; Failure Alarms - Can be configured to trigger on the first failure or on all retry failures; Timeout Alarms - Require configuration of the timeout type and timeout threshold; Project Fluctuation Alarms - Require configuration of the fluctuation rate and the debounce cycle.

getAlarmLevel

public Long getAlarmLevel()

Get Alarm level. 1. ordinary, 2. important, 3. critical.

Returns:

AlarmLevel Alarm level. 1. ordinary, 2. important, 3. critical.

setAlarmLevel

public void setAlarmLevel(Long AlarmLevel)

Set Alarm level. 1. ordinary, 2. important, 3. critical.

Parameters:

AlarmLevel - Alarm level. 1. ordinary, 2. important, 3. critical.

getOwnerUin

public String getOwnerUin()

Get Specifies the id of the Alarm rule creator.

Returns:

OwnerUin Specifies the id of the Alarm rule creator.

setOwnerUin

public void setOwnerUin(String OwnerUin)

Set Specifies the id of the Alarm rule creator.

Parameters:

OwnerUin - Specifies the id of the Alarm rule creator.

getBundleId

public String getBundleId()

Get The Alarm rule bound to the bundle client. it is normal if empty, otherwise it corresponds to the rule bound to the bundle client.

Returns:

BundleId The Alarm rule bound to the bundle client. it is normal if empty, otherwise it corresponds to the rule bound to the bundle client.

setBundleId

public void setBundleId(String BundleId)

Set The Alarm rule bound to the bundle client. it is normal if empty, otherwise it corresponds to the rule bound to the bundle client.

Parameters:

BundleId - The Alarm rule bound to the bundle client. it is normal if empty, otherwise it corresponds to the rule bound to the bundle client.

getBundleInfo

public String getBundleInfo()

Get bundleId is not empty. it indicates the bound client name.

Returns:

BundleInfo bundleId is not empty. it indicates the bound client name.

setBundleInfo

public void setBundleInfo(String BundleInfo)

Set bundleId is not empty. it indicates the bound client name.

Parameters:

BundleInfo - bundleId is not empty. it indicates the bound client name.

getAlarmGroups

public AlarmGroup[] getAlarmGroups()

Get Describes the Alarm recipient configuration list.

Returns:

AlarmGroups Describes the Alarm recipient configuration list.

setAlarmGroups

public void setAlarmGroups(AlarmGroup[] AlarmGroups)

Set Describes the Alarm recipient configuration list.

Parameters:

AlarmGroups - Describes the Alarm recipient configuration list.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.