java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.teo.v20220901.models.RateLimitUserRule

public class RateLimitUserRule
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor	Description
`RateLimitUserRule()`
`RateLimitUserRule(RateLimitUserRule 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AclCondition[]`	`getAclConditions()`	Get 规则详情。
`String`	`getAction()`	Get 处置动作，取值有： monitor：观察； drop：拦截； alg：JavaScript挑战。
`String[]`	`getFreqFields()`	Get 过滤词，取值有： sip：客户端ip。注意：此字段可能返回 null，表示取不到有效值。
`String[]`	`getFreqScope()`	Get 统计范围，字段为 null 时，代表 source_to_eo。取值有： source_to_eo：（响应）源站到EdgeOne。 client_to_eo：（请求）客户端到EdgeOne；注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getPeriod()`	Get 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。
`Long`	`getPunishTime()`	Get 惩罚时长，0-2天。
`String`	`getPunishTimeUnit()`	Get 处罚时长单位，取值有： second：秒； minutes：分钟； hour：小时。
`Long`	`getRuleID()`	Get 规则 Id。仅出参使用。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getRuleName()`	Get 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
`Long`	`getRulePriority()`	Get 规则权重，取值范围0-100。
`String`	`getRuleStatus()`	Get 规则状态，取值有： on：生效； off：不生效。默认on生效。
`Long`	`getThreshold()`	Get 速率限制统计阈值，单位是次，取值范围0-4294967294。
`String`	`getUpdateTime()`	Get 更新时间。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setAclConditions(AclCondition[] AclConditions)`	Set 规则详情。
`void`	`setAction(String Action)`	Set 处置动作，取值有： monitor：观察； drop：拦截； alg：JavaScript挑战。
`void`	`setFreqFields(String[] FreqFields)`	Set 过滤词，取值有： sip：客户端ip。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setFreqScope(String[] FreqScope)`	Set 统计范围，字段为 null 时，代表 source_to_eo。取值有： source_to_eo：（响应）源站到EdgeOne。 client_to_eo：（请求）客户端到EdgeOne；注意：此字段可能返回 null，表示取不到有效值。
`void`	`setPeriod(Long Period)`	Set 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。
`void`	`setPunishTime(Long PunishTime)`	Set 惩罚时长，0-2天。
`void`	`setPunishTimeUnit(String PunishTimeUnit)`	Set 处罚时长单位，取值有： second：秒； minutes：分钟； hour：小时。
`void`	`setRuleID(Long RuleID)`	Set 规则 Id。仅出参使用。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setRuleName(String RuleName)`	Set 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
`void`	`setRulePriority(Long RulePriority)`	Set 规则权重，取值范围0-100。
`void`	`setRuleStatus(String RuleStatus)`	Set 规则状态，取值有： on：生效； off：不生效。默认on生效。
`void`	`setThreshold(Long Threshold)`	Set 速率限制统计阈值，单位是次，取值范围0-4294967294。
`void`	`setUpdateTime(String UpdateTime)`	Set 更新时间。注意：此字段可能返回 null，表示取不到有效值。
`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
  - RateLimitUserRule
```
public RateLimitUserRule()
```
  - RateLimitUserRule
```
public RateLimitUserRule(RateLimitUserRule 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
  - getThreshold
```
public Long getThreshold()
```
    Get 速率限制统计阈值，单位是次，取值范围0-4294967294。
    
    Returns:
    
    Threshold 速率限制统计阈值，单位是次，取值范围0-4294967294。
  - setThreshold
```
public void setThreshold(Long Threshold)
```
    Set 速率限制统计阈值，单位是次，取值范围0-4294967294。
    
    Parameters:
    
    Threshold - 速率限制统计阈值，单位是次，取值范围0-4294967294。
  - getPeriod
```
public Long getPeriod()
```
    Get 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。
    
    Returns:
    
    Period 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。
  - setPeriod
```
public void setPeriod(Long Period)
```
    Set 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。
    
    Parameters:
    
    Period - 速率限制统计时间，取值范围 10/20/30/40/50/60 单位是秒。
  - getRuleName
```
public String getRuleName()
```
    Get 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
    
    Returns:
    
    RuleName 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
  - setRuleName
```
public void setRuleName(String RuleName)
```
    Set 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
    
    Parameters:
    
    RuleName - 规则名，只能以英文字符，数字，下划线组合，且不能以下划线开头。
  - getAction
```
public String getAction()
```
    Get 处置动作，取值有：
  - monitor：观察；
  - drop：拦截；
  - alg：JavaScript挑战。

Returns:: Action 处置动作，取值有：
monitor：观察；

drop：拦截；

alg：JavaScript挑战。

setAction

public void setAction(String Action)

Set 处置动作，取值有：

monitor：观察；
drop：拦截；
alg：JavaScript挑战。

Parameters:: Action - 处置动作，取值有：
monitor：观察；

drop：拦截；

alg：JavaScript挑战。

getPunishTime
```
public Long getPunishTime()
```
Get 惩罚时长，0-2天。

Returns:

PunishTime 惩罚时长，0-2天。

setPunishTime
```
public void setPunishTime(Long PunishTime)
```
Set 惩罚时长，0-2天。

Parameters:

PunishTime - 惩罚时长，0-2天。

getPunishTimeUnit
```
public String getPunishTimeUnit()
```
Get 处罚时长单位，取值有：
second：秒；
minutes：分钟；
hour：小时。

Returns:: PunishTimeUnit 处罚时长单位，取值有：
second：秒；

minutes：分钟；

hour：小时。

setPunishTimeUnit

public void setPunishTimeUnit(String PunishTimeUnit)

Set 处罚时长单位，取值有：

second：秒；
minutes：分钟；
hour：小时。

Parameters:: PunishTimeUnit - 处罚时长单位，取值有：
second：秒；

minutes：分钟；

hour：小时。

getRuleStatus
```
public String getRuleStatus()
```
Get 规则状态，取值有：
on：生效；
off：不生效。

Returns:: RuleStatus 规则状态，取值有：
on：生效；

off：不生效。
默认on生效。

setRuleStatus

public void setRuleStatus(String RuleStatus)

Set 规则状态，取值有：

on：生效；
off：不生效。

Parameters:: RuleStatus - 规则状态，取值有：
on：生效；

off：不生效。
默认on生效。

getAclConditions
```
public AclCondition[] getAclConditions()
```
Get 规则详情。

Returns:

AclConditions 规则详情。

setAclConditions
```
public void setAclConditions(AclCondition[] AclConditions)
```
Set 规则详情。

Parameters:

AclConditions - 规则详情。

getRulePriority
```
public Long getRulePriority()
```
Get 规则权重，取值范围0-100。

Returns:

RulePriority 规则权重，取值范围0-100。

setRulePriority
```
public void setRulePriority(Long RulePriority)
```
Set 规则权重，取值范围0-100。

Parameters:

RulePriority - 规则权重，取值范围0-100。

getRuleID
```
public Long getRuleID()
```
Get 规则 Id。仅出参使用。注意：此字段可能返回 null，表示取不到有效值。

Returns:

RuleID 规则 Id。仅出参使用。注意：此字段可能返回 null，表示取不到有效值。

setRuleID
```
public void setRuleID(Long RuleID)
```
Set 规则 Id。仅出参使用。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

RuleID - 规则 Id。仅出参使用。注意：此字段可能返回 null，表示取不到有效值。

getFreqFields
```
public String[] getFreqFields()
```
Get 过滤词，取值有：
sip：客户端ip。

Returns:: FreqFields 过滤词，取值有：
sip：客户端ip。
注意：此字段可能返回 null，表示取不到有效值。

setFreqFields

public void setFreqFields(String[] FreqFields)

Set 过滤词，取值有：

sip：客户端ip。

Parameters:: FreqFields - 过滤词，取值有：
sip：客户端ip。
注意：此字段可能返回 null，表示取不到有效值。

getUpdateTime
```
public String getUpdateTime()
```
Get 更新时间。注意：此字段可能返回 null，表示取不到有效值。

Returns:

UpdateTime 更新时间。注意：此字段可能返回 null，表示取不到有效值。

setUpdateTime
```
public void setUpdateTime(String UpdateTime)
```
Set 更新时间。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

UpdateTime - 更新时间。注意：此字段可能返回 null，表示取不到有效值。

getFreqScope
```
public String[] getFreqScope()
```
Get 统计范围，字段为 null 时，代表 source_to_eo。取值有：
source_to_eo：（响应）源站到EdgeOne。
client_to_eo：（请求）客户端到EdgeOne；

Returns:: FreqScope 统计范围，字段为 null 时，代表 source_to_eo。取值有：
source_to_eo：（响应）源站到EdgeOne。

client_to_eo：（请求）客户端到EdgeOne；
注意：此字段可能返回 null，表示取不到有效值。

setFreqScope
```
public void setFreqScope(String[] FreqScope)
```
Set 统计范围，字段为 null 时，代表 source_to_eo。取值有：
source_to_eo：（响应）源站到EdgeOne。
client_to_eo：（请求）客户端到EdgeOne；

Parameters:: FreqScope - 统计范围，字段为 null 时，代表 source_to_eo。取值有：
source_to_eo：（响应）源站到EdgeOne。

client_to_eo：（请求）客户端到EdgeOne；
注意：此字段可能返回 null，表示取不到有效值。

toMap

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

Internal implementation, normal users should not use it.

Specified by:: toMap in class AbstractModel

Class RateLimitUserRule

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

RateLimitUserRule

RateLimitUserRule

Method Detail

getThreshold

setThreshold

getPeriod

setPeriod

getRuleName

setRuleName

getAction

setAction

getPunishTime

setPunishTime

getPunishTimeUnit

setPunishTimeUnit

getRuleStatus

setRuleStatus

getAclConditions

setAclConditions

getRulePriority

setRulePriority

getRuleID

setRuleID

getFreqFields

setFreqFields

getUpdateTime

setUpdateTime

getFreqScope

setFreqScope

toMap