com.tencentcloudapi.monitor.v20180724.models

Class DescribeAlarmPoliciesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.monitor.v20180724.models.DescribeAlarmPoliciesRequest

public class DescribeAlarmPoliciesRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeAlarmPoliciesRequest()
DescribeAlarmPoliciesRequest(DescribeAlarmPoliciesRequest 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
String	getDimensions() Get The alarm object list, which is a JSON string.
Long[]	getEnable() Get Filter by alarm status.
String	getField() Get Sort by field.
Long	getInstanceGroupId() Get Instance group ID.
String	getModule() Get Value fixed at "monitor"
String[]	getMonitorTypes() Get Filter by monitor type.
String[]	getNamespaces() Get Filter by namespace.
Long	getNeedCorrespondence() Get Whether the relationship between a policy and the input parameter filter dimension is required.
Long	getNotBindAll() Get Whether the returned result filters policies associated with all objects.
Long	getNotBindingNoticeRule() Get If `1` is passed in, alarm policies with no notification rules configured are queried.
String[]	getNoticeIds() Get ID list of the notification template, which can be obtained by querying the notification template list.
Long	getNotInstanceGroup() Get Whether the returned result filters policies associated with instance groups.
String[]	getOneClickPolicyType() Get Filter by quick alarm policy.
String	getOrder() Get Sort order.
Long	getPageNumber() Get Page number starting from 1.
Long	getPageSize() Get Number of entries per page.
String	getPolicyName() Get Fuzzy search by policy name
String[]	getPolicyType() Get Filter by default policy.
Long[]	getProjectIds() Get ID array of the policy project, which can be viewed on the following page: [Project Management](https://console.cloud.tencent.com/project)
Long[]	getReceiverGroups() Get Search by recipient group.
Long[]	getReceiverUids() Get Search by recipient.
String[]	getRuleTypes() Get Filter by trigger condition.
Tag[]	getTags() Get Filter policies by tag
AlarmPolicyTriggerTask[]	getTriggerTasks() Get Filter alarm policy by triggered task (such as auto scaling task).
void	setDimensions(String Dimensions) Set The alarm object list, which is a JSON string.
void	setEnable(Long[] Enable) Set Filter by alarm status.
void	setField(String Field) Set Sort by field.
void	setInstanceGroupId(Long InstanceGroupId) Set Instance group ID.
void	setModule(String Module) Set Value fixed at "monitor"
void	setMonitorTypes(String[] MonitorTypes) Set Filter by monitor type.
void	setNamespaces(String[] Namespaces) Set Filter by namespace.
void	setNeedCorrespondence(Long NeedCorrespondence) Set Whether the relationship between a policy and the input parameter filter dimension is required.
void	setNotBindAll(Long NotBindAll) Set Whether the returned result filters policies associated with all objects.
void	setNotBindingNoticeRule(Long NotBindingNoticeRule) Set If `1` is passed in, alarm policies with no notification rules configured are queried.
void	setNoticeIds(String[] NoticeIds) Set ID list of the notification template, which can be obtained by querying the notification template list.
void	setNotInstanceGroup(Long NotInstanceGroup) Set Whether the returned result filters policies associated with instance groups.
void	setOneClickPolicyType(String[] OneClickPolicyType) Set Filter by quick alarm policy.
void	setOrder(String Order) Set Sort order.
void	setPageNumber(Long PageNumber) Set Page number starting from 1.
void	setPageSize(Long PageSize) Set Number of entries per page.
void	setPolicyName(String PolicyName) Set Fuzzy search by policy name
void	setPolicyType(String[] PolicyType) Set Filter by default policy.
void	setProjectIds(Long[] ProjectIds) Set ID array of the policy project, which can be viewed on the following page: [Project Management](https://console.cloud.tencent.com/project)
void	setReceiverGroups(Long[] ReceiverGroups) Set Search by recipient group.
void	setReceiverUids(Long[] ReceiverUids) Set Search by recipient.
void	setRuleTypes(String[] RuleTypes) Set Filter by trigger condition.
void	setTags(Tag[] Tags) Set Filter policies by tag
void	setTriggerTasks(AlarmPolicyTriggerTask[] TriggerTasks) Set Filter alarm policy by triggered task (such as auto scaling task).
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeAlarmPoliciesRequest

public DescribeAlarmPoliciesRequest()

DescribeAlarmPoliciesRequest

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

getModule

public String getModule()

Get Value fixed at "monitor"

Returns:

Module Value fixed at "monitor"

setModule

public void setModule(String Module)

Set Value fixed at "monitor"

Parameters:

Module - Value fixed at "monitor"

getPageNumber

public Long getPageNumber()

Get Page number starting from 1. Default value: 1

Returns:

PageNumber Page number starting from 1. Default value: 1

setPageNumber

public void setPageNumber(Long PageNumber)

Set Page number starting from 1. Default value: 1

Parameters:

PageNumber - Page number starting from 1. Default value: 1

getPageSize

public Long getPageSize()

Get Number of entries per page. Value range: 1–100. Default value: 20

Returns:

PageSize Number of entries per page. Value range: 1–100. Default value: 20

setPageSize

public void setPageSize(Long PageSize)

Set Number of entries per page. Value range: 1–100. Default value: 20

Parameters:

PageSize - Number of entries per page. Value range: 1–100. Default value: 20

getPolicyName

public String getPolicyName()

Get Fuzzy search by policy name

Returns:

PolicyName Fuzzy search by policy name

setPolicyName

public void setPolicyName(String PolicyName)

Set Fuzzy search by policy name

Parameters:

PolicyName - Fuzzy search by policy name

getMonitorTypes

public String[] getMonitorTypes()

Get Filter by monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring). If this parameter is left empty, all will be queried by default

Returns:

MonitorTypes Filter by monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring). If this parameter is left empty, all will be queried by default

setMonitorTypes

public void setMonitorTypes(String[] MonitorTypes)

Set Filter by monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring). If this parameter is left empty, all will be queried by default

Parameters:

MonitorTypes - Filter by monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring). If this parameter is left empty, all will be queried by default

getNamespaces

public String[] getNamespaces()

Get Filter by namespace. For the values of different policy types, please see: [Policy Type List](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1)

Returns:

Namespaces Filter by namespace. For the values of different policy types, please see: [Policy Type List](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1)

setNamespaces

public void setNamespaces(String[] Namespaces)

Set Filter by namespace. For the values of different policy types, please see: [Policy Type List](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1)

Parameters:

Namespaces - Filter by namespace. For the values of different policy types, please see: [Policy Type List](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1)

getDimensions

public String getDimensions()

Get The alarm object list, which is a JSON string. The outer array corresponds to multiple instances, and the inner array is the dimension of an object. For example, “CVM - Basic Monitor” can be written as: `[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]` You can also refer to the “Example 2” below. For more information on the parameter samples of different Tencent Cloud services, see [Product Policy Type and Dimension Information](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1). Note: If `1` is passed in for `NeedCorrespondence`, the relationship between a policy and an instance needs to be returned. You can pass in up to 20 alarm object dimensions to avoid request timeout.

Returns:

Dimensions The alarm object list, which is a JSON string. The outer array corresponds to multiple instances, and the inner array is the dimension of an object. For example, “CVM - Basic Monitor” can be written as: `[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]` You can also refer to the “Example 2” below. For more information on the parameter samples of different Tencent Cloud services, see [Product Policy Type and Dimension Information](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1). Note: If `1` is passed in for `NeedCorrespondence`, the relationship between a policy and an instance needs to be returned. You can pass in up to 20 alarm object dimensions to avoid request timeout.

setDimensions

public void setDimensions(String Dimensions)

Set The alarm object list, which is a JSON string. The outer array corresponds to multiple instances, and the inner array is the dimension of an object. For example, “CVM - Basic Monitor” can be written as: `[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]` You can also refer to the “Example 2” below. For more information on the parameter samples of different Tencent Cloud services, see [Product Policy Type and Dimension Information](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1). Note: If `1` is passed in for `NeedCorrespondence`, the relationship between a policy and an instance needs to be returned. You can pass in up to 20 alarm object dimensions to avoid request timeout.

Parameters:

Dimensions - The alarm object list, which is a JSON string. The outer array corresponds to multiple instances, and the inner array is the dimension of an object. For example, “CVM - Basic Monitor” can be written as: `[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]` You can also refer to the “Example 2” below. For more information on the parameter samples of different Tencent Cloud services, see [Product Policy Type and Dimension Information](https://intl.cloud.tencent.com/document/product/248/50397?from_cn_redirect=1). Note: If `1` is passed in for `NeedCorrespondence`, the relationship between a policy and an instance needs to be returned. You can pass in up to 20 alarm object dimensions to avoid request timeout.

getReceiverUids

public Long[] getReceiverUids()

Get Search by recipient. You can get the user list with the API [ListUsers](https://intl.cloud.tencent.com/document/product/598/34587?from_cn_redirect=1) in “Cloud Access Management” or query the sub-user information with the API [GetUser](https://intl.cloud.tencent.com/document/product/598/34590?from_cn_redirect=1). The `Uid` field in the returned result should be entered here.

Returns:

ReceiverUids Search by recipient. You can get the user list with the API [ListUsers](https://intl.cloud.tencent.com/document/product/598/34587?from_cn_redirect=1) in “Cloud Access Management” or query the sub-user information with the API [GetUser](https://intl.cloud.tencent.com/document/product/598/34590?from_cn_redirect=1). The `Uid` field in the returned result should be entered here.

setReceiverUids

public void setReceiverUids(Long[] ReceiverUids)

Set Search by recipient. You can get the user list with the API [ListUsers](https://intl.cloud.tencent.com/document/product/598/34587?from_cn_redirect=1) in “Cloud Access Management” or query the sub-user information with the API [GetUser](https://intl.cloud.tencent.com/document/product/598/34590?from_cn_redirect=1). The `Uid` field in the returned result should be entered here.

Parameters:

ReceiverUids - Search by recipient. You can get the user list with the API [ListUsers](https://intl.cloud.tencent.com/document/product/598/34587?from_cn_redirect=1) in “Cloud Access Management” or query the sub-user information with the API [GetUser](https://intl.cloud.tencent.com/document/product/598/34590?from_cn_redirect=1). The `Uid` field in the returned result should be entered here.

getReceiverGroups

public Long[] getReceiverGroups()

Get Search by recipient group. You can get the user group list with the API [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1) in “Cloud Access Management” or query the user group list where a sub-user is in with the API [ListGroupsForUser](https://intl.cloud.tencent.com/document/product/598/34588?from_cn_redirect=1). The `GroupId` field in the returned result should be entered here.

Returns:

ReceiverGroups Search by recipient group. You can get the user group list with the API [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1) in “Cloud Access Management” or query the user group list where a sub-user is in with the API [ListGroupsForUser](https://intl.cloud.tencent.com/document/product/598/34588?from_cn_redirect=1). The `GroupId` field in the returned result should be entered here.

setReceiverGroups

public void setReceiverGroups(Long[] ReceiverGroups)

Set Search by recipient group. You can get the user group list with the API [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1) in “Cloud Access Management” or query the user group list where a sub-user is in with the API [ListGroupsForUser](https://intl.cloud.tencent.com/document/product/598/34588?from_cn_redirect=1). The `GroupId` field in the returned result should be entered here.

Parameters:

ReceiverGroups - Search by recipient group. You can get the user group list with the API [ListGroups](https://intl.cloud.tencent.com/document/product/598/34589?from_cn_redirect=1) in “Cloud Access Management” or query the user group list where a sub-user is in with the API [ListGroupsForUser](https://intl.cloud.tencent.com/document/product/598/34588?from_cn_redirect=1). The `GroupId` field in the returned result should be entered here.

getPolicyType

public String[] getPolicyType()

Get Filter by default policy. Valid values: DEFAULT (display default policy), NOT_DEFAULT (display non-default policies). If this parameter is left empty, all policies will be displayed

Returns:

PolicyType Filter by default policy. Valid values: DEFAULT (display default policy), NOT_DEFAULT (display non-default policies). If this parameter is left empty, all policies will be displayed

setPolicyType

public void setPolicyType(String[] PolicyType)

Set Filter by default policy. Valid values: DEFAULT (display default policy), NOT_DEFAULT (display non-default policies). If this parameter is left empty, all policies will be displayed

Parameters:

PolicyType - Filter by default policy. Valid values: DEFAULT (display default policy), NOT_DEFAULT (display non-default policies). If this parameter is left empty, all policies will be displayed

getField

public String getField()

Get Sort by field. For example, to sort by the last modification time, use Field: "UpdateTime".

Returns:

Field Sort by field. For example, to sort by the last modification time, use Field: "UpdateTime".

setField

public void setField(String Field)

Set Sort by field. For example, to sort by the last modification time, use Field: "UpdateTime".

Parameters:

Field - Sort by field. For example, to sort by the last modification time, use Field: "UpdateTime".

getOrder

public String getOrder()

Get Sort order. Valid values: ASC (ascending), DESC (descending)

Returns:

Order Sort order. Valid values: ASC (ascending), DESC (descending)

setOrder

public void setOrder(String Order)

Set Sort order. Valid values: ASC (ascending), DESC (descending)

Parameters:

Order - Sort order. Valid values: ASC (ascending), DESC (descending)

getProjectIds

public Long[] getProjectIds()

Get ID array of the policy project, which can be viewed on the following page: [Project Management](https://console.cloud.tencent.com/project)

Returns:

ProjectIds ID array of the policy project, which can be viewed on the following page: [Project Management](https://console.cloud.tencent.com/project)

setProjectIds

public void setProjectIds(Long[] ProjectIds)

Set ID array of the policy project, which can be viewed on the following page: [Project Management](https://console.cloud.tencent.com/project)

Parameters:

ProjectIds - ID array of the policy project, which can be viewed on the following page: [Project Management](https://console.cloud.tencent.com/project)

getNoticeIds

public String[] getNoticeIds()

Get ID list of the notification template, which can be obtained by querying the notification template list. It can be queried with the API [DescribeAlarmNotices](https://intl.cloud.tencent.com/document/product/248/51280?from_cn_redirect=1).

Returns:

NoticeIds ID list of the notification template, which can be obtained by querying the notification template list. It can be queried with the API [DescribeAlarmNotices](https://intl.cloud.tencent.com/document/product/248/51280?from_cn_redirect=1).

setNoticeIds

public void setNoticeIds(String[] NoticeIds)

Set ID list of the notification template, which can be obtained by querying the notification template list. It can be queried with the API [DescribeAlarmNotices](https://intl.cloud.tencent.com/document/product/248/51280?from_cn_redirect=1).

Parameters:

NoticeIds - ID list of the notification template, which can be obtained by querying the notification template list. It can be queried with the API [DescribeAlarmNotices](https://intl.cloud.tencent.com/document/product/248/51280?from_cn_redirect=1).

getRuleTypes

public String[] getRuleTypes()

Get Filter by trigger condition. Valid values: STATIC (display policies with static threshold), DYNAMIC (display policies with dynamic threshold). If this parameter is left empty, all policies will be displayed

Returns:

RuleTypes Filter by trigger condition. Valid values: STATIC (display policies with static threshold), DYNAMIC (display policies with dynamic threshold). If this parameter is left empty, all policies will be displayed

setRuleTypes

public void setRuleTypes(String[] RuleTypes)

Set Filter by trigger condition. Valid values: STATIC (display policies with static threshold), DYNAMIC (display policies with dynamic threshold). If this parameter is left empty, all policies will be displayed

Parameters:

RuleTypes - Filter by trigger condition. Valid values: STATIC (display policies with static threshold), DYNAMIC (display policies with dynamic threshold). If this parameter is left empty, all policies will be displayed

getEnable

public Long[] getEnable()

Get Filter by alarm status. Valid values: [1]: enabled; [0]: disabled; [0, 1]: all

Returns:

Enable Filter by alarm status. Valid values: [1]: enabled; [0]: disabled; [0, 1]: all

setEnable

public void setEnable(Long[] Enable)

Set Filter by alarm status. Valid values: [1]: enabled; [0]: disabled; [0, 1]: all

Parameters:

Enable - Filter by alarm status. Valid values: [1]: enabled; [0]: disabled; [0, 1]: all

getNotBindingNoticeRule

public Long getNotBindingNoticeRule()

Get If `1` is passed in, alarm policies with no notification rules configured are queried. If it is left empty or other values are passed in, all alarm policies are queried.

Returns:

NotBindingNoticeRule If `1` is passed in, alarm policies with no notification rules configured are queried. If it is left empty or other values are passed in, all alarm policies are queried.

setNotBindingNoticeRule

public void setNotBindingNoticeRule(Long NotBindingNoticeRule)

Set If `1` is passed in, alarm policies with no notification rules configured are queried. If it is left empty or other values are passed in, all alarm policies are queried.

Parameters:

NotBindingNoticeRule - If `1` is passed in, alarm policies with no notification rules configured are queried. If it is left empty or other values are passed in, all alarm policies are queried.

getInstanceGroupId

public Long getInstanceGroupId()

Get Instance group ID.

Returns:

InstanceGroupId Instance group ID.

setInstanceGroupId

public void setInstanceGroupId(Long InstanceGroupId)

Set Instance group ID.

Parameters:

InstanceGroupId - Instance group ID.

getNeedCorrespondence

public Long getNeedCorrespondence()

Get Whether the relationship between a policy and the input parameter filter dimension is required. `1`: Yes. `0`: No. Default value: `0`.

Returns:

NeedCorrespondence Whether the relationship between a policy and the input parameter filter dimension is required. `1`: Yes. `0`: No. Default value: `0`.

setNeedCorrespondence

public void setNeedCorrespondence(Long NeedCorrespondence)

Set Whether the relationship between a policy and the input parameter filter dimension is required. `1`: Yes. `0`: No. Default value: `0`.

Parameters:

NeedCorrespondence - Whether the relationship between a policy and the input parameter filter dimension is required. `1`: Yes. `0`: No. Default value: `0`.

getTriggerTasks

public AlarmPolicyTriggerTask[] getTriggerTasks()

Get Filter alarm policy by triggered task (such as auto scaling task). Up to 10 tasks can be specified.

Returns:

TriggerTasks Filter alarm policy by triggered task (such as auto scaling task). Up to 10 tasks can be specified.

setTriggerTasks

public void setTriggerTasks(AlarmPolicyTriggerTask[] TriggerTasks)

Set Filter alarm policy by triggered task (such as auto scaling task). Up to 10 tasks can be specified.

Parameters:

TriggerTasks - Filter alarm policy by triggered task (such as auto scaling task). Up to 10 tasks can be specified.

getOneClickPolicyType

public String[] getOneClickPolicyType()

Get Filter by quick alarm policy. If this parameter is left empty, all policies are displayed. `ONECLICK`: Display quick alarm policies; `NOT_ONECLICK`: Display non-quick alarm policies.

Returns:

OneClickPolicyType Filter by quick alarm policy. If this parameter is left empty, all policies are displayed. `ONECLICK`: Display quick alarm policies; `NOT_ONECLICK`: Display non-quick alarm policies.

setOneClickPolicyType

public void setOneClickPolicyType(String[] OneClickPolicyType)

Set Filter by quick alarm policy. If this parameter is left empty, all policies are displayed. `ONECLICK`: Display quick alarm policies; `NOT_ONECLICK`: Display non-quick alarm policies.

Parameters:

OneClickPolicyType - Filter by quick alarm policy. If this parameter is left empty, all policies are displayed. `ONECLICK`: Display quick alarm policies; `NOT_ONECLICK`: Display non-quick alarm policies.

getNotBindAll

public Long getNotBindAll()

Get Whether the returned result filters policies associated with all objects. Valid values: `1` (Yes), `0` (No).

Returns:

NotBindAll Whether the returned result filters policies associated with all objects. Valid values: `1` (Yes), `0` (No).

setNotBindAll

public void setNotBindAll(Long NotBindAll)

Set Whether the returned result filters policies associated with all objects. Valid values: `1` (Yes), `0` (No).

Parameters:

NotBindAll - Whether the returned result filters policies associated with all objects. Valid values: `1` (Yes), `0` (No).

getNotInstanceGroup

public Long getNotInstanceGroup()

Get Whether the returned result filters policies associated with instance groups. Valid values: `1` (Yes), `0` (No).

Returns:

NotInstanceGroup Whether the returned result filters policies associated with instance groups. Valid values: `1` (Yes), `0` (No).

setNotInstanceGroup

public void setNotInstanceGroup(Long NotInstanceGroup)

Set Whether the returned result filters policies associated with instance groups. Valid values: `1` (Yes), `0` (No).

Parameters:

NotInstanceGroup - Whether the returned result filters policies associated with instance groups. Valid values: `1` (Yes), `0` (No).

getTags

public Tag[] getTags()

Get Filter policies by tag

Returns:

Tags Filter policies by tag

setTags

public void setTags(Tag[] Tags)

Set Filter policies by tag

Parameters:

Tags - Filter policies by tag

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel