com.tencentcloudapi.cdn.v20180606.models

Class KeyRule

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.KeyRule

public class KeyRule
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
KeyRule()
KeyRule(KeyRule 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	getFullUrlCache() Get Whether to enable full-path cache `on`: Enable full-path cache (i.e., disable Ignore Query String).
String	getIgnoreCase() Get Whether caches are case insensitive Note: This field may return `null`, indicating that no valid value can be obtained.
RuleQueryString	getQueryString() Get Request parameter contained in `CacheKey` Note: This field may return `null`, indicating that no valid value can be obtained.
String[]	getRulePaths() Get Content for each CacheType: For `file`, enter a suffix, e.g., `jpg` or `txt`.
String	getRuleTag() Get Path cache key tag, the value "user" is passed.
String	getRuleType() Get Rule types: `file`: Apply to files with the specified suffixes.
void	setFullUrlCache(String FullUrlCache) Set Whether to enable full-path cache `on`: Enable full-path cache (i.e., disable Ignore Query String).
void	setIgnoreCase(String IgnoreCase) Set Whether caches are case insensitive Note: This field may return `null`, indicating that no valid value can be obtained.
void	setQueryString(RuleQueryString QueryString) Set Request parameter contained in `CacheKey` Note: This field may return `null`, indicating that no valid value can be obtained.
void	setRulePaths(String[] RulePaths) Set Content for each CacheType: For `file`, enter a suffix, e.g., `jpg` or `txt`.
void	setRuleTag(String RuleTag) Set Path cache key tag, the value "user" is passed.
void	setRuleType(String RuleType) Set Rule types: `file`: Apply to files with the specified suffixes.
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

KeyRule

public KeyRule()

KeyRule

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

getRulePaths

public String[] getRulePaths()

Get Content for each CacheType: For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter the path, such as /xxx/test/. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `index`, enter a backslash (/). Note: this field may return `null`, indicating that no valid value can be obtained.

Returns:

RulePaths Content for each CacheType: For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter the path, such as /xxx/test/. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `index`, enter a backslash (/). Note: this field may return `null`, indicating that no valid value can be obtained.

setRulePaths

public void setRulePaths(String[] RulePaths)

Set Content for each CacheType: For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter the path, such as /xxx/test/. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `index`, enter a backslash (/). Note: this field may return `null`, indicating that no valid value can be obtained.

Parameters:

RulePaths - Content for each CacheType: For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter the path, such as /xxx/test/. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `index`, enter a backslash (/). Note: this field may return `null`, indicating that no valid value can be obtained.

getRuleType

public String getRuleType()

Get Rule types: `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `index`: home page Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

RuleType Rule types: `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `index`: home page Note: This field may return `null`, indicating that no valid value can be obtained.

setRuleType

public void setRuleType(String RuleType)

Set Rule types: `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `index`: home page Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

RuleType - Rule types: `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `index`: home page Note: This field may return `null`, indicating that no valid value can be obtained.

getFullUrlCache

public String getFullUrlCache()

Get Whether to enable full-path cache `on`: Enable full-path cache (i.e., disable Ignore Query String). `off`: Disable full-path cache (i.e., enable Ignore Query String). Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

FullUrlCache Whether to enable full-path cache `on`: Enable full-path cache (i.e., disable Ignore Query String). `off`: Disable full-path cache (i.e., enable Ignore Query String). Note: This field may return `null`, indicating that no valid value can be obtained.

setFullUrlCache

public void setFullUrlCache(String FullUrlCache)

Set Whether to enable full-path cache `on`: Enable full-path cache (i.e., disable Ignore Query String). `off`: Disable full-path cache (i.e., enable Ignore Query String). Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

FullUrlCache - Whether to enable full-path cache `on`: Enable full-path cache (i.e., disable Ignore Query String). `off`: Disable full-path cache (i.e., enable Ignore Query String). Note: This field may return `null`, indicating that no valid value can be obtained.

getIgnoreCase

public String getIgnoreCase()

Get Whether caches are case insensitive Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

IgnoreCase Whether caches are case insensitive Note: This field may return `null`, indicating that no valid value can be obtained.

setIgnoreCase

public void setIgnoreCase(String IgnoreCase)

Set Whether caches are case insensitive Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

IgnoreCase - Whether caches are case insensitive Note: This field may return `null`, indicating that no valid value can be obtained.

getQueryString

public RuleQueryString getQueryString()

Get Request parameter contained in `CacheKey` Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

QueryString Request parameter contained in `CacheKey` Note: This field may return `null`, indicating that no valid value can be obtained.

setQueryString

public void setQueryString(RuleQueryString QueryString)

Set Request parameter contained in `CacheKey` Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

QueryString - Request parameter contained in `CacheKey` Note: This field may return `null`, indicating that no valid value can be obtained.

getRuleTag

public String getRuleTag()

Get Path cache key tag, the value "user" is passed. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

RuleTag Path cache key tag, the value "user" is passed. Note: This field may return `null`, indicating that no valid value can be obtained.

setRuleTag

public void setRuleTag(String RuleTag)

Set Path cache key tag, the value "user" is passed. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

RuleTag - Path cache key tag, the value "user" is passed. 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

Parameters:

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

prefix - A string prefix for the keys.