CreateApiRequest (tencentcloud-sdk-java 3.1.100 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.apigateway.v20180808.models.CreateApiRequest

public class CreateApiRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description

CreateApiRequest()

Constructors
Constructor and Description
`CreateApiRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApiBusinessType()` Get 当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
`String`	`getApiDesc()` Get 用户自定义的 API 接口描述。
`String`	`getApiName()` Get 用户自定义的 API 名称。
`String`	`getApiType()` Get API 类型，支持NORMAL（普通API）和TSF（微服务API），默认为NORMAL。
`String`	`getAuthRelationApiId()` Get 关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
`String`	`getAuthType()` Get API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。默认为NONE。
`ConstantParameter[]`	`getConstantParameters()` Get 常量参数。
`Boolean`	`getEnableCORS()` Get 是否开启跨域。
`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。
`ApiRequestConfig`	`getRequestConfig()` Get 请求的前端配置。
`RequestParameter[]`	`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时生效。
`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时生效。
`String`	`getTargetNamespaceId()` Get tsf serverless 命名空间ID。（内测中）
`TargetServicesReq[]`	`getTargetServices()` Get target类型后端资源信息。（内测阶段）
`HealthCheckConf`	`getTargetServicesHealthCheckConf()` Get target健康检查配置。（内测阶段）
`Long`	`getTargetServicesLoadBalanceConf()` Get target类型负载均衡配置。（内测阶段）
`String`	`getUserType()` Get 用户类型。
`void`	`setApiBusinessType(String ApiBusinessType)` Set 当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
`void`	`setApiDesc(String ApiDesc)` Set 用户自定义的 API 接口描述。
`void`	`setApiName(String ApiName)` Set 用户自定义的 API 名称。
`void`	`setApiType(String ApiType)` Set API 类型，支持NORMAL（普通API）和TSF（微服务API），默认为NORMAL。
`void`	`setAuthRelationApiId(String AuthRelationApiId)` Set 关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
`void`	`setAuthType(String AuthType)` Set API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。默认为NONE。
`void`	`setConstantParameters(ConstantParameter[] ConstantParameters)` Set 常量参数。
`void`	`setEnableCORS(Boolean EnableCORS)` Set 是否开启跨域。
`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(ApiRequestConfig RequestConfig)` Set 请求的前端配置。
`void`	`setRequestParameters(RequestParameter[] 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`	`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`	`setTargetNamespaceId(String TargetNamespaceId)` Set tsf serverless 命名空间ID。（内测中）
`void`	`setTargetServices(TargetServicesReq[] TargetServices)` Set target类型后端资源信息。（内测阶段）
`void`	`setTargetServicesHealthCheckConf(HealthCheckConf TargetServicesHealthCheckConf)` Set target健康检查配置。（内测阶段）
`void`	`setTargetServicesLoadBalanceConf(Long TargetServicesLoadBalanceConf)` Set target类型负载均衡配置。（内测阶段）
`void`	`setUserType(String UserType)` Set 用户类型。
`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
  - CreateApiRequest
```
public CreateApiRequest()
```
- 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（内测）。
  - 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。
  - getRequestConfig
```
public ApiRequestConfig getRequestConfig()
```
    Get 请求的前端配置。
    
    Returns:
    
    RequestConfig 请求的前端配置。
  - setRequestConfig
```
public void setRequestConfig(ApiRequestConfig RequestConfig)
```
    Set 请求的前端配置。
    
    Parameters:
    
    RequestConfig - 请求的前端配置。
  - 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（普通API）和TSF（微服务API），默认为NORMAL。
    
    Returns:
    
    ApiType API 类型，支持NORMAL（普通API）和TSF（微服务API），默认为NORMAL。
  - setApiType
```
public void setApiType(String ApiType)
```
    Set API 类型，支持NORMAL（普通API）和TSF（微服务API），默认为NORMAL。
    
    Parameters:
    
    ApiType - API 类型，支持NORMAL（普通API）和TSF（微服务API），默认为NORMAL。
  - getAuthType
```
public String getAuthType()
```
    Get API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。默认为NONE。
    
    Returns:
    
    AuthType API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。默认为NONE。
  - setAuthType
```
public void setAuthType(String AuthType)
```
    Set API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。默认为NONE。
    
    Parameters:
    
    AuthType - API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。默认为NONE。
  - getEnableCORS
```
public Boolean getEnableCORS()
```
    Get 是否开启跨域。
    
    Returns:
    
    EnableCORS 是否开启跨域。
  - setEnableCORS
```
public void setEnableCORS(Boolean EnableCORS)
```
    Set 是否开启跨域。
    
    Parameters:
    
    EnableCORS - 是否开启跨域。
  - getConstantParameters
```
public ConstantParameter[] getConstantParameters()
```
    Get 常量参数。
    
    Returns:
    
    ConstantParameters 常量参数。
  - setConstantParameters
```
public void setConstantParameters(ConstantParameter[] ConstantParameters)
```
    Set 常量参数。
    
    Parameters:
    
    ConstantParameters - 常量参数。
  - getRequestParameters
```
public RequestParameter[] getRequestParameters()
```
    Get 前端请求参数。
    
    Returns:
    
    RequestParameters 前端请求参数。
  - setRequestParameters
```
public void setRequestParameters(RequestParameter[] 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 - 微服务的健康检查配置。
  - getTargetServices
```
public TargetServicesReq[] getTargetServices()
```
    Get target类型后端资源信息。（内测阶段）
    
    Returns:
    
    TargetServices target类型后端资源信息。（内测阶段）
  - setTargetServices
```
public void setTargetServices(TargetServicesReq[] TargetServices)
```
    Set target类型后端资源信息。（内测阶段）
    
    Parameters:
    
    TargetServices - target类型后端资源信息。（内测阶段）
  - 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 - 开始调试后计费。（云市场预留字段）
  - 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 - 用户自定义错误码配置。
  - getTargetNamespaceId
```
public String getTargetNamespaceId()
```
    Get tsf serverless 命名空间ID。（内测中）
    
    Returns:
    
    TargetNamespaceId tsf serverless 命名空间ID。（内测中）
  - setTargetNamespaceId
```
public void setTargetNamespaceId(String TargetNamespaceId)
```
    Set tsf serverless 命名空间ID。（内测中）
    
    Parameters:
    
    TargetNamespaceId - tsf serverless 命名空间ID。（内测中）
  - getUserType
```
public String getUserType()
```
    Get 用户类型。
    
    Returns:
    
    UserType 用户类型。
  - setUserType
```
public void setUserType(String UserType)
```
    Set 用户类型。
    
    Parameters:
    
    UserType - 用户类型。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class CreateApiRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateApiRequest

Method Detail

getServiceId

setServiceId

getServiceType

setServiceType

getServiceTimeout

setServiceTimeout

getProtocol

setProtocol

getRequestConfig

setRequestConfig

getApiName

setApiName

getApiDesc

setApiDesc

getApiType

setApiType

getAuthType

setAuthType

getEnableCORS

setEnableCORS

getConstantParameters

setConstantParameters

getRequestParameters

setRequestParameters

getApiBusinessType

setApiBusinessType

getServiceMockReturnMessage

setServiceMockReturnMessage

getMicroServices

setMicroServices

getServiceTsfLoadBalanceConf

setServiceTsfLoadBalanceConf

getServiceTsfHealthCheckConf

setServiceTsfHealthCheckConf

getTargetServices

setTargetServices

getTargetServicesLoadBalanceConf

setTargetServicesLoadBalanceConf

getTargetServicesHealthCheckConf

setTargetServicesHealthCheckConf

getServiceScfFunctionName

setServiceScfFunctionName

getServiceWebsocketRegisterFunctionName

setServiceWebsocketRegisterFunctionName

getServiceWebsocketCleanupFunctionName

setServiceWebsocketCleanupFunctionName

getServiceWebsocketTransportFunctionName

setServiceWebsocketTransportFunctionName

getServiceScfFunctionNamespace

setServiceScfFunctionNamespace

getServiceScfFunctionQualifier

setServiceScfFunctionQualifier

getServiceWebsocketRegisterFunctionNamespace

setServiceWebsocketRegisterFunctionNamespace

getServiceWebsocketRegisterFunctionQualifier

setServiceWebsocketRegisterFunctionQualifier

getServiceWebsocketTransportFunctionNamespace

setServiceWebsocketTransportFunctionNamespace

getServiceWebsocketTransportFunctionQualifier

setServiceWebsocketTransportFunctionQualifier

getServiceWebsocketCleanupFunctionNamespace

setServiceWebsocketCleanupFunctionNamespace

getServiceWebsocketCleanupFunctionQualifier

setServiceWebsocketCleanupFunctionQualifier

getServiceScfIsIntegratedResponse

setServiceScfIsIntegratedResponse

getIsDebugAfterCharge

setIsDebugAfterCharge

getIsDeleteResponseErrorCodes

setIsDeleteResponseErrorCodes

getResponseType

setResponseType