com.tencentcloudapi.cdn.v20180606.models

Class RemoteAuthenticationRule

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.RemoteAuthenticationRule

public class RemoteAuthenticationRule
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
RemoteAuthenticationRule()
RemoteAuthenticationRule(RemoteAuthenticationRule 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	getAuthMethod() Get HTTP method used by the remote authentication server.
Long	getAuthTimeout() Get Timeout period of the remote authentication server.
String	getAuthTimeoutAction() Get Whether to deny or allow the request when the remote authentication server is timed out: `RETURN_200`: the request is allowed when the remote authentication server is timed out.
String[]	getRulePaths() Get Content for each `RuleType`: For `all`, enter a wildcard `*`.
String	getRuleType() Get Rule types: `all`: apply to all files `file`: apply to files with the specified suffixes `directory`: apply to the specified directories `path`: apply to the specified absolute paths Default: `all`.
String	getServer() Get Remote authentication server The server configured in `RemoteAutherntication` is used by default.
void	setAuthMethod(String AuthMethod) Set HTTP method used by the remote authentication server.
void	setAuthTimeout(Long AuthTimeout) Set Timeout period of the remote authentication server.
void	setAuthTimeoutAction(String AuthTimeoutAction) Set Whether to deny or allow the request when the remote authentication server is timed out: `RETURN_200`: the request is allowed when the remote authentication server is timed out.
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 `file`: apply to files with the specified suffixes `directory`: apply to the specified directories `path`: apply to the specified absolute paths Default: `all`.
void	setServer(String Server) Set Remote authentication server The server configured in `RemoteAutherntication` is used by default.
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, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteAuthenticationRule

public RemoteAuthenticationRule()

RemoteAuthenticationRule

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

getServer

public String getServer()

Get Remote authentication server The server configured in `RemoteAutherntication` is used by default.

Returns:

Server Remote authentication server The server configured in `RemoteAutherntication` is used by default.

setServer

public void setServer(String Server)

Set Remote authentication server The server configured in `RemoteAutherntication` is used by default.

Parameters:

Server - Remote authentication server The server configured in `RemoteAutherntication` is used by default.

getAuthMethod

public String getAuthMethod()

Get HTTP method used by the remote authentication server. Valid values: `get`, `post`, `head`, and `all`. `all`: the remote authentication server follows the client request method. Default: `all`

Returns:

AuthMethod HTTP method used by the remote authentication server. Valid values: `get`, `post`, `head`, and `all`. `all`: the remote authentication server follows the client request method. Default: `all`

setAuthMethod

public void setAuthMethod(String AuthMethod)

Set HTTP method used by the remote authentication server. Valid values: `get`, `post`, `head`, and `all`. `all`: the remote authentication server follows the client request method. Default: `all`

Parameters:

AuthMethod - HTTP method used by the remote authentication server. Valid values: `get`, `post`, `head`, and `all`. `all`: the remote authentication server follows the client request method. Default: `all`

getRuleType

public String getRuleType()

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

Returns:

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

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 the specified directories `path`: apply to the specified absolute paths Default: `all`.

Parameters:

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

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`. For `index`, enter a forward slash `/`. Default: `*`

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`. For `index`, enter a forward slash `/`. Default: `*`

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`. For `index`, enter a forward slash `/`. Default: `*`

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`. For `index`, enter a forward slash `/`. Default: `*`

getAuthTimeout

public Long getAuthTimeout()

Get Timeout period of the remote authentication server. Unit: ms. Value range: [1, 30,000] Default: 20000

Returns:

AuthTimeout Timeout period of the remote authentication server. Unit: ms. Value range: [1, 30,000] Default: 20000

setAuthTimeout

public void setAuthTimeout(Long AuthTimeout)

Set Timeout period of the remote authentication server. Unit: ms. Value range: [1, 30,000] Default: 20000

Parameters:

AuthTimeout - Timeout period of the remote authentication server. Unit: ms. Value range: [1, 30,000] Default: 20000

getAuthTimeoutAction

public String getAuthTimeoutAction()

Get Whether to deny or allow the request when the remote authentication server is timed out: `RETURN_200`: the request is allowed when the remote authentication server is timed out. `RETURN_403`: the request is denied when the remote authentication server is timed out. Default: `RETURN_200`

Returns:

AuthTimeoutAction Whether to deny or allow the request when the remote authentication server is timed out: `RETURN_200`: the request is allowed when the remote authentication server is timed out. `RETURN_403`: the request is denied when the remote authentication server is timed out. Default: `RETURN_200`

setAuthTimeoutAction

public void setAuthTimeoutAction(String AuthTimeoutAction)

Set Whether to deny or allow the request when the remote authentication server is timed out: `RETURN_200`: the request is allowed when the remote authentication server is timed out. `RETURN_403`: the request is denied when the remote authentication server is timed out. Default: `RETURN_200`

Parameters:

AuthTimeoutAction - Whether to deny or allow the request when the remote authentication server is timed out: `RETURN_200`: the request is allowed when the remote authentication server is timed out. `RETURN_403`: the request is denied when the remote authentication server is timed out. Default: `RETURN_200`

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel