com.tencentcloudapi.teo.v20220901.models

Class ExceptionRule

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.teo.v20220901.models.ExceptionRule

public class ExceptionRule
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ExceptionRule()
ExceptionRule(ExceptionRule 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	getCondition() Get 例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。
String	getEnabled() Get 例外规则是否开启。取值有：on：开启off：关闭
String	getId() Get 例外规则的 ID。 通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数； 修改已有规则：指定需要更新/修改的规则 ID； 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。
String[]	getManagedRuleGroupsForException() Get 指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRulesForException 。
String[]	getManagedRulesForException() Get 指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRuleGroupsForException 。
String	getName() Get 例外规则的名称。
RequestFieldsForException[]	getRequestFieldsForException() Get 指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。
String	getSkipOption() Get 跳过请求的具体类型，取值有：SkipOnAllRequestFields: 跳过所有请求；SkipOnSpecifiedRequestFields: 跳过指定请求字段。仅当 SkipScope 为 ManagedRules 时有效。
String	getSkipScope() Get 例外规则执行选项，取值有：WebSecurityModules: 指定例外规则的安全防护模块。ManagedRules：指定托管规则。
String[]	getWebSecurityModulesForException() Get 指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效。取值有：websec-mod-managed-rules：托管规则；websec-mod-rate-limiting：速率限制；websec-mod-custom-rules：自定义规则；websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；websec-mod-bot：Bot管理。
void	setCondition(String Condition) Set 例外规则的具体内容，需符合表达式语法，详细规范参见产品文档。
void	setEnabled(String Enabled) Set 例外规则是否开启。取值有：on：开启off：关闭
void	setId(String Id) Set 例外规则的 ID。 通过规则 ID 可支持不同的规则配置操作： 增加新规则：ID 为空或不指定 ID 参数； 修改已有规则：指定需要更新/修改的规则 ID； 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。
void	setManagedRuleGroupsForException(String[] ManagedRuleGroupsForException) Set 指定例外规则的托管规则组，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRulesForException 。
void	setManagedRulesForException(String[] ManagedRulesForException) Set 指定例外规则的具体托管规则，仅当 SkipScope 为 ManagedRules 时有效，且此时不能指定 ManagedRuleGroupsForException 。
void	setName(String Name) Set 例外规则的名称。
void	setRequestFieldsForException(RequestFieldsForException[] RequestFieldsForException) Set 指定例外规则跳过指定请求字段的具体配置，仅当 SkipScope 为 ManagedRules 并且 SkipOption 为 SkipOnSpecifiedRequestFields 时有效。
void	setSkipOption(String SkipOption) Set 跳过请求的具体类型，取值有：SkipOnAllRequestFields: 跳过所有请求；SkipOnSpecifiedRequestFields: 跳过指定请求字段。仅当 SkipScope 为 ManagedRules 时有效。
void	setSkipScope(String SkipScope) Set 例外规则执行选项，取值有：WebSecurityModules: 指定例外规则的安全防护模块。ManagedRules：指定托管规则。
void	setWebSecurityModulesForException(String[] WebSecurityModulesForException) Set 指定例外规则的安全防护模块，仅当 SkipScope 为 WebSecurityModules 时有效。取值有：websec-mod-managed-rules：托管规则；websec-mod-rate-limiting：速率限制；websec-mod-custom-rules：自定义规则；websec-mod-adaptive-control：自适应频控、智能客户端过滤、慢速攻击防护、流量盗刷防护；websec-mod-bot：Bot管理。
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

ExceptionRule

public ExceptionRule()

ExceptionRule

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

getId

public String getId()

Get 例外规则的 ID。
通过规则 ID 可支持不同的规则配置操作：

增加新规则：ID 为空或不指定 ID 参数； 修改已有规则：指定需要更新/修改的规则 ID； 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。

Returns:

Id 例外规则的 ID。
通过规则 ID 可支持不同的规则配置操作：

增加新规则：ID 为空或不指定 ID 参数；

修改已有规则：指定需要更新/修改的规则 ID；

删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。

setId

public void setId(String Id)

Set 例外规则的 ID。
通过规则 ID 可支持不同的规则配置操作：

增加新规则：ID 为空或不指定 ID 参数； 修改已有规则：指定需要更新/修改的规则 ID； 删除已有规则：ExceptionRules 参数中，Rules 列表中未包含的已有规则将被删除。