Class: TencentCloud::Apigateway::V20180808::BindSubDomainRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20180808/models.rb

Overview

BindSubDomain请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(serviceid = nil, subdomain = nil, protocol = nil, nettype = nil, isdefaultmapping = nil, netsubdomain = nil, certificateid = nil, pathmappingset = nil, isforcedhttps = nil) ⇒ BindSubDomainRequest

Returns a new instance of BindSubDomainRequest.



1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
# File 'lib/v20180808/models.rb', line 1597

def initialize(serviceid=nil, subdomain=nil, protocol=nil, nettype=nil, isdefaultmapping=nil, netsubdomain=nil, certificateid=nil, pathmappingset=nil, isforcedhttps=nil)
  @ServiceId = serviceid
  @SubDomain = subdomain
  @Protocol = protocol
  @NetType = nettype
  @IsDefaultMapping = isdefaultmapping
  @NetSubDomain = netsubdomain
  @CertificateId = certificateid
  @PathMappingSet = pathmappingset
  @IsForcedHttps = isforcedhttps
end

Instance Attribute Details

#CertificateIdObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def CertificateId
  @CertificateId
end

#IsDefaultMappingObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def IsDefaultMapping
  @IsDefaultMapping
end

#IsForcedHttpsObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def IsForcedHttps
  @IsForcedHttps
end

#NetSubDomainObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def NetSubDomain
  @NetSubDomain
end

#NetTypeObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def NetType
  @NetType
end

#PathMappingSetObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def PathMappingSet
  @PathMappingSet
end

#ProtocolObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def Protocol
  @Protocol
end

#ServiceIdObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def ServiceId
  @ServiceId
end

#SubDomainObject

Parameters:

  • ServiceId:

    服务唯一 ID。

  • SubDomain:

    待绑定的自定义的域名。

  • Protocol:

    服务支持协议,可选值为http、https、http&https。

  • NetType:

    网络类型,可选值为OUTER、INNER。

  • IsDefaultMapping:

    是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。

  • NetSubDomain:

    默认域名。

  • CertificateId:

    待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。

  • PathMappingSet:

    自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。

  • IsForcedHttps:

    是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。



1595
1596
1597
# File 'lib/v20180808/models.rb', line 1595

def SubDomain
  @SubDomain
end

Instance Method Details

#deserialize(params) ⇒ Object



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/v20180808/models.rb', line 1609

def deserialize(params)
  @ServiceId = params['ServiceId']
  @SubDomain = params['SubDomain']
  @Protocol = params['Protocol']
  @NetType = params['NetType']
  @IsDefaultMapping = params['IsDefaultMapping']
  @NetSubDomain = params['NetSubDomain']
  @CertificateId = params['CertificateId']
  unless params['PathMappingSet'].nil?
    @PathMappingSet = []
    params['PathMappingSet'].each do |i|
      pathmapping_tmp = PathMapping.new
      pathmapping_tmp.deserialize(i)
      @PathMappingSet << pathmapping_tmp
    end
  end
  @IsForcedHttps = params['IsForcedHttps']
end