com.tencentcloudapi.cdn.v20180606.models

Class PathRule

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.PathRule

public class PathRule
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
PathRule()
PathRule(PathRule 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	getForwardUri() Get Origin server URI path when the path matches, starting with `/` and excluding parameters.
Boolean	getFullMatch() Get When `Regex` is `false`, this parameter should be `true`.
String	getOrigin() Get Origin server when the path matches.
String	getOriginArea() Get Region of the origin server.
String	getPath() Get Matched URL.
Boolean	getRegex() Get Whether to enable wildcard match (`*`).
HttpHeaderRule[]	getRequestHeaders() Get Origin-pull header setting when the path matches.
String	getServerName() Get Origin server host header when the path matches.
void	setForwardUri(String ForwardUri) Set Origin server URI path when the path matches, starting with `/` and excluding parameters.
void	setFullMatch(Boolean FullMatch) Set When `Regex` is `false`, this parameter should be `true`.
void	setOrigin(String Origin) Set Origin server when the path matches.
void	setOriginArea(String OriginArea) Set Region of the origin server.
void	setPath(String Path) Set Matched URL.
void	setRegex(Boolean Regex) Set Whether to enable wildcard match (`*`).
void	setRequestHeaders(HttpHeaderRule[] RequestHeaders) Set Origin-pull header setting when the path matches.
void	setServerName(String ServerName) Set Origin server host header when the path matches.
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

PathRule

public PathRule()

PathRule

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

getRegex

public Boolean getRegex()

Get Whether to enable wildcard match (`*`). `false`: disabled `true`: enabled Note: this field may return `null`, indicating that no valid value can be obtained.

Returns:

Regex Whether to enable wildcard match (`*`). `false`: disabled `true`: enabled Note: this field may return `null`, indicating that no valid value can be obtained.

setRegex

public void setRegex(Boolean Regex)

Set Whether to enable wildcard match (`*`). `false`: disabled `true`: enabled Note: this field may return `null`, indicating that no valid value can be obtained.

Parameters:

Regex - Whether to enable wildcard match (`*`). `false`: disabled `true`: enabled Note: this field may return `null`, indicating that no valid value can be obtained.

getPath

public String getPath()

Get Matched URL. Only URLs are supported, while parameters are not. The exact match is used by default. If wildcard match is enabled, up to 5 wildcards are supported. The URL can contain up to 1,024 characters. Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Path Matched URL. Only URLs are supported, while parameters are not. The exact match is used by default. If wildcard match is enabled, up to 5 wildcards are supported. The URL can contain up to 1,024 characters. Note: this field may return `null`, indicating that no valid values can be obtained.

setPath

public void setPath(String Path)

Set Matched URL. Only URLs are supported, while parameters are not. The exact match is used by default. If wildcard match is enabled, up to 5 wildcards are supported. The URL can contain up to 1,024 characters. Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Path - Matched URL. Only URLs are supported, while parameters are not. The exact match is used by default. If wildcard match is enabled, up to 5 wildcards are supported. The URL can contain up to 1,024 characters. Note: this field may return `null`, indicating that no valid values can be obtained.

getOrigin

public String getOrigin()

Get Origin server when the path matches. COS origin with private read/write is not supported. The default origin server will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Origin Origin server when the path matches. COS origin with private read/write is not supported. The default origin server will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

setOrigin

public void setOrigin(String Origin)

Set Origin server when the path matches. COS origin with private read/write is not supported. The default origin server will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Origin - Origin server when the path matches. COS origin with private read/write is not supported. The default origin server will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

getServerName

public String getServerName()

Get Origin server host header when the path matches. The default `ServerName` will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

ServerName Origin server host header when the path matches. The default `ServerName` will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

setServerName

public void setServerName(String ServerName)

Set Origin server host header when the path matches. The default `ServerName` will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

ServerName - Origin server host header when the path matches. The default `ServerName` will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.

getOriginArea

public String getOriginArea()

Get Region of the origin server. Valid values: `CN` and `OV`. `CN`: Within the Chinese mainland `OV`: Outside the Chinese mainland Default value: `CN`. Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

OriginArea Region of the origin server. Valid values: `CN` and `OV`. `CN`: Within the Chinese mainland `OV`: Outside the Chinese mainland Default value: `CN`. Note: this field may return `null`, indicating that no valid values can be obtained.

setOriginArea

public void setOriginArea(String OriginArea)

Set Region of the origin server. Valid values: `CN` and `OV`. `CN`: Within the Chinese mainland `OV`: Outside the Chinese mainland Default value: `CN`. Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

OriginArea - Region of the origin server. Valid values: `CN` and `OV`. `CN`: Within the Chinese mainland `OV`: Outside the Chinese mainland Default value: `CN`. Note: this field may return `null`, indicating that no valid values can be obtained.

getForwardUri

public String getForwardUri()

Get Origin server URI path when the path matches, starting with `/` and excluding parameters. The path can contain up to 1,024 characters. The wildcards in the match path can be respectively captured using `$1`, `$2`, `$3`, `$4`, and `$5`. Up to 10 values can be captured. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

ForwardUri Origin server URI path when the path matches, starting with `/` and excluding parameters. The path can contain up to 1,024 characters. The wildcards in the match path can be respectively captured using `$1`, `$2`, `$3`, `$4`, and `$5`. Up to 10 values can be captured. Note: This field may return `null`, indicating that no valid value can be obtained.

setForwardUri

public void setForwardUri(String ForwardUri)

Set Origin server URI path when the path matches, starting with `/` and excluding parameters. The path can contain up to 1,024 characters. The wildcards in the match path can be respectively captured using `$1`, `$2`, `$3`, `$4`, and `$5`. Up to 10 values can be captured. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

ForwardUri - Origin server URI path when the path matches, starting with `/` and excluding parameters. The path can contain up to 1,024 characters. The wildcards in the match path can be respectively captured using `$1`, `$2`, `$3`, `$4`, and `$5`. Up to 10 values can be captured. Note: This field may return `null`, indicating that no valid value can be obtained.

getRequestHeaders

public HttpHeaderRule[] getRequestHeaders()

Get Origin-pull header setting when the path matches. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

RequestHeaders Origin-pull header setting when the path matches. Note: This field may return `null`, indicating that no valid value can be obtained.

setRequestHeaders

public void setRequestHeaders(HttpHeaderRule[] RequestHeaders)

Set Origin-pull header setting when the path matches. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

RequestHeaders - Origin-pull header setting when the path matches. Note: This field may return `null`, indicating that no valid value can be obtained.

getFullMatch

public Boolean getFullMatch()

Get When `Regex` is `false`, this parameter should be `true`. `false`: Disabled `true`: enabled Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

FullMatch When `Regex` is `false`, this parameter should be `true`. `false`: Disabled `true`: enabled Note: This field may return `null`, indicating that no valid value can be obtained.

setFullMatch

public void setFullMatch(Boolean FullMatch)

Set When `Regex` is `false`, this parameter should be `true`. `false`: Disabled `true`: enabled Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

FullMatch - When `Regex` is `false`, this parameter should be `true`. `false`: Disabled `true`: enabled 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.