com.tencentcloudapi.cdn.v20180606.models

Class BandwidthAlert

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.BandwidthAlert

public class BandwidthAlert
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
BandwidthAlert()
BandwidthAlert(BandwidthAlert 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	getAlertPercentage() Get Triggers alarms when the ratio of bandwidth or traffic usage to the usage upper limit reaches the specified value Note: this field may return `null`, indicating that no valid values can be obtained.
String	getAlertSwitch() Get Indicates whether to trigger alerts when the upper limit is reached `on`: Enable `off`: Disable Note: this field may return `null`, indicating that no valid values can be obtained.
Long	getBpsThreshold() Get The upper limit of bandwidth usage (in bps) or traffic usage (in bytes).
String	getCounterMeasure() Get Action taken when threshold is reached `RETURN_404`: A 404 error will be returned for all requests.
String	getLastTriggerTime() Get The last time when the usage upper limit in the Chinese mainland was reached Note: this field may return `null`, indicating that no valid values can be obtained.
String	getLastTriggerTimeOverseas() Get The last time when the usage outside the Chinese mainland reached the upper limit Note: this field may return `null`, indicating that no valid values can be obtained.
String	getMetric() Get Dimension of the usage limit `bandwidth`: Bandwidth `flux`: Traffic Note: This field may return `null`, indicating that no valid value can be obtained.
StatisticItem[]	getStatisticItems() Get Usage limit configuration Note: This field may return `null`, indicating that no valid value can be obtained.
String	getSwitch() Get Specifies whether to enable the bandwidth cap `on`: Enable `off`: Disable
void	setAlertPercentage(Long AlertPercentage) Set Triggers alarms when the ratio of bandwidth or traffic usage to the usage upper limit reaches the specified value Note: this field may return `null`, indicating that no valid values can be obtained.
void	setAlertSwitch(String AlertSwitch) Set Indicates whether to trigger alerts when the upper limit is reached `on`: Enable `off`: Disable Note: this field may return `null`, indicating that no valid values can be obtained.
void	setBpsThreshold(Long BpsThreshold) Set The upper limit of bandwidth usage (in bps) or traffic usage (in bytes).
void	setCounterMeasure(String CounterMeasure) Set Action taken when threshold is reached `RETURN_404`: A 404 error will be returned for all requests.
void	setLastTriggerTime(String LastTriggerTime) Set The last time when the usage upper limit in the Chinese mainland was reached Note: this field may return `null`, indicating that no valid values can be obtained.
void	setLastTriggerTimeOverseas(String LastTriggerTimeOverseas) Set The last time when the usage outside the Chinese mainland reached the upper limit Note: this field may return `null`, indicating that no valid values can be obtained.
void	setMetric(String Metric) Set Dimension of the usage limit `bandwidth`: Bandwidth `flux`: Traffic Note: This field may return `null`, indicating that no valid value can be obtained.
void	setStatisticItems(StatisticItem[] StatisticItems) Set Usage limit configuration Note: This field may return `null`, indicating that no valid value can be obtained.
void	setSwitch(String Switch) Set Specifies whether to enable the bandwidth cap `on`: Enable `off`: Disable
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, getSkipSign, set, 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

BandwidthAlert

public BandwidthAlert()

BandwidthAlert

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

getSwitch

public String getSwitch()

Get Specifies whether to enable the bandwidth cap `on`: Enable `off`: Disable

Returns:

Switch Specifies whether to enable the bandwidth cap `on`: Enable `off`: Disable

setSwitch

public void setSwitch(String Switch)

Set Specifies whether to enable the bandwidth cap `on`: Enable `off`: Disable

Parameters:

Switch - Specifies whether to enable the bandwidth cap `on`: Enable `off`: Disable

getBpsThreshold

public Long getBpsThreshold()

Get The upper limit of bandwidth usage (in bps) or traffic usage (in bytes). Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

BpsThreshold The upper limit of bandwidth usage (in bps) or traffic usage (in bytes). Note: this field may return `null`, indicating that no valid values can be obtained.

setBpsThreshold

public void setBpsThreshold(Long BpsThreshold)

Set The upper limit of bandwidth usage (in bps) or traffic usage (in bytes). Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

BpsThreshold - The upper limit of bandwidth usage (in bps) or traffic usage (in bytes). Note: this field may return `null`, indicating that no valid values can be obtained.

getCounterMeasure

public String getCounterMeasure()

Get Action taken when threshold is reached `RETURN_404`: A 404 error will be returned for all requests. Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

CounterMeasure Action taken when threshold is reached `RETURN_404`: A 404 error will be returned for all requests. Note: this field may return `null`, indicating that no valid values can be obtained.

setCounterMeasure

public void setCounterMeasure(String CounterMeasure)

Set Action taken when threshold is reached `RETURN_404`: A 404 error will be returned for all requests. Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

CounterMeasure - Action taken when threshold is reached `RETURN_404`: A 404 error will be returned for all requests. Note: this field may return `null`, indicating that no valid values can be obtained.

getLastTriggerTime

public String getLastTriggerTime()

Get The last time when the usage upper limit in the Chinese mainland was reached Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

LastTriggerTime The last time when the usage upper limit in the Chinese mainland was reached Note: this field may return `null`, indicating that no valid values can be obtained.

setLastTriggerTime

public void setLastTriggerTime(String LastTriggerTime)

Set The last time when the usage upper limit in the Chinese mainland was reached Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

LastTriggerTime - The last time when the usage upper limit in the Chinese mainland was reached Note: this field may return `null`, indicating that no valid values can be obtained.

getAlertSwitch

public String getAlertSwitch()

Get Indicates whether to trigger alerts when the upper limit is reached `on`: Enable `off`: Disable Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

AlertSwitch Indicates whether to trigger alerts when the upper limit is reached `on`: Enable `off`: Disable Note: this field may return `null`, indicating that no valid values can be obtained.

setAlertSwitch

public void setAlertSwitch(String AlertSwitch)

Set Indicates whether to trigger alerts when the upper limit is reached `on`: Enable `off`: Disable Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

AlertSwitch - Indicates whether to trigger alerts when the upper limit is reached `on`: Enable `off`: Disable Note: this field may return `null`, indicating that no valid values can be obtained.

getAlertPercentage

public Long getAlertPercentage()

Get Triggers alarms when the ratio of bandwidth or traffic usage to the usage upper limit reaches the specified value Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

AlertPercentage Triggers alarms when the ratio of bandwidth or traffic usage to the usage upper limit reaches the specified value Note: this field may return `null`, indicating that no valid values can be obtained.

setAlertPercentage

public void setAlertPercentage(Long AlertPercentage)

Set Triggers alarms when the ratio of bandwidth or traffic usage to the usage upper limit reaches the specified value Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

AlertPercentage - Triggers alarms when the ratio of bandwidth or traffic usage to the usage upper limit reaches the specified value Note: this field may return `null`, indicating that no valid values can be obtained.

getLastTriggerTimeOverseas

public String getLastTriggerTimeOverseas()

Get The last time when the usage outside the Chinese mainland reached the upper limit Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

LastTriggerTimeOverseas The last time when the usage outside the Chinese mainland reached the upper limit Note: this field may return `null`, indicating that no valid values can be obtained.

setLastTriggerTimeOverseas

public void setLastTriggerTimeOverseas(String LastTriggerTimeOverseas)

Set The last time when the usage outside the Chinese mainland reached the upper limit Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

LastTriggerTimeOverseas - The last time when the usage outside the Chinese mainland reached the upper limit Note: this field may return `null`, indicating that no valid values can be obtained.

getMetric

public String getMetric()

Get Dimension of the usage limit `bandwidth`: Bandwidth `flux`: Traffic Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

Metric Dimension of the usage limit `bandwidth`: Bandwidth `flux`: Traffic Note: This field may return `null`, indicating that no valid value can be obtained.

setMetric

public void setMetric(String Metric)

Set Dimension of the usage limit `bandwidth`: Bandwidth `flux`: Traffic Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

Metric - Dimension of the usage limit `bandwidth`: Bandwidth `flux`: Traffic Note: This field may return `null`, indicating that no valid value can be obtained.

getStatisticItems

public StatisticItem[] getStatisticItems()

Get Usage limit configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

StatisticItems Usage limit configuration Note: This field may return `null`, indicating that no valid value can be obtained.

setStatisticItems

public void setStatisticItems(StatisticItem[] StatisticItems)

Set Usage limit configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

StatisticItems - Usage limit configuration Note: This field may return `null`, indicating that no valid value can be obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel