com.tencentcloudapi.cls.v20201016.models

Class CreateAlarmRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cls.v20201016.models.CreateAlarmRequest

public class CreateAlarmRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateAlarmRequest()
CreateAlarmRequest(CreateAlarmRequest 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
Long	getAlarmLevel() Get Alarm Level0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical).
String[]	getAlarmNoticeIds() Get List of associated alarm notification templates
Long	getAlarmPeriod() Get Alarm repeat interval in minutes.
AlarmTarget[]	getAlarmTargets() Get Monitoring object list
AnalysisDimensional[]	getAnalysis() Get Multi-Dimensional analysis
CallBackInfo	getCallBack() Get Custom callback
AlarmClassification[]	getClassifications() Get Alarms additional classification information listThe number of Classifications elements cannot exceed 20.The Key of Classifications element must not be empty and duplicated, and its length cannot exceed 50 characters, complying with the regular expression ^[a-z]([a-z0-9_]{0,49})$.The Value length of Classifications element cannot exceed 200 characters.
String	getCondition() Get Trigger ConditionNote:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations.
Boolean	getEnable() Get This parameter has been deprecated, please use the Status parameter to control whether to enable the alarm policy.
String[]	getGroupTriggerCondition() Get Grouping Trigger Conditions.
Boolean	getGroupTriggerStatus() Get Group trigger status.
String	getMessageTemplate() Get Custom alarm content
Long	getMonitorObjectType() Get Monitored Object Type.
MonitorTime	getMonitorTime() Get Monitoring task running time point
MultiCondition[]	getMultiConditions() Get Multiple trigger conditions Note:- Condition and AlarmLevel form one set of configurations, while MultiConditions form another set of configurations, and the two sets are mutually exclusive.
String	getName() Get Alarm policy name
Boolean	getStatus() Get Whether to enable the alarm policyThe default value is true
Tag[]	getTags() Get Tag description list, by specifying this parameter, you can simultaneously bind Tag to the corresponding alarm policy.Supports up to 10 Tag key-value pairs, and the pairs must be unique.
Long	getTriggerCount() Get Alarm persistence cycle.
void	setAlarmLevel(Long AlarmLevel) Set Alarm Level0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical).
void	setAlarmNoticeIds(String[] AlarmNoticeIds) Set List of associated alarm notification templates
void	setAlarmPeriod(Long AlarmPeriod) Set Alarm repeat interval in minutes.
void	setAlarmTargets(AlarmTarget[] AlarmTargets) Set Monitoring object list
void	setAnalysis(AnalysisDimensional[] Analysis) Set Multi-Dimensional analysis
void	setCallBack(CallBackInfo CallBack) Set Custom callback
void	setClassifications(AlarmClassification[] Classifications) Set Alarms additional classification information listThe number of Classifications elements cannot exceed 20.The Key of Classifications element must not be empty and duplicated, and its length cannot exceed 50 characters, complying with the regular expression ^[a-z]([a-z0-9_]{0,49})$.The Value length of Classifications element cannot exceed 200 characters.
void	setCondition(String Condition) Set Trigger ConditionNote:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations.
void	setEnable(Boolean Enable) Set This parameter has been deprecated, please use the Status parameter to control whether to enable the alarm policy.
void	setGroupTriggerCondition(String[] GroupTriggerCondition) Set Grouping Trigger Conditions.
void	setGroupTriggerStatus(Boolean GroupTriggerStatus) Set Group trigger status.
void	setMessageTemplate(String MessageTemplate) Set Custom alarm content
void	setMonitorObjectType(Long MonitorObjectType) Set Monitored Object Type.
void	setMonitorTime(MonitorTime MonitorTime) Set Monitoring task running time point
void	setMultiConditions(MultiCondition[] MultiConditions) Set Multiple trigger conditions Note:- Condition and AlarmLevel form one set of configurations, while MultiConditions form another set of configurations, and the two sets are mutually exclusive.
void	setName(String Name) Set Alarm policy name
void	setStatus(Boolean Status) Set Whether to enable the alarm policyThe default value is true
void	setTags(Tag[] Tags) Set Tag description list, by specifying this parameter, you can simultaneously bind Tag to the corresponding alarm policy.Supports up to 10 Tag key-value pairs, and the pairs must be unique.
void	setTriggerCount(Long TriggerCount) Set Alarm persistence cycle.
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, 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

CreateAlarmRequest

public CreateAlarmRequest()

CreateAlarmRequest

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

getName

public String getName()

Get Alarm policy name

Returns:

Name Alarm policy name

setName

public void setName(String Name)

Set Alarm policy name

Parameters:

Name - Alarm policy name

getAlarmTargets

public AlarmTarget[] getAlarmTargets()

Get Monitoring object list

Returns:

AlarmTargets Monitoring object list

setAlarmTargets

public void setAlarmTargets(AlarmTarget[] AlarmTargets)

Set Monitoring object list

Parameters:

AlarmTargets - Monitoring object list

getMonitorTime

public MonitorTime getMonitorTime()

Get Monitoring task running time point

Returns:

MonitorTime Monitoring task running time point

setMonitorTime

public void setMonitorTime(MonitorTime MonitorTime)

Set Monitoring task running time point

Parameters:

MonitorTime - Monitoring task running time point

getTriggerCount

public Long getTriggerCount()

Get Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10.

Returns:

TriggerCount Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10.

setTriggerCount

public void setTriggerCount(Long TriggerCount)

Set Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10.

Parameters:

TriggerCount - Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10.

getAlarmPeriod

public Long getAlarmPeriod()

Get Alarm repeat interval in minutes. The value range is 0~1440.

Returns:

AlarmPeriod Alarm repeat interval in minutes. The value range is 0~1440.

setAlarmPeriod

public void setAlarmPeriod(Long AlarmPeriod)

Set Alarm repeat interval in minutes. The value range is 0~1440.

Parameters:

AlarmPeriod - Alarm repeat interval in minutes. The value range is 0~1440.

getAlarmNoticeIds

public String[] getAlarmNoticeIds()

Get List of associated alarm notification templates

Returns:

AlarmNoticeIds List of associated alarm notification templates

setAlarmNoticeIds

public void setAlarmNoticeIds(String[] AlarmNoticeIds)

Set List of associated alarm notification templates

Parameters:

AlarmNoticeIds - List of associated alarm notification templates

getCondition

public String getCondition()

Get Trigger ConditionNote:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

Returns:

Condition Trigger ConditionNote:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

setCondition

public void setCondition(String Condition)

Set Trigger ConditionNote:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

Parameters:

Condition - Trigger ConditionNote:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

getAlarmLevel

public Long getAlarmLevel()

Get Alarm Level0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical). Note:- If not specified, the default is 0. - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

Returns:

AlarmLevel Alarm Level0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical). Note:- If not specified, the default is 0. - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

setAlarmLevel

public void setAlarmLevel(Long AlarmLevel)

Set Alarm Level0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical). Note:- If not specified, the default is 0. - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

Parameters:

AlarmLevel - Alarm Level0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical). Note:- If not specified, the default is 0. - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.

getMultiConditions

public MultiCondition[] getMultiConditions()

Get Multiple trigger conditions Note:- Condition and AlarmLevel form one set of configurations, while MultiConditions form another set of configurations, and the two sets are mutually exclusive.

Returns:

MultiConditions Multiple trigger conditions Note:- Condition and AlarmLevel form one set of configurations, while MultiConditions form another set of configurations, and the two sets are mutually exclusive.

setMultiConditions

public void setMultiConditions(MultiCondition[] MultiConditions)

Set Multiple trigger conditions Note:- Condition and AlarmLevel form one set of configurations, while MultiConditions form another set of configurations, and the two sets are mutually exclusive.

Parameters:

MultiConditions - Multiple trigger conditions Note:- Condition and AlarmLevel form one set of configurations, while MultiConditions form another set of configurations, and the two sets are mutually exclusive.

getStatus

public Boolean getStatus()

Get Whether to enable the alarm policyThe default value is true

Returns:

Status Whether to enable the alarm policyThe default value is true

setStatus

public void setStatus(Boolean Status)

Set Whether to enable the alarm policyThe default value is true

Parameters:

Status - Whether to enable the alarm policyThe default value is true

getEnable

public Boolean getEnable()

Get This parameter has been deprecated, please use the Status parameter to control whether to enable the alarm policy.

Returns:

Enable This parameter has been deprecated, please use the Status parameter to control whether to enable the alarm policy.

setEnable

public void setEnable(Boolean Enable)

Set This parameter has been deprecated, please use the Status parameter to control whether to enable the alarm policy.

Parameters:

Enable - This parameter has been deprecated, please use the Status parameter to control whether to enable the alarm policy.

getMessageTemplate

public String getMessageTemplate()

Get Custom alarm content

Returns:

MessageTemplate Custom alarm content

setMessageTemplate

public void setMessageTemplate(String MessageTemplate)

Set Custom alarm content

Parameters:

MessageTemplate - Custom alarm content

getCallBack

public CallBackInfo getCallBack()

Get Custom callback

Returns:

CallBack Custom callback

setCallBack

public void setCallBack(CallBackInfo CallBack)

Set Custom callback

Parameters:

CallBack - Custom callback

getAnalysis

public AnalysisDimensional[] getAnalysis()

Get Multi-Dimensional analysis

Returns:

Analysis Multi-Dimensional analysis

setAnalysis

public void setAnalysis(AnalysisDimensional[] Analysis)

Set Multi-Dimensional analysis

Parameters:

Analysis - Multi-Dimensional analysis

getGroupTriggerStatus

public Boolean getGroupTriggerStatus()

Get Group trigger status. Default value is false

Returns:

GroupTriggerStatus Group trigger status. Default value is false

setGroupTriggerStatus

public void setGroupTriggerStatus(Boolean GroupTriggerStatus)

Set Group trigger status. Default value is false

Parameters:

GroupTriggerStatus - Group trigger status. Default value is false

getGroupTriggerCondition

public String[] getGroupTriggerCondition()

Get Grouping Trigger Conditions.

Returns:

GroupTriggerCondition Grouping Trigger Conditions.

setGroupTriggerCondition

public void setGroupTriggerCondition(String[] GroupTriggerCondition)

Set Grouping Trigger Conditions.

Parameters:

GroupTriggerCondition - Grouping Trigger Conditions.

getTags

public Tag[] getTags()

Get Tag description list, by specifying this parameter, you can simultaneously bind Tag to the corresponding alarm policy.Supports up to 10 Tag key-value pairs, and the pairs must be unique.

Returns:

Tags Tag description list, by specifying this parameter, you can simultaneously bind Tag to the corresponding alarm policy.Supports up to 10 Tag key-value pairs, and the pairs must be unique.

setTags

public void setTags(Tag[] Tags)

Set Tag description list, by specifying this parameter, you can simultaneously bind Tag to the corresponding alarm policy.Supports up to 10 Tag key-value pairs, and the pairs must be unique.

Parameters:

Tags - Tag description list, by specifying this parameter, you can simultaneously bind Tag to the corresponding alarm policy.Supports up to 10 Tag key-value pairs, and the pairs must be unique.

getMonitorObjectType

public Long getMonitorObjectType()

Get Monitored Object Type. 0: common monitoring objects for execution statements; 1: separately selected monitoring objects for each execution statement.If not specified, the default value is 0.When the value is 1, the number of AlarmTargets Elements (XML) cannot exceed 10, and the Numbers in AlarmTargets must be continuous positive integers starting from 1, without duplication.

Returns:

MonitorObjectType Monitored Object Type. 0: common monitoring objects for execution statements; 1: separately selected monitoring objects for each execution statement.If not specified, the default value is 0.When the value is 1, the number of AlarmTargets Elements (XML) cannot exceed 10, and the Numbers in AlarmTargets must be continuous positive integers starting from 1, without duplication.

setMonitorObjectType

public void setMonitorObjectType(Long MonitorObjectType)

Set Monitored Object Type. 0: common monitoring objects for execution statements; 1: separately selected monitoring objects for each execution statement.If not specified, the default value is 0.When the value is 1, the number of AlarmTargets Elements (XML) cannot exceed 10, and the Numbers in AlarmTargets must be continuous positive integers starting from 1, without duplication.

Parameters:

MonitorObjectType - Monitored Object Type. 0: common monitoring objects for execution statements; 1: separately selected monitoring objects for each execution statement.If not specified, the default value is 0.When the value is 1, the number of AlarmTargets Elements (XML) cannot exceed 10, and the Numbers in AlarmTargets must be continuous positive integers starting from 1, without duplication.

getClassifications

public AlarmClassification[] getClassifications()

Get Alarms additional classification information listThe number of Classifications elements cannot exceed 20.The Key of Classifications element must not be empty and duplicated, and its length cannot exceed 50 characters, complying with the regular expression ^[a-z]([a-z0-9_]{0,49})$.The Value length of Classifications element cannot exceed 200 characters.

Returns:

Classifications Alarms additional classification information listThe number of Classifications elements cannot exceed 20.The Key of Classifications element must not be empty and duplicated, and its length cannot exceed 50 characters, complying with the regular expression ^[a-z]([a-z0-9_]{0,49})$.The Value length of Classifications element cannot exceed 200 characters.

setClassifications

public void setClassifications(AlarmClassification[] Classifications)

Set Alarms additional classification information listThe number of Classifications elements cannot exceed 20.The Key of Classifications element must not be empty and duplicated, and its length cannot exceed 50 characters, complying with the regular expression ^[a-z]([a-z0-9_]{0,49})$.The Value length of Classifications element cannot exceed 200 characters.

Parameters:

Classifications - Alarms additional classification information listThe number of Classifications elements cannot exceed 20.The Key of Classifications element must not be empty and duplicated, and its length cannot exceed 50 characters, complying with the regular expression ^[a-z]([a-z0-9_]{0,49})$.The Value length of Classifications element cannot exceed 200 characters.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel