com.tencentcloudapi.cdn.v20180606.models

Class RefererRule

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.RefererRule

public class RefererRule
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
RefererRule()
RefererRule(RefererRule 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
Boolean	getAllowEmpty() Get Whether to allow empty referer `true`: Allow empty referer when `RefererType = whitelist`.
String[]	getReferers() Get Referer content list
String	getRefererType() Get Referer configuration types `whitelist`: Allowlist `blacklist`: Blocklist
String[]	getRulePaths() Get Content for each `RuleType`: For `all`, enter a wildcard `*`.
String	getRuleType() Get Rule types: `all`: Apply to all files.
void	setAllowEmpty(Boolean AllowEmpty) Set Whether to allow empty referer `true`: Allow empty referer when `RefererType = whitelist`.
void	setReferers(String[] Referers) Set Referer content list
void	setRefererType(String RefererType) Set Referer configuration types `whitelist`: Allowlist `blacklist`: Blocklist
void	setRulePaths(String[] RulePaths) Set Content for each `RuleType`: For `all`, enter a wildcard `*`.
void	setRuleType(String RuleType) Set Rule types: `all`: Apply to all files.
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

RefererRule

public RefererRule()

RefererRule

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

getRuleType

public String getRuleType()

Get Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths.

Returns:

RuleType Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths.

setRuleType

public void setRuleType(String RuleType)

Set Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths.

Parameters:

RuleType - Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths.

getRulePaths

public String[] getRulePaths()

Get Content for each `RuleType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`.

Returns:

RulePaths Content for each `RuleType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`.

setRulePaths

public void setRulePaths(String[] RulePaths)

Set Content for each `RuleType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`.

Parameters:

RulePaths - Content for each `RuleType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`.

getRefererType

public String getRefererType()

Get Referer configuration types `whitelist`: Allowlist `blacklist`: Blocklist

Returns:

RefererType Referer configuration types `whitelist`: Allowlist `blacklist`: Blocklist

setRefererType

public void setRefererType(String RefererType)

Set Referer configuration types `whitelist`: Allowlist `blacklist`: Blocklist

Parameters:

RefererType - Referer configuration types `whitelist`: Allowlist `blacklist`: Blocklist

getReferers

public String[] getReferers()

Get Referer content list

Returns:

Referers Referer content list

setReferers

public void setReferers(String[] Referers)

Set Referer content list

Parameters:

Referers - Referer content list

getAllowEmpty

public Boolean getAllowEmpty()

Get Whether to allow empty referer `true`: Allow empty referer when `RefererType = whitelist`. `false`: Reject empty refer when `RefererType = blacklist`.

Returns:

AllowEmpty Whether to allow empty referer `true`: Allow empty referer when `RefererType = whitelist`. `false`: Reject empty refer when `RefererType = blacklist`.

setAllowEmpty

public void setAllowEmpty(Boolean AllowEmpty)

Set Whether to allow empty referer `true`: Allow empty referer when `RefererType = whitelist`. `false`: Reject empty refer when `RefererType = blacklist`.

Parameters:

AllowEmpty - Whether to allow empty referer `true`: Allow empty referer when `RefererType = whitelist`. `false`: Reject empty refer when `RefererType = blacklist`.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.