Class ModifyApiRequest
- java.lang.Object
-
- com.tencentcloudapi.common.AbstractModel
-
- com.tencentcloudapi.apigateway.v20180808.models.ModifyApiRequest
-
public class ModifyApiRequest extends AbstractModel
-
-
Field Summary
-
Fields inherited from class com.tencentcloudapi.common.AbstractModel
header, skipSign
-
-
Constructor Summary
Constructors Constructor Description ModifyApiRequest()
ModifyApiRequest(ModifyApiRequest 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getApiBusinessType()
Get 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。String
getApiDesc()
Get 用户自定义的 API 接口描述。String
getApiId()
Get API 接口唯一 ID。String
getApiName()
Get 用户自定义的 API 名称。String
getApiType()
Get API 类型,支持NORMAL和TSF,默认为NORMAL。String
getAuthRelationApiId()
Get 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。Boolean
getAuthRequired()
Get 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。String
getAuthType()
Get API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。Base64EncodedTriggerRule[]
getBase64EncodedTriggerRules()
Get Header触发规则,总规则数不能超过10。ConstantParameter[]
getConstantParameters()
Get 常量参数。String
getEIAMAppId()
Get EIAM应用Token 有效时间,单位为秒,默认为7200秒。String
getEIAMAppType()
Get EIAM应用类型。String
getEIAMAuthType()
Get EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。Boolean
getEnableCORS()
Get 是否需要开启跨域,Ture 表示需要,False 表示不需要。String
getEventBusId()
Get 事件总线ID。Boolean
getIsBase64Encoded()
Get 是否开启Base64编码,只有后端为scf时才会生效。Boolean
getIsBase64Trigger()
Get 是否开启Base64编码的header触发,只有后端为scf时才会生效。Boolean
getIsDebugAfterCharge()
Get 开始调试后计费。(云市场预留字段)Boolean
getIsDeleteResponseErrorCodes()
Get 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。MicroServiceReq[]
getMicroServices()
Get API绑定微服务列表。OauthConfig
getOauthConfig()
Get oauth配置。当AuthType是OAUTH时生效。String
getProtocol()
Get API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。RequestConfig
getRequestConfig()
Get 请求的前端配置。ReqParameter[]
getRequestParameters()
Get 前端请求参数。ResponseErrorCodeReq[]
getResponseErrorCodes()
Get 用户自定义错误码配置。String
getResponseFailExample()
Get 自定义响应配置失败响应示例。String
getResponseSuccessExample()
Get 自定义响应配置成功响应示例。String
getResponseType()
Get 返回类型。ServiceConfig
getServiceConfig()
Get API 的后端服务配置。String
getServiceId()
Get API 所在的服务唯一 ID。String
getServiceMockReturnMessage()
Get API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。ServiceParameter[]
getServiceParameters()
Get API的后端服务参数。String
getServiceScfFunctionName()
Get scf 函数名称。当后端类型是SCF时生效。String
getServiceScfFunctionNamespace()
Get scf 函数命名空间。当后端类型是SCF时生效。String
getServiceScfFunctionQualifier()
Get scf函数版本。当后端类型是SCF时生效。String
getServiceScfFunctionType()
Get scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。Boolean
getServiceScfIsIntegratedResponse()
Get 是否开启响应集成。当后端类型是SCF时生效。Long
getServiceTimeout()
Get API 的后端服务超时时间,单位是秒。HealthCheckConf
getServiceTsfHealthCheckConf()
Get 微服务的健康检查配置。TsfLoadBalanceConfResp
getServiceTsfLoadBalanceConf()
Get 微服务的负载均衡配置。String
getServiceType()
Get API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。String
getServiceWebsocketCleanupFunctionName()
Get scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketCleanupFunctionNamespace()
Get scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketCleanupFunctionQualifier()
Get scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketRegisterFunctionName()
Get scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketRegisterFunctionNamespace()
Get scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketRegisterFunctionQualifier()
Get scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketTransportFunctionName()
Get scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketTransportFunctionNamespace()
Get scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。String
getServiceWebsocketTransportFunctionQualifier()
Get scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。Tag
getTagSpecifications()
Get 标签。HealthCheckConf
getTargetServicesHealthCheckConf()
Get target健康检查配置。(内测阶段)Long
getTargetServicesLoadBalanceConf()
Get target类型负载均衡配置。(内测阶段)Long
getTokenTimeout()
Get EIAM应用ID。void
setApiBusinessType(String ApiBusinessType)
Set 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。void
setApiDesc(String ApiDesc)
Set 用户自定义的 API 接口描述。void
setApiId(String ApiId)
Set API 接口唯一 ID。void
setApiName(String ApiName)
Set 用户自定义的 API 名称。void
setApiType(String ApiType)
Set API 类型,支持NORMAL和TSF,默认为NORMAL。void
setAuthRelationApiId(String AuthRelationApiId)
Set 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。void
setAuthRequired(Boolean AuthRequired)
Set 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。void
setAuthType(String AuthType)
Set API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。void
setBase64EncodedTriggerRules(Base64EncodedTriggerRule[] Base64EncodedTriggerRules)
Set Header触发规则,总规则数不能超过10。void
setConstantParameters(ConstantParameter[] ConstantParameters)
Set 常量参数。void
setEIAMAppId(String EIAMAppId)
Set EIAM应用Token 有效时间,单位为秒,默认为7200秒。void
setEIAMAppType(String EIAMAppType)
Set EIAM应用类型。void
setEIAMAuthType(String EIAMAuthType)
Set EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。void
setEnableCORS(Boolean EnableCORS)
Set 是否需要开启跨域,Ture 表示需要,False 表示不需要。void
setEventBusId(String EventBusId)
Set 事件总线ID。void
setIsBase64Encoded(Boolean IsBase64Encoded)
Set 是否开启Base64编码,只有后端为scf时才会生效。void
setIsBase64Trigger(Boolean IsBase64Trigger)
Set 是否开启Base64编码的header触发,只有后端为scf时才会生效。void
setIsDebugAfterCharge(Boolean IsDebugAfterCharge)
Set 开始调试后计费。(云市场预留字段)void
setIsDeleteResponseErrorCodes(Boolean IsDeleteResponseErrorCodes)
Set 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。void
setMicroServices(MicroServiceReq[] MicroServices)
Set API绑定微服务列表。void
setOauthConfig(OauthConfig OauthConfig)
Set oauth配置。当AuthType是OAUTH时生效。void
setProtocol(String Protocol)
Set API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。void
setRequestConfig(RequestConfig RequestConfig)
Set 请求的前端配置。void
setRequestParameters(ReqParameter[] RequestParameters)
Set 前端请求参数。void
setResponseErrorCodes(ResponseErrorCodeReq[] ResponseErrorCodes)
Set 用户自定义错误码配置。void
setResponseFailExample(String ResponseFailExample)
Set 自定义响应配置失败响应示例。void
setResponseSuccessExample(String ResponseSuccessExample)
Set 自定义响应配置成功响应示例。void
setResponseType(String ResponseType)
Set 返回类型。void
setServiceConfig(ServiceConfig ServiceConfig)
Set API 的后端服务配置。void
setServiceId(String ServiceId)
Set API 所在的服务唯一 ID。void
setServiceMockReturnMessage(String ServiceMockReturnMessage)
Set API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。void
setServiceParameters(ServiceParameter[] ServiceParameters)
Set API的后端服务参数。void
setServiceScfFunctionName(String ServiceScfFunctionName)
Set scf 函数名称。当后端类型是SCF时生效。void
setServiceScfFunctionNamespace(String ServiceScfFunctionNamespace)
Set scf 函数命名空间。当后端类型是SCF时生效。void
setServiceScfFunctionQualifier(String ServiceScfFunctionQualifier)
Set scf函数版本。当后端类型是SCF时生效。void
setServiceScfFunctionType(String ServiceScfFunctionType)
Set scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。void
setServiceScfIsIntegratedResponse(Boolean ServiceScfIsIntegratedResponse)
Set 是否开启响应集成。当后端类型是SCF时生效。void
setServiceTimeout(Long ServiceTimeout)
Set API 的后端服务超时时间,单位是秒。void
setServiceTsfHealthCheckConf(HealthCheckConf ServiceTsfHealthCheckConf)
Set 微服务的健康检查配置。void
setServiceTsfLoadBalanceConf(TsfLoadBalanceConfResp ServiceTsfLoadBalanceConf)
Set 微服务的负载均衡配置。void
setServiceType(String ServiceType)
Set API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。void
setServiceWebsocketCleanupFunctionName(String ServiceWebsocketCleanupFunctionName)
Set scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketCleanupFunctionNamespace(String ServiceWebsocketCleanupFunctionNamespace)
Set scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketCleanupFunctionQualifier(String ServiceWebsocketCleanupFunctionQualifier)
Set scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketRegisterFunctionName(String ServiceWebsocketRegisterFunctionName)
Set scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketRegisterFunctionNamespace(String ServiceWebsocketRegisterFunctionNamespace)
Set scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketRegisterFunctionQualifier(String ServiceWebsocketRegisterFunctionQualifier)
Set scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketTransportFunctionName(String ServiceWebsocketTransportFunctionName)
Set scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketTransportFunctionNamespace(String ServiceWebsocketTransportFunctionNamespace)
Set scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setServiceWebsocketTransportFunctionQualifier(String ServiceWebsocketTransportFunctionQualifier)
Set scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。void
setTagSpecifications(Tag TagSpecifications)
Set 标签。void
setTargetServicesHealthCheckConf(HealthCheckConf TargetServicesHealthCheckConf)
Set target健康检查配置。(内测阶段)void
setTargetServicesLoadBalanceConf(Long TargetServicesLoadBalanceConf)
Set target类型负载均衡配置。(内测阶段)void
setTokenTimeout(Long TokenTimeout)
Set EIAM应用ID。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, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
-
-
-
-
Constructor Detail
-
ModifyApiRequest
public ModifyApiRequest()
-
ModifyApiRequest
public ModifyApiRequest(ModifyApiRequest 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 API 所在的服务唯一 ID。- Returns:
- ServiceId API 所在的服务唯一 ID。
-
setServiceId
public void setServiceId(String ServiceId)
Set API 所在的服务唯一 ID。- Parameters:
ServiceId
- API 所在的服务唯一 ID。
-
getServiceType
public String getServiceType()
Get API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。- Returns:
- ServiceType API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
-
setServiceType
public void setServiceType(String ServiceType)
Set API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。- Parameters:
ServiceType
- API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
-
getRequestConfig
public RequestConfig getRequestConfig()
Get 请求的前端配置。- Returns:
- RequestConfig 请求的前端配置。
-
setRequestConfig
public void setRequestConfig(RequestConfig RequestConfig)
Set 请求的前端配置。- Parameters:
RequestConfig
- 请求的前端配置。
-
getApiId
public String getApiId()
Get API 接口唯一 ID。- Returns:
- ApiId API 接口唯一 ID。
-
setApiId
public void setApiId(String ApiId)
Set API 接口唯一 ID。- Parameters:
ApiId
- API 接口唯一 ID。
-
getApiName
public String getApiName()
Get 用户自定义的 API 名称。- Returns:
- ApiName 用户自定义的 API 名称。
-
setApiName
public void setApiName(String ApiName)
Set 用户自定义的 API 名称。- Parameters:
ApiName
- 用户自定义的 API 名称。
-
getApiDesc
public String getApiDesc()
Get 用户自定义的 API 接口描述。- Returns:
- ApiDesc 用户自定义的 API 接口描述。
-
setApiDesc
public void setApiDesc(String ApiDesc)
Set 用户自定义的 API 接口描述。- Parameters:
ApiDesc
- 用户自定义的 API 接口描述。
-
getApiType
public String getApiType()
Get API 类型,支持NORMAL和TSF,默认为NORMAL。- Returns:
- ApiType API 类型,支持NORMAL和TSF,默认为NORMAL。
-
setApiType
public void setApiType(String ApiType)
Set API 类型,支持NORMAL和TSF,默认为NORMAL。- Parameters:
ApiType
- API 类型,支持NORMAL和TSF,默认为NORMAL。
-
getAuthType
public String getAuthType()
Get API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。- Returns:
- AuthType API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
-
setAuthType
public void setAuthType(String AuthType)
Set API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。- Parameters:
AuthType
- API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
-
getAuthRequired
public Boolean getAuthRequired()
Get 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。- Returns:
- AuthRequired 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。
-
setAuthRequired
public void setAuthRequired(Boolean AuthRequired)
Set 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。- Parameters:
AuthRequired
- 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。
-
getServiceTimeout
public Long getServiceTimeout()
Get API 的后端服务超时时间,单位是秒。- Returns:
- ServiceTimeout API 的后端服务超时时间,单位是秒。
-
setServiceTimeout
public void setServiceTimeout(Long ServiceTimeout)
Set API 的后端服务超时时间,单位是秒。- Parameters:
ServiceTimeout
- API 的后端服务超时时间,单位是秒。
-
getProtocol
public String getProtocol()
Get API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。- Returns:
- Protocol API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。
-
setProtocol
public void setProtocol(String Protocol)
Set API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。- Parameters:
Protocol
- API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。
-
getEnableCORS
public Boolean getEnableCORS()
Get 是否需要开启跨域,Ture 表示需要,False 表示不需要。- Returns:
- EnableCORS 是否需要开启跨域,Ture 表示需要,False 表示不需要。
-
setEnableCORS
public void setEnableCORS(Boolean EnableCORS)
Set 是否需要开启跨域,Ture 表示需要,False 表示不需要。- Parameters:
EnableCORS
- 是否需要开启跨域,Ture 表示需要,False 表示不需要。
-
getConstantParameters
public ConstantParameter[] getConstantParameters()
Get 常量参数。- Returns:
- ConstantParameters 常量参数。
-
setConstantParameters
public void setConstantParameters(ConstantParameter[] ConstantParameters)
Set 常量参数。- Parameters:
ConstantParameters
- 常量参数。
-
getRequestParameters
public ReqParameter[] getRequestParameters()
Get 前端请求参数。- Returns:
- RequestParameters 前端请求参数。
-
setRequestParameters
public void setRequestParameters(ReqParameter[] RequestParameters)
Set 前端请求参数。- Parameters:
RequestParameters
- 前端请求参数。
-
getApiBusinessType
public String getApiBusinessType()
Get 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。- Returns:
- ApiBusinessType 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。
-
setApiBusinessType
public void setApiBusinessType(String ApiBusinessType)
Set 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。- Parameters:
ApiBusinessType
- 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。
-
getServiceMockReturnMessage
public String getServiceMockReturnMessage()
Get API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。- Returns:
- ServiceMockReturnMessage API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
-
setServiceMockReturnMessage
public void setServiceMockReturnMessage(String ServiceMockReturnMessage)
Set API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。- Parameters:
ServiceMockReturnMessage
- API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
-
getMicroServices
public MicroServiceReq[] getMicroServices()
Get API绑定微服务列表。- Returns:
- MicroServices API绑定微服务列表。
-
setMicroServices
public void setMicroServices(MicroServiceReq[] MicroServices)
Set API绑定微服务列表。- Parameters:
MicroServices
- API绑定微服务列表。
-
getServiceTsfLoadBalanceConf
public TsfLoadBalanceConfResp getServiceTsfLoadBalanceConf()
Get 微服务的负载均衡配置。- Returns:
- ServiceTsfLoadBalanceConf 微服务的负载均衡配置。
-
setServiceTsfLoadBalanceConf
public void setServiceTsfLoadBalanceConf(TsfLoadBalanceConfResp ServiceTsfLoadBalanceConf)
Set 微服务的负载均衡配置。- Parameters:
ServiceTsfLoadBalanceConf
- 微服务的负载均衡配置。
-
getServiceTsfHealthCheckConf
public HealthCheckConf getServiceTsfHealthCheckConf()
Get 微服务的健康检查配置。- Returns:
- ServiceTsfHealthCheckConf 微服务的健康检查配置。
-
setServiceTsfHealthCheckConf
public void setServiceTsfHealthCheckConf(HealthCheckConf ServiceTsfHealthCheckConf)
Set 微服务的健康检查配置。- Parameters:
ServiceTsfHealthCheckConf
- 微服务的健康检查配置。
-
getTargetServicesLoadBalanceConf
public Long getTargetServicesLoadBalanceConf()
Get target类型负载均衡配置。(内测阶段)- Returns:
- TargetServicesLoadBalanceConf target类型负载均衡配置。(内测阶段)
-
setTargetServicesLoadBalanceConf
public void setTargetServicesLoadBalanceConf(Long TargetServicesLoadBalanceConf)
Set target类型负载均衡配置。(内测阶段)- Parameters:
TargetServicesLoadBalanceConf
- target类型负载均衡配置。(内测阶段)
-
getTargetServicesHealthCheckConf
public HealthCheckConf getTargetServicesHealthCheckConf()
Get target健康检查配置。(内测阶段)- Returns:
- TargetServicesHealthCheckConf target健康检查配置。(内测阶段)
-
setTargetServicesHealthCheckConf
public void setTargetServicesHealthCheckConf(HealthCheckConf TargetServicesHealthCheckConf)
Set target健康检查配置。(内测阶段)- Parameters:
TargetServicesHealthCheckConf
- target健康检查配置。(内测阶段)
-
getServiceScfFunctionName
public String getServiceScfFunctionName()
Get scf 函数名称。当后端类型是SCF时生效。- Returns:
- ServiceScfFunctionName scf 函数名称。当后端类型是SCF时生效。
-
setServiceScfFunctionName
public void setServiceScfFunctionName(String ServiceScfFunctionName)
Set scf 函数名称。当后端类型是SCF时生效。- Parameters:
ServiceScfFunctionName
- scf 函数名称。当后端类型是SCF时生效。
-
getServiceWebsocketRegisterFunctionName
public String getServiceWebsocketRegisterFunctionName()
Get scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketRegisterFunctionName scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketRegisterFunctionName
public void setServiceWebsocketRegisterFunctionName(String ServiceWebsocketRegisterFunctionName)
Set scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketRegisterFunctionName
- scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceWebsocketCleanupFunctionName
public String getServiceWebsocketCleanupFunctionName()
Get scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketCleanupFunctionName scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketCleanupFunctionName
public void setServiceWebsocketCleanupFunctionName(String ServiceWebsocketCleanupFunctionName)
Set scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketCleanupFunctionName
- scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceWebsocketTransportFunctionName
public String getServiceWebsocketTransportFunctionName()
Get scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketTransportFunctionName scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketTransportFunctionName
public void setServiceWebsocketTransportFunctionName(String ServiceWebsocketTransportFunctionName)
Set scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketTransportFunctionName
- scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceScfFunctionNamespace
public String getServiceScfFunctionNamespace()
Get scf 函数命名空间。当后端类型是SCF时生效。- Returns:
- ServiceScfFunctionNamespace scf 函数命名空间。当后端类型是SCF时生效。
-
setServiceScfFunctionNamespace
public void setServiceScfFunctionNamespace(String ServiceScfFunctionNamespace)
Set scf 函数命名空间。当后端类型是SCF时生效。- Parameters:
ServiceScfFunctionNamespace
- scf 函数命名空间。当后端类型是SCF时生效。
-
getServiceScfFunctionQualifier
public String getServiceScfFunctionQualifier()
Get scf函数版本。当后端类型是SCF时生效。- Returns:
- ServiceScfFunctionQualifier scf函数版本。当后端类型是SCF时生效。
-
setServiceScfFunctionQualifier
public void setServiceScfFunctionQualifier(String ServiceScfFunctionQualifier)
Set scf函数版本。当后端类型是SCF时生效。- Parameters:
ServiceScfFunctionQualifier
- scf函数版本。当后端类型是SCF时生效。
-
getServiceWebsocketRegisterFunctionNamespace
public String getServiceWebsocketRegisterFunctionNamespace()
Get scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketRegisterFunctionNamespace scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketRegisterFunctionNamespace
public void setServiceWebsocketRegisterFunctionNamespace(String ServiceWebsocketRegisterFunctionNamespace)
Set scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketRegisterFunctionNamespace
- scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceWebsocketRegisterFunctionQualifier
public String getServiceWebsocketRegisterFunctionQualifier()
Get scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketRegisterFunctionQualifier scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketRegisterFunctionQualifier
public void setServiceWebsocketRegisterFunctionQualifier(String ServiceWebsocketRegisterFunctionQualifier)
Set scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketRegisterFunctionQualifier
- scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceWebsocketTransportFunctionNamespace
public String getServiceWebsocketTransportFunctionNamespace()
Get scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketTransportFunctionNamespace scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketTransportFunctionNamespace
public void setServiceWebsocketTransportFunctionNamespace(String ServiceWebsocketTransportFunctionNamespace)
Set scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketTransportFunctionNamespace
- scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceWebsocketTransportFunctionQualifier
public String getServiceWebsocketTransportFunctionQualifier()
Get scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketTransportFunctionQualifier scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketTransportFunctionQualifier
public void setServiceWebsocketTransportFunctionQualifier(String ServiceWebsocketTransportFunctionQualifier)
Set scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketTransportFunctionQualifier
- scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceWebsocketCleanupFunctionNamespace
public String getServiceWebsocketCleanupFunctionNamespace()
Get scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketCleanupFunctionNamespace scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketCleanupFunctionNamespace
public void setServiceWebsocketCleanupFunctionNamespace(String ServiceWebsocketCleanupFunctionNamespace)
Set scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketCleanupFunctionNamespace
- scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceWebsocketCleanupFunctionQualifier
public String getServiceWebsocketCleanupFunctionQualifier()
Get scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Returns:
- ServiceWebsocketCleanupFunctionQualifier scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
setServiceWebsocketCleanupFunctionQualifier
public void setServiceWebsocketCleanupFunctionQualifier(String ServiceWebsocketCleanupFunctionQualifier)
Set scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。- Parameters:
ServiceWebsocketCleanupFunctionQualifier
- scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
-
getServiceScfIsIntegratedResponse
public Boolean getServiceScfIsIntegratedResponse()
Get 是否开启响应集成。当后端类型是SCF时生效。- Returns:
- ServiceScfIsIntegratedResponse 是否开启响应集成。当后端类型是SCF时生效。
-
setServiceScfIsIntegratedResponse
public void setServiceScfIsIntegratedResponse(Boolean ServiceScfIsIntegratedResponse)
Set 是否开启响应集成。当后端类型是SCF时生效。- Parameters:
ServiceScfIsIntegratedResponse
- 是否开启响应集成。当后端类型是SCF时生效。
-
getIsDebugAfterCharge
public Boolean getIsDebugAfterCharge()
Get 开始调试后计费。(云市场预留字段)- Returns:
- IsDebugAfterCharge 开始调试后计费。(云市场预留字段)
-
setIsDebugAfterCharge
public void setIsDebugAfterCharge(Boolean IsDebugAfterCharge)
Set 开始调试后计费。(云市场预留字段)- Parameters:
IsDebugAfterCharge
- 开始调试后计费。(云市场预留字段)
-
getTagSpecifications
public Tag getTagSpecifications()
Get 标签。- Returns:
- TagSpecifications 标签。
-
setTagSpecifications
public void setTagSpecifications(Tag TagSpecifications)
Set 标签。- Parameters:
TagSpecifications
- 标签。
-
getIsDeleteResponseErrorCodes
public Boolean getIsDeleteResponseErrorCodes()
Get 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。- Returns:
- IsDeleteResponseErrorCodes 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
-
setIsDeleteResponseErrorCodes
public void setIsDeleteResponseErrorCodes(Boolean IsDeleteResponseErrorCodes)
Set 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。- Parameters:
IsDeleteResponseErrorCodes
- 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
-
getResponseType
public String getResponseType()
Get 返回类型。- Returns:
- ResponseType 返回类型。
-
setResponseType
public void setResponseType(String ResponseType)
Set 返回类型。- Parameters:
ResponseType
- 返回类型。
-
getResponseSuccessExample
public String getResponseSuccessExample()
Get 自定义响应配置成功响应示例。- Returns:
- ResponseSuccessExample 自定义响应配置成功响应示例。
-
setResponseSuccessExample
public void setResponseSuccessExample(String ResponseSuccessExample)
Set 自定义响应配置成功响应示例。- Parameters:
ResponseSuccessExample
- 自定义响应配置成功响应示例。
-
getResponseFailExample
public String getResponseFailExample()
Get 自定义响应配置失败响应示例。- Returns:
- ResponseFailExample 自定义响应配置失败响应示例。
-
setResponseFailExample
public void setResponseFailExample(String ResponseFailExample)
Set 自定义响应配置失败响应示例。- Parameters:
ResponseFailExample
- 自定义响应配置失败响应示例。
-
getServiceConfig
public ServiceConfig getServiceConfig()
Get API 的后端服务配置。- Returns:
- ServiceConfig API 的后端服务配置。
-
setServiceConfig
public void setServiceConfig(ServiceConfig ServiceConfig)
Set API 的后端服务配置。- Parameters:
ServiceConfig
- API 的后端服务配置。
-
getAuthRelationApiId
public String getAuthRelationApiId()
Get 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。- Returns:
- AuthRelationApiId 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
-
setAuthRelationApiId
public void setAuthRelationApiId(String AuthRelationApiId)
Set 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。- Parameters:
AuthRelationApiId
- 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
-
getServiceParameters
public ServiceParameter[] getServiceParameters()
Get API的后端服务参数。- Returns:
- ServiceParameters API的后端服务参数。
-
setServiceParameters
public void setServiceParameters(ServiceParameter[] ServiceParameters)
Set API的后端服务参数。- Parameters:
ServiceParameters
- API的后端服务参数。
-
getOauthConfig
public OauthConfig getOauthConfig()
Get oauth配置。当AuthType是OAUTH时生效。- Returns:
- OauthConfig oauth配置。当AuthType是OAUTH时生效。
-
setOauthConfig
public void setOauthConfig(OauthConfig OauthConfig)
Set oauth配置。当AuthType是OAUTH时生效。- Parameters:
OauthConfig
- oauth配置。当AuthType是OAUTH时生效。
-
getResponseErrorCodes
public ResponseErrorCodeReq[] getResponseErrorCodes()
Get 用户自定义错误码配置。- Returns:
- ResponseErrorCodes 用户自定义错误码配置。
-
setResponseErrorCodes
public void setResponseErrorCodes(ResponseErrorCodeReq[] ResponseErrorCodes)
Set 用户自定义错误码配置。- Parameters:
ResponseErrorCodes
- 用户自定义错误码配置。
-
getIsBase64Encoded
public Boolean getIsBase64Encoded()
Get 是否开启Base64编码,只有后端为scf时才会生效。- Returns:
- IsBase64Encoded 是否开启Base64编码,只有后端为scf时才会生效。
-
setIsBase64Encoded
public void setIsBase64Encoded(Boolean IsBase64Encoded)
Set 是否开启Base64编码,只有后端为scf时才会生效。- Parameters:
IsBase64Encoded
- 是否开启Base64编码,只有后端为scf时才会生效。
-
getIsBase64Trigger
public Boolean getIsBase64Trigger()
Get 是否开启Base64编码的header触发,只有后端为scf时才会生效。- Returns:
- IsBase64Trigger 是否开启Base64编码的header触发,只有后端为scf时才会生效。
-
setIsBase64Trigger
public void setIsBase64Trigger(Boolean IsBase64Trigger)
Set 是否开启Base64编码的header触发,只有后端为scf时才会生效。- Parameters:
IsBase64Trigger
- 是否开启Base64编码的header触发,只有后端为scf时才会生效。
-
getBase64EncodedTriggerRules
public Base64EncodedTriggerRule[] getBase64EncodedTriggerRules()
Get Header触发规则,总规则数不能超过10。- Returns:
- Base64EncodedTriggerRules Header触发规则,总规则数不能超过10。
-
setBase64EncodedTriggerRules
public void setBase64EncodedTriggerRules(Base64EncodedTriggerRule[] Base64EncodedTriggerRules)
Set Header触发规则,总规则数不能超过10。- Parameters:
Base64EncodedTriggerRules
- Header触发规则,总规则数不能超过10。
-
getEventBusId
public String getEventBusId()
Get 事件总线ID。- Returns:
- EventBusId 事件总线ID。
-
setEventBusId
public void setEventBusId(String EventBusId)
Set 事件总线ID。- Parameters:
EventBusId
- 事件总线ID。
-
getServiceScfFunctionType
public String getServiceScfFunctionType()
Get scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。- Returns:
- ServiceScfFunctionType scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。
-
setServiceScfFunctionType
public void setServiceScfFunctionType(String ServiceScfFunctionType)
Set scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。- Parameters:
ServiceScfFunctionType
- scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。
-
getEIAMAppType
public String getEIAMAppType()
Get EIAM应用类型。- Returns:
- EIAMAppType EIAM应用类型。
-
setEIAMAppType
public void setEIAMAppType(String EIAMAppType)
Set EIAM应用类型。- Parameters:
EIAMAppType
- EIAM应用类型。
-
getEIAMAuthType
public String getEIAMAuthType()
Get EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。- Returns:
- EIAMAuthType EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。
-
setEIAMAuthType
public void setEIAMAuthType(String EIAMAuthType)
Set EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。- Parameters:
EIAMAuthType
- EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。
-
getEIAMAppId
public String getEIAMAppId()
Get EIAM应用Token 有效时间,单位为秒,默认为7200秒。- Returns:
- EIAMAppId EIAM应用Token 有效时间,单位为秒,默认为7200秒。
-
setEIAMAppId
public void setEIAMAppId(String EIAMAppId)
Set EIAM应用Token 有效时间,单位为秒,默认为7200秒。- Parameters:
EIAMAppId
- EIAM应用Token 有效时间,单位为秒,默认为7200秒。
-
getTokenTimeout
public Long getTokenTimeout()
Get EIAM应用ID。- Returns:
- TokenTimeout EIAM应用ID。
-
setTokenTimeout
public void setTokenTimeout(Long TokenTimeout)
Set EIAM应用ID。- Parameters:
TokenTimeout
- EIAM应用ID。
-
-