com.tencentcloudapi.wedata.v20250806.models

Class CreateOpsAlarmRuleRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.wedata.v20250806.models.CreateOpsAlarmRuleRequest

public class CreateOpsAlarmRuleRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateOpsAlarmRuleRequest()
CreateOpsAlarmRuleRequest(CreateOpsAlarmRuleRequest 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 Alarm recipient configuration.
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	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	getDescription() Get Describes the Alarm rule.
String[]	getMonitorObjectIds() Get Monitoring Object Business ID List - 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	getProjectId() Get Project ID.
void	setAlarmGroups(AlarmGroup[] AlarmGroups) Set Alarm recipient configuration.
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	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	setDescription(String Description) Set Describes the Alarm rule.
void	setMonitorObjectIds(String[] MonitorObjectIds) Set Monitoring Object Business ID List - 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	setProjectId(String ProjectId) Set Project ID.
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

CreateOpsAlarmRuleRequest

public CreateOpsAlarmRuleRequest()

CreateOpsAlarmRuleRequest

public CreateOpsAlarmRuleRequest(CreateOpsAlarmRuleRequest 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.

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.

getMonitorObjectIds

public String[] getMonitorObjectIds()

Get Monitoring Object Business ID List - 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 Monitoring Object Business ID List - 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 Monitoring Object Business ID List - 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 - Monitoring Object Business ID List - 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

getAlarmGroups

public AlarmGroup[] getAlarmGroups()

Get Alarm recipient configuration.

Returns:

AlarmGroups Alarm recipient configuration.

setAlarmGroups

public void setAlarmGroups(AlarmGroup[] AlarmGroups)

Set Alarm recipient configuration.

Parameters:

AlarmGroups - Alarm recipient configuration.

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

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 (default: 1. ordinary).

Returns:

AlarmLevel Alarm level. 1. ordinary, 2. important, 3. critical (default: 1. ordinary).

setAlarmLevel

public void setAlarmLevel(Long AlarmLevel)

Set Alarm level. 1. ordinary, 2. important, 3. critical (default: 1. ordinary).

Parameters:

AlarmLevel - Alarm level. 1. ordinary, 2. important, 3. critical (default: 1. ordinary).

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.

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.