com.tencentcloudapi.apigateway.v20180808.models

Class BindSubDomainRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.apigateway.v20180808.models.BindSubDomainRequest

public class BindSubDomainRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
BindSubDomainRequest()
BindSubDomainRequest(BindSubDomainRequest 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	getCertificateId() Get Unique certificate ID of the custom domain name to be bound.
Boolean	getIsDefaultMapping() Get Whether the default path mapping is used.
Boolean	getIsForcedHttps() Get Whether to force HTTP requests to redirect to HTTPS.
String	getNetSubDomain() Get Default domain name.
String	getNetType() Get Network type.
PathMapping[]	getPathMappingSet() Get Custom domain name path mapping.
String	getProtocol() Get Protocol supported by service.
String	getServiceId() Get Unique service ID.
String	getSubDomain() Get Custom domain name to be bound.
void	setCertificateId(String CertificateId) Set Unique certificate ID of the custom domain name to be bound.
void	setIsDefaultMapping(Boolean IsDefaultMapping) Set Whether the default path mapping is used.
void	setIsForcedHttps(Boolean IsForcedHttps) Set Whether to force HTTP requests to redirect to HTTPS.
void	setNetSubDomain(String NetSubDomain) Set Default domain name.
void	setNetType(String NetType) Set Network type.
void	setPathMappingSet(PathMapping[] PathMappingSet) Set Custom domain name path mapping.
void	setProtocol(String Protocol) Set Protocol supported by service.
void	setServiceId(String ServiceId) Set Unique service ID.
void	setSubDomain(String SubDomain) Set Custom domain name to be bound.
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

BindSubDomainRequest

public BindSubDomainRequest()

BindSubDomainRequest

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

getServiceId

public String getServiceId()

Get Unique service ID.

Returns:

ServiceId Unique service ID.

setServiceId

public void setServiceId(String ServiceId)

Set Unique service ID.

Parameters:

ServiceId - Unique service ID.

getSubDomain

public String getSubDomain()

Get Custom domain name to be bound.

Returns:

SubDomain Custom domain name to be bound.

setSubDomain

public void setSubDomain(String SubDomain)

Set Custom domain name to be bound.

Parameters:

SubDomain - Custom domain name to be bound.

getProtocol

public String getProtocol()

Get Protocol supported by service. Valid values: http, https, http&https.

Returns:

Protocol Protocol supported by service. Valid values: http, https, http&https.

setProtocol

public void setProtocol(String Protocol)

Set Protocol supported by service. Valid values: http, https, http&https.

Parameters:

Protocol - Protocol supported by service. Valid values: http, https, http&https.

getNetType

public String getNetType()

Get Network type. Valid values: OUTER, INNER.

Returns:

NetType Network type. Valid values: OUTER, INNER.

setNetType

public void setNetType(String NetType)

Set Network type. Valid values: OUTER, INNER.

Parameters:

NetType - Network type. Valid values: OUTER, INNER.

getIsDefaultMapping

public Boolean getIsDefaultMapping()

Get Whether the default path mapping is used. The default value is `true`. If the value is `false`, the custom path mapping will be used and `PathMappingSet` will be required in this case.

Returns:

IsDefaultMapping Whether the default path mapping is used. The default value is `true`. If the value is `false`, the custom path mapping will be used and `PathMappingSet` will be required in this case.

setIsDefaultMapping

public void setIsDefaultMapping(Boolean IsDefaultMapping)

Set Whether the default path mapping is used. The default value is `true`. If the value is `false`, the custom path mapping will be used and `PathMappingSet` will be required in this case.

Parameters:

IsDefaultMapping - Whether the default path mapping is used. The default value is `true`. If the value is `false`, the custom path mapping will be used and `PathMappingSet` will be required in this case.

getNetSubDomain

public String getNetSubDomain()

Get Default domain name.

Returns:

NetSubDomain Default domain name.

setNetSubDomain

public void setNetSubDomain(String NetSubDomain)

Set Default domain name.

Parameters:

NetSubDomain - Default domain name.

getCertificateId

public String getCertificateId()

Get Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if `Protocol` is `https` or `http&https`.

Returns:

CertificateId Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if `Protocol` is `https` or `http&https`.

setCertificateId

public void setCertificateId(String CertificateId)

Set Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if `Protocol` is `https` or `http&https`.

Parameters:

CertificateId - Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if `Protocol` is `https` or `http&https`.

getPathMappingSet

public PathMapping[] getPathMappingSet()

Get Custom domain name path mapping. It can contain up to 3 `Environment` values which can be set to only `test`, `prepub`, and `release`, respectively.

Returns:

PathMappingSet Custom domain name path mapping. It can contain up to 3 `Environment` values which can be set to only `test`, `prepub`, and `release`, respectively.

setPathMappingSet

public void setPathMappingSet(PathMapping[] PathMappingSet)

Set Custom domain name path mapping. It can contain up to 3 `Environment` values which can be set to only `test`, `prepub`, and `release`, respectively.

Parameters:

PathMappingSet - Custom domain name path mapping. It can contain up to 3 `Environment` values which can be set to only `test`, `prepub`, and `release`, respectively.

getIsForcedHttps

public Boolean getIsForcedHttps()

Get Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.

Returns:

IsForcedHttps Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.

setIsForcedHttps

public void setIsForcedHttps(Boolean IsForcedHttps)

Set Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.

Parameters:

IsForcedHttps - Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel