com.tencentcloudapi.wedata.v20250806.models

Class UpdateOpsAlarmRuleRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.wedata.v20250806.models.UpdateOpsAlarmRuleRequest

public class UpdateOpsAlarmRuleRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
UpdateOpsAlarmRuleRequest()
UpdateOpsAlarmRuleRequest(UpdateOpsAlarmRuleRequest 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 message.
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 Specifies the unique id of the Alarm rule, obtained through the GetAlarmRule/ListAlarmRule api.
String	getAlarmRuleName() Get Specifies the new rule name of the Alarm rule.
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 projectFailureInstanceUpwardVolatilityAlarm: Alarm when the upward fluctuation count 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 projectSuccessInstanceDownwardVolatilityAlarm: Alarm when the downward fluctuation count of successful instances for the day exceeds the threshold projectFailureInstanceCountAlarm: Alarm when the number of failed instances for the day exceeds the threshold projectFailureInstanceProportionAlarm: Alarm when the proportion of failed instances for the day exceeds the threshold reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold
String	getDescription() Get Alarm description.
String[]	getMonitorObjectIds() Get Pass different business IDs based on the MonitorType setting: 1 (Task): MonitorObjectIds should be 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	getProjectId() Get Project ID.
Long	getStatus() Get Enable status of the Alarm rule.
void	setAlarmGroups(AlarmGroup[] AlarmGroups) Set Describes the Alarm recipient configuration message.
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 Specifies the unique id of the Alarm rule, obtained through the GetAlarmRule/ListAlarmRule api.
void	setAlarmRuleName(String AlarmRuleName) Set Specifies the new rule name of the Alarm rule.
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 projectFailureInstanceUpwardVolatilityAlarm: Alarm when the upward fluctuation count 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 projectSuccessInstanceDownwardVolatilityAlarm: Alarm when the downward fluctuation count of successful instances for the day exceeds the threshold projectFailureInstanceCountAlarm: Alarm when the number of failed instances for the day exceeds the threshold projectFailureInstanceProportionAlarm: Alarm when the proportion of failed instances for the day exceeds the threshold reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold
void	setDescription(String Description) Set Alarm description.
void	setMonitorObjectIds(String[] MonitorObjectIds) Set Pass different business IDs based on the MonitorType setting: 1 (Task): MonitorObjectIds should be 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	setProjectId(String ProjectId) Set Project ID.
void	setStatus(Long Status) Set Enable status of the Alarm rule.
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

UpdateOpsAlarmRuleRequest

public UpdateOpsAlarmRuleRequest()

UpdateOpsAlarmRuleRequest

public UpdateOpsAlarmRuleRequest(UpdateOpsAlarmRuleRequest 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

getProjectId

public String getProjectId()

Get Project ID.

Returns:

ProjectId Project ID.

setProjectId

public void setProjectId(String ProjectId)

Set Project ID.

Parameters:

ProjectId - Project ID.

getAlarmRuleId

public String getAlarmRuleId()

Get Specifies the unique id of the Alarm rule, obtained through the GetAlarmRule/ListAlarmRule api.

Returns:

AlarmRuleId Specifies the unique id of the Alarm rule, obtained through the GetAlarmRule/ListAlarmRule api.

setAlarmRuleId

public void setAlarmRuleId(String AlarmRuleId)

Set Specifies the unique id of the Alarm rule, obtained through the GetAlarmRule/ListAlarmRule api.

Parameters:

AlarmRuleId - Specifies the unique id of the Alarm rule, obtained through the GetAlarmRule/ListAlarmRule api.

getAlarmRuleName

public String getAlarmRuleName()

Get Specifies the new rule name of the Alarm rule.

Returns:

AlarmRuleName Specifies the new rule name of the Alarm rule.

setAlarmRuleName

public void setAlarmRuleName(String AlarmRuleName)

Set Specifies the new rule name of the Alarm rule.

Parameters:

AlarmRuleName - Specifies the new rule name of 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 based on the MonitorType setting: 1 (Task): MonitorObjectIds should be a list of task IDs. 2 (Workflow): MonitorObjectIds should be a list of workflow IDs (workflow IDs can be obtained via the ListWorkflows API). 3 (Project): MonitorObjectIds should be a list of project IDs.

Returns:

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

setMonitorObjectIds

public void setMonitorObjectIds(String[] MonitorObjectIds)

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

Parameters:

MonitorObjectIds - Pass different business IDs based on the MonitorType setting: 1 (Task): MonitorObjectIds should be a list of task IDs. 2 (Workflow): MonitorObjectIds should be a list of workflow IDs (workflow IDs can be obtained via the ListWorkflows API). 3 (Project): MonitorObjectIds should be 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 projectFailureInstanceUpwardVolatilityAlarm: Alarm when the upward fluctuation count 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 projectSuccessInstanceDownwardVolatilityAlarm: Alarm when the downward fluctuation count of successful instances for the day exceeds the threshold projectFailureInstanceCountAlarm: Alarm when the number of failed instances for the day exceeds the threshold projectFailureInstanceProportionAlarm: Alarm when the proportion of failed instances for the day exceeds the threshold reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when 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 projectFailureInstanceUpwardVolatilityAlarm: Alarm when the upward fluctuation count 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 projectSuccessInstanceDownwardVolatilityAlarm: Alarm when the downward fluctuation count of successful instances for the day exceeds the threshold projectFailureInstanceCountAlarm: Alarm when the number of failed instances for the day exceeds the threshold projectFailureInstanceProportionAlarm: Alarm when the proportion of failed instances for the day exceeds the threshold reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when 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 projectFailureInstanceUpwardVolatilityAlarm: Alarm when the upward fluctuation count 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 projectSuccessInstanceDownwardVolatilityAlarm: Alarm when the downward fluctuation count of successful instances for the day exceeds the threshold projectFailureInstanceCountAlarm: Alarm when the number of failed instances for the day exceeds the threshold projectFailureInstanceProportionAlarm: Alarm when the proportion of failed instances for the day exceeds the threshold reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when 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 projectFailureInstanceUpwardVolatilityAlarm: Alarm when the upward fluctuation count 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 projectSuccessInstanceDownwardVolatilityAlarm: Alarm when the downward fluctuation count of successful instances for the day exceeds the threshold projectFailureInstanceCountAlarm: Alarm when the number of failed instances for the day exceeds the threshold projectFailureInstanceProportionAlarm: Alarm when the proportion of failed instances for the day exceeds the threshold reconciliationFailure: Alarm when offline reconciliation task fails reconciliationOvertime: Alarm when offline reconciliation task runs overtime reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold

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.

getStatus

public Long getStatus()

Get Enable status of the Alarm rule. valid values: 0 (disabled), 1 (enabled).

Returns:

Status Enable status of the Alarm rule. valid values: 0 (disabled), 1 (enabled).

setStatus

public void setStatus(Long Status)

Set Enable status of the Alarm rule. valid values: 0 (disabled), 1 (enabled).

Parameters:

Status - Enable status of the Alarm rule. valid values: 0 (disabled), 1 (enabled).

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.

getAlarmGroups

public AlarmGroup[] getAlarmGroups()

Get Describes the Alarm recipient configuration message.

Returns:

AlarmGroups Describes the Alarm recipient configuration message.

setAlarmGroups

public void setAlarmGroups(AlarmGroup[] AlarmGroups)

Set Describes the Alarm recipient configuration message.

Parameters:

AlarmGroups - Describes the Alarm recipient configuration message.

getDescription

public String getDescription()

Get Alarm description.

Returns:

Description Alarm description.

setDescription

public void setDescription(String Description)

Set Alarm description.

Parameters:

Description - Alarm description.

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.