com.tencentcloudapi.cdn.v20180606.models

Class Origin

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.Origin

public class Origin
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
Origin()
Origin(Origin 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
AdvanceHttps	getAdvanceHttps() Get HTTPS advanced origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.
String[]	getBackupOrigins() Get Backup origin server list When modifying the backup origin server, you need to enter the corresponding BackupOriginType.
String	getBackupOriginType() Get Backup origin server type, which supports the following types: `domain`: Domain name `ip`: IP address When modifying BackupOrigins, you need to enter the corresponding BackupOriginType.
String	getBackupServerName() Get Host header used when accessing the backup origin server.
String	getBasePath() Get Origin-pull path Note: This field may return `null`, indicating that no valid value can be obtained.
String	getCosPrivateAccess() Get When OriginType is COS, you can specify if access to private buckets is allowed.
String	getOriginCompany() Get Object storage vendor Note: This field may return `null`, indicating that no valid value can be obtained.
String	getOriginPullProtocol() Get Origin-pull protocol configuration http: forced HTTP origin-pull follow: protocol follow origin-pull https: forced HTTPS origin-pull.
String[]	getOrigins() Get Primary origin server list When modifying the origin server, you need to enter the corresponding OriginType.
String	getOriginType() Get Primary origin server type The following types are supported for input parameters: `domain`: domain name `domainv6`: IPv6 domain name cos: COS origin `ip`: IP address ipv6: origin server list is a single IPv6 address `ip_ipv6`: multiple IPv4 addresses and one IPv6 address `ip_domain`: IP addresses and domain names (only available to beta users) `ip_domainv6`: Multiple IPv4 addresses and one IPv6 domain name `ipv6_domain`: multiple IPv6 addresses and one domain name `ipv6_domainv6`: Multiple IPv6 addresses and one IPv6 domain name `domain_domainv6`: Multiple IPv4 domain names and one IPv6 domain name `ip_ipv6_domain`: multiple IPv4 and IPv6 addresses and one domain name `ip_ipv6_domainv6`: Multiple IPv4 and IPv6 addresses and one IPv6 domain name `ip_domain_domainv6`: Multiple IPv4 addresses and IPv4 domain names and one IPv6 domain name `ipv6_domain_domainv6`: Multiple IPv4 domain names and IPv6 addresses and one IPv6 domain name `ip_ipv6_domain_domainv6`: Multiple IPv4 and IPv6 addresses and IPv4 domain names and one IPv6 domain name The following types of output parameters are added: image: Cloud Infinite origin ftp: legacy FTP origin, which is no longer maintained.
PathBasedOriginRule[]	getPathBasedOrigin() Get Path-based origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.
PathRule[]	getPathRules() Get Origin-pull path rewriting configuration Note: This field may return `null`, indicating that no valid value can be obtained.
String	getServerName() Get It is required when a COS origin or third-party origin is used for acceleration.
void	setAdvanceHttps(AdvanceHttps AdvanceHttps) Set HTTPS advanced origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.
void	setBackupOrigins(String[] BackupOrigins) Set Backup origin server list When modifying the backup origin server, you need to enter the corresponding BackupOriginType.
void	setBackupOriginType(String BackupOriginType) Set Backup origin server type, which supports the following types: `domain`: Domain name `ip`: IP address When modifying BackupOrigins, you need to enter the corresponding BackupOriginType.
void	setBackupServerName(String BackupServerName) Set Host header used when accessing the backup origin server.
void	setBasePath(String BasePath) Set Origin-pull path Note: This field may return `null`, indicating that no valid value can be obtained.
void	setCosPrivateAccess(String CosPrivateAccess) Set When OriginType is COS, you can specify if access to private buckets is allowed.
void	setOriginCompany(String OriginCompany) Set Object storage vendor Note: This field may return `null`, indicating that no valid value can be obtained.
void	setOriginPullProtocol(String OriginPullProtocol) Set Origin-pull protocol configuration http: forced HTTP origin-pull follow: protocol follow origin-pull https: forced HTTPS origin-pull.
void	setOrigins(String[] Origins) Set Primary origin server list When modifying the origin server, you need to enter the corresponding OriginType.
void	setOriginType(String OriginType) Set Primary origin server type The following types are supported for input parameters: `domain`: domain name `domainv6`: IPv6 domain name cos: COS origin `ip`: IP address ipv6: origin server list is a single IPv6 address `ip_ipv6`: multiple IPv4 addresses and one IPv6 address `ip_domain`: IP addresses and domain names (only available to beta users) `ip_domainv6`: Multiple IPv4 addresses and one IPv6 domain name `ipv6_domain`: multiple IPv6 addresses and one domain name `ipv6_domainv6`: Multiple IPv6 addresses and one IPv6 domain name `domain_domainv6`: Multiple IPv4 domain names and one IPv6 domain name `ip_ipv6_domain`: multiple IPv4 and IPv6 addresses and one domain name `ip_ipv6_domainv6`: Multiple IPv4 and IPv6 addresses and one IPv6 domain name `ip_domain_domainv6`: Multiple IPv4 addresses and IPv4 domain names and one IPv6 domain name `ipv6_domain_domainv6`: Multiple IPv4 domain names and IPv6 addresses and one IPv6 domain name `ip_ipv6_domain_domainv6`: Multiple IPv4 and IPv6 addresses and IPv4 domain names and one IPv6 domain name The following types of output parameters are added: image: Cloud Infinite origin ftp: legacy FTP origin, which is no longer maintained.
void	setPathBasedOrigin(PathBasedOriginRule[] PathBasedOrigin) Set Path-based origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.
void	setPathRules(PathRule[] PathRules) Set Origin-pull path rewriting configuration Note: This field may return `null`, indicating that no valid value can be obtained.
void	setServerName(String ServerName) Set It is required when a COS origin or third-party origin is used for acceleration.
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

Origin

public Origin()

Origin

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

getOrigins

public String[] getOrigins()

Get Primary origin server list When modifying the origin server, you need to enter the corresponding OriginType. Note: This field may return `null`, indicating that no valid value was found.

Returns:

Origins Primary origin server list When modifying the origin server, you need to enter the corresponding OriginType. Note: This field may return `null`, indicating that no valid value was found.

setOrigins

public void setOrigins(String[] Origins)

Set Primary origin server list When modifying the origin server, you need to enter the corresponding OriginType. Note: This field may return `null`, indicating that no valid value was found.

Parameters:

Origins - Primary origin server list When modifying the origin server, you need to enter the corresponding OriginType. Note: This field may return `null`, indicating that no valid value was found.

getOriginType

public String getOriginType()

Get Primary origin server type The following types are supported for input parameters: `domain`: domain name `domainv6`: IPv6 domain name cos: COS origin `ip`: IP address ipv6: origin server list is a single IPv6 address `ip_ipv6`: multiple IPv4 addresses and one IPv6 address `ip_domain`: IP addresses and domain names (only available to beta users) `ip_domainv6`: Multiple IPv4 addresses and one IPv6 domain name `ipv6_domain`: multiple IPv6 addresses and one domain name `ipv6_domainv6`: Multiple IPv6 addresses and one IPv6 domain name `domain_domainv6`: Multiple IPv4 domain names and one IPv6 domain name `ip_ipv6_domain`: multiple IPv4 and IPv6 addresses and one domain name `ip_ipv6_domainv6`: Multiple IPv4 and IPv6 addresses and one IPv6 domain name `ip_domain_domainv6`: Multiple IPv4 addresses and IPv4 domain names and one IPv6 domain name `ipv6_domain_domainv6`: Multiple IPv4 domain names and IPv6 addresses and one IPv6 domain name `ip_ipv6_domain_domainv6`: Multiple IPv4 and IPv6 addresses and IPv4 domain names and one IPv6 domain name The following types of output parameters are added: image: Cloud Infinite origin ftp: legacy FTP origin, which is no longer maintained. When modifying `Origins`, you need to enter the corresponding OriginType. The IPv6 feature is not generally available yet. Please send in a whitelist application to use this feature. Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

OriginType Primary origin server type The following types are supported for input parameters: `domain`: domain name `domainv6`: IPv6 domain name cos: COS origin `ip`: IP address ipv6: origin server list is a single IPv6 address `ip_ipv6`: multiple IPv4 addresses and one IPv6 address `ip_domain`: IP addresses and domain names (only available to beta users) `ip_domainv6`: Multiple IPv4 addresses and one IPv6 domain name `ipv6_domain`: multiple IPv6 addresses and one domain name `ipv6_domainv6`: Multiple IPv6 addresses and one IPv6 domain name `domain_domainv6`: Multiple IPv4 domain names and one IPv6 domain name `ip_ipv6_domain`: multiple IPv4 and IPv6 addresses and one domain name `ip_ipv6_domainv6`: Multiple IPv4 and IPv6 addresses and one IPv6 domain name `ip_domain_domainv6`: Multiple IPv4 addresses and IPv4 domain names and one IPv6 domain name `ipv6_domain_domainv6`: Multiple IPv4 domain names and IPv6 addresses and one IPv6 domain name `ip_ipv6_domain_domainv6`: Multiple IPv4 and IPv6 addresses and IPv4 domain names and one IPv6 domain name The following types of output parameters are added: image: Cloud Infinite origin ftp: legacy FTP origin, which is no longer maintained. When modifying `Origins`, you need to enter the corresponding OriginType. The IPv6 feature is not generally available yet. Please send in a whitelist application to use this feature. Note: this field may return `null`, indicating that no valid values can be obtained.

setOriginType

public void setOriginType(String OriginType)

Set Primary origin server type The following types are supported for input parameters: `domain`: domain name `domainv6`: IPv6 domain name cos: COS origin `ip`: IP address ipv6: origin server list is a single IPv6 address `ip_ipv6`: multiple IPv4 addresses and one IPv6 address `ip_domain`: IP addresses and domain names (only available to beta users) `ip_domainv6`: Multiple IPv4 addresses and one IPv6 domain name `ipv6_domain`: multiple IPv6 addresses and one domain name `ipv6_domainv6`: Multiple IPv6 addresses and one IPv6 domain name `domain_domainv6`: Multiple IPv4 domain names and one IPv6 domain name `ip_ipv6_domain`: multiple IPv4 and IPv6 addresses and one domain name `ip_ipv6_domainv6`: Multiple IPv4 and IPv6 addresses and one IPv6 domain name `ip_domain_domainv6`: Multiple IPv4 addresses and IPv4 domain names and one IPv6 domain name `ipv6_domain_domainv6`: Multiple IPv4 domain names and IPv6 addresses and one IPv6 domain name `ip_ipv6_domain_domainv6`: Multiple IPv4 and IPv6 addresses and IPv4 domain names and one IPv6 domain name The following types of output parameters are added: image: Cloud Infinite origin ftp: legacy FTP origin, which is no longer maintained. When modifying `Origins`, you need to enter the corresponding OriginType. The IPv6 feature is not generally available yet. Please send in a whitelist application to use this feature. Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

OriginType - Primary origin server type The following types are supported for input parameters: `domain`: domain name `domainv6`: IPv6 domain name cos: COS origin `ip`: IP address ipv6: origin server list is a single IPv6 address `ip_ipv6`: multiple IPv4 addresses and one IPv6 address `ip_domain`: IP addresses and domain names (only available to beta users) `ip_domainv6`: Multiple IPv4 addresses and one IPv6 domain name `ipv6_domain`: multiple IPv6 addresses and one domain name `ipv6_domainv6`: Multiple IPv6 addresses and one IPv6 domain name `domain_domainv6`: Multiple IPv4 domain names and one IPv6 domain name `ip_ipv6_domain`: multiple IPv4 and IPv6 addresses and one domain name `ip_ipv6_domainv6`: Multiple IPv4 and IPv6 addresses and one IPv6 domain name `ip_domain_domainv6`: Multiple IPv4 addresses and IPv4 domain names and one IPv6 domain name `ipv6_domain_domainv6`: Multiple IPv4 domain names and IPv6 addresses and one IPv6 domain name `ip_ipv6_domain_domainv6`: Multiple IPv4 and IPv6 addresses and IPv4 domain names and one IPv6 domain name The following types of output parameters are added: image: Cloud Infinite origin ftp: legacy FTP origin, which is no longer maintained. When modifying `Origins`, you need to enter the corresponding OriginType. The IPv6 feature is not generally available yet. Please send in a whitelist application to use this feature. Note: this field may return `null`, indicating that no valid values can be obtained.

getServerName

public String getServerName()

Get It is required when a COS origin or third-party origin is used for acceleration. Host header used when accessing the primary origin server. If it is left empty, the acceleration domain name will be used by default. If a wildcard domain name is accessed, then the sub-domain name during the access will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

ServerName It is required when a COS origin or third-party origin is used for acceleration. Host header used when accessing the primary origin server. If it is left empty, the acceleration domain name will be used by default. If a wildcard domain name is accessed, then the sub-domain name during the access will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

setServerName

public void setServerName(String ServerName)

Set It is required when a COS origin or third-party origin is used for acceleration. Host header used when accessing the primary origin server. If it is left empty, the acceleration domain name will be used by default. If a wildcard domain name is accessed, then the sub-domain name during the access will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

ServerName - It is required when a COS origin or third-party origin is used for acceleration. Host header used when accessing the primary origin server. If it is left empty, the acceleration domain name will be used by default. If a wildcard domain name is accessed, then the sub-domain name during the access will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

getCosPrivateAccess

public String getCosPrivateAccess()

Get When OriginType is COS, you can specify if access to private buckets is allowed. Note: To enable this configuration, you need to first grant CDN access to the private bucket. Values: `on` and `off`. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

CosPrivateAccess When OriginType is COS, you can specify if access to private buckets is allowed. Note: To enable this configuration, you need to first grant CDN access to the private bucket. Values: `on` and `off`. Note: This field may return `null`, indicating that no valid value can be obtained.

setCosPrivateAccess

public void setCosPrivateAccess(String CosPrivateAccess)

Set When OriginType is COS, you can specify if access to private buckets is allowed. Note: To enable this configuration, you need to first grant CDN access to the private bucket. Values: `on` and `off`. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

CosPrivateAccess - When OriginType is COS, you can specify if access to private buckets is allowed. Note: To enable this configuration, you need to first grant CDN access to the private bucket. Values: `on` and `off`. Note: This field may return `null`, indicating that no valid value can be obtained.

getOriginPullProtocol

public String getOriginPullProtocol()

Get Origin-pull protocol configuration http: forced HTTP origin-pull follow: protocol follow origin-pull https: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

OriginPullProtocol Origin-pull protocol configuration http: forced HTTP origin-pull follow: protocol follow origin-pull https: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull. Note: This field may return `null`, indicating that no valid value can be obtained.

setOriginPullProtocol

public void setOriginPullProtocol(String OriginPullProtocol)

Set Origin-pull protocol configuration http: forced HTTP origin-pull follow: protocol follow origin-pull https: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

OriginPullProtocol - Origin-pull protocol configuration http: forced HTTP origin-pull follow: protocol follow origin-pull https: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull. Note: This field may return `null`, indicating that no valid value can be obtained.

getBackupOrigins

public String[] getBackupOrigins()

Get Backup origin server list When modifying the backup origin server, you need to enter the corresponding BackupOriginType. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

BackupOrigins Backup origin server list When modifying the backup origin server, you need to enter the corresponding BackupOriginType. Note: This field may return `null`, indicating that no valid value can be obtained.

setBackupOrigins

public void setBackupOrigins(String[] BackupOrigins)

Set Backup origin server list When modifying the backup origin server, you need to enter the corresponding BackupOriginType. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

BackupOrigins - Backup origin server list When modifying the backup origin server, you need to enter the corresponding BackupOriginType. Note: This field may return `null`, indicating that no valid value can be obtained.

getBackupOriginType

public String getBackupOriginType()

Get Backup origin server type, which supports the following types: `domain`: Domain name `ip`: IP address When modifying BackupOrigins, you need to enter the corresponding BackupOriginType. The following backup origin servers are only available to beta users. Submit an application if you want to become a beta user. `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6`: Multiple IPv4 addresses and one IPv6 address `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6_domain`: Multiple IPv4 and IPv6 addresses and one domain name Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

BackupOriginType Backup origin server type, which supports the following types: `domain`: Domain name `ip`: IP address When modifying BackupOrigins, you need to enter the corresponding BackupOriginType. The following backup origin servers are only available to beta users. Submit an application if you want to become a beta user. `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6`: Multiple IPv4 addresses and one IPv6 address `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6_domain`: Multiple IPv4 and IPv6 addresses and one domain name Note: This field may return `null`, indicating that no valid value can be obtained.

setBackupOriginType

public void setBackupOriginType(String BackupOriginType)

Set Backup origin server type, which supports the following types: `domain`: Domain name `ip`: IP address When modifying BackupOrigins, you need to enter the corresponding BackupOriginType. The following backup origin servers are only available to beta users. Submit an application if you want to become a beta user. `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6`: Multiple IPv4 addresses and one IPv6 address `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6_domain`: Multiple IPv4 and IPv6 addresses and one domain name Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

BackupOriginType - Backup origin server type, which supports the following types: `domain`: Domain name `ip`: IP address When modifying BackupOrigins, you need to enter the corresponding BackupOriginType. The following backup origin servers are only available to beta users. Submit an application if you want to become a beta user. `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6`: Multiple IPv4 addresses and one IPv6 address `ipv6_domain`: Multiple IPv6 addresses and one domain name `ip_ipv6_domain`: Multiple IPv4 and IPv6 addresses and one domain name Note: This field may return `null`, indicating that no valid value can be obtained.

getBackupServerName

public String getBackupServerName()

Get Host header used when accessing the backup origin server. If it is left empty, the `ServerName` of primary origin server will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

BackupServerName Host header used when accessing the backup origin server. If it is left empty, the `ServerName` of primary origin server will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

setBackupServerName

public void setBackupServerName(String BackupServerName)

Set Host header used when accessing the backup origin server. If it is left empty, the `ServerName` of primary origin server will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

BackupServerName - Host header used when accessing the backup origin server. If it is left empty, the `ServerName` of primary origin server will be used by default. Note: This field may return `null`, indicating that no valid value can be obtained.

getBasePath

public String getBasePath()

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

Returns:

BasePath Origin-pull path Note: This field may return `null`, indicating that no valid value can be obtained.

setBasePath

public void setBasePath(String BasePath)

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

Parameters:

BasePath - Origin-pull path Note: This field may return `null`, indicating that no valid value can be obtained.

getPathRules

public PathRule[] getPathRules()

Get Origin-pull path rewriting configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

PathRules Origin-pull path rewriting configuration Note: This field may return `null`, indicating that no valid value can be obtained.

setPathRules

public void setPathRules(PathRule[] PathRules)

Set Origin-pull path rewriting configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

PathRules - Origin-pull path rewriting configuration Note: This field may return `null`, indicating that no valid value can be obtained.

getPathBasedOrigin

public PathBasedOriginRule[] getPathBasedOrigin()

Get Path-based origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

PathBasedOrigin Path-based origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

setPathBasedOrigin

public void setPathBasedOrigin(PathBasedOriginRule[] PathBasedOrigin)

Set Path-based origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

PathBasedOrigin - Path-based origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

getAdvanceHttps

public AdvanceHttps getAdvanceHttps()

Get HTTPS advanced origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

AdvanceHttps HTTPS advanced origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

setAdvanceHttps

public void setAdvanceHttps(AdvanceHttps AdvanceHttps)

Set HTTPS advanced origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

AdvanceHttps - HTTPS advanced origin-pull configuration Note: This field may return `null`, indicating that no valid value can be obtained.

getOriginCompany

public String getOriginCompany()

Get Object storage vendor Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

OriginCompany Object storage vendor Note: This field may return `null`, indicating that no valid value can be obtained.

setOriginCompany

public void setOriginCompany(String OriginCompany)

Set Object storage vendor Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

OriginCompany - Object storage vendor 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