CreateApiRequest (tencentcloud-sdk-java-intl-en 3.0.63 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 This field is valid if `AuthType` is `OAUTH`.
`String`	`getApiDesc()` Get Custom API description.
`String`	`getApiName()` Get Custom API name.
`String`	`getApiType()` Get API type.
`String`	`getAuthRelationApiId()` Get Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`.
`String`	`getAuthType()` Get API authentication type.
`ConstantParameter[]`	`getConstantParameters()` Get Constant parameter.
`Boolean`	`getEnableCORS()` Get Whether to enable CORS.
`Boolean`	`getIsDebugAfterCharge()` Get Billing after debugging starts (reserved field for marketplace).
`Boolean`	`getIsDeleteResponseErrorCodes()` Get Whether to delete the error codes for custom response configuration.
`MicroServiceReq[]`	`getMicroServices()` Get List of microservices bound to API.
`OauthConfig`	`getOauthConfig()` Get OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
`String`	`getProtocol()` Get API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
`ApiRequestConfig`	`getRequestConfig()` Get Request frontend configuration.
`RequestParameter[]`	`getRequestParameters()` Get Frontend request parameter.
`ResponseErrorCodeReq[]`	`getResponseErrorCodes()` Get Custom error code configuration.
`String`	`getResponseFailExample()` Get Sample response for failed custom response configuration.
`String`	`getResponseSuccessExample()` Get Sample response for successful custom response configuration.
`String`	`getResponseType()` Get Return type.
`ServiceConfig`	`getServiceConfig()` Get API backend service configuration.
`String`	`getServiceId()` Get Unique service ID of API.
`String`	`getServiceMockReturnMessage()` Get Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
`ServiceParameter[]`	`getServiceParameters()` Get API backend service parameter.
`String`	`getServiceScfFunctionName()` Get SCF function name, which takes effect if the backend type is `SCF`.
`String`	`getServiceScfFunctionNamespace()` Get SCF function namespace, which takes effect if the backend type is `SCF`.
`String`	`getServiceScfFunctionQualifier()` Get SCF function version, which takes effect if the backend type is `SCF`.
`Boolean`	`getServiceScfIsIntegratedResponse()` Get Whether to enable response integration, which takes effect if the backend type is `SCF`.
`Long`	`getServiceTimeout()` Get API backend service timeout period in seconds.
`HealthCheckConf`	`getServiceTsfHealthCheckConf()` Get Health check configuration of microservice.
`TsfLoadBalanceConfResp`	`getServiceTsfLoadBalanceConf()` Get Load balancing configuration of microservice.
`String`	`getServiceType()` Get API backend service type.
`String`	`getServiceWebsocketCleanupFunctionName()` Get SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketCleanupFunctionNamespace()` Get SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketCleanupFunctionQualifier()` Get SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketRegisterFunctionName()` Get SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketRegisterFunctionNamespace()` Get SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketRegisterFunctionQualifier()` Get SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketTransportFunctionName()` Get SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketTransportFunctionNamespace()` Get SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getServiceWebsocketTransportFunctionQualifier()` Get SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`String`	`getTargetNamespaceId()` Get TSF Serverless namespace ID (in beta test).
`TargetServicesReq[]`	`getTargetServices()` Get `target` type backend resource information (in beta test).
`HealthCheckConf`	`getTargetServicesHealthCheckConf()` Get `target` health check configuration (in beta test).
`Long`	`getTargetServicesLoadBalanceConf()` Get `target` type load balancing configuration (in beta test).
`String`	`getUserType()` Get User type.
`void`	`setApiBusinessType(String ApiBusinessType)` Set This field is valid if `AuthType` is `OAUTH`.
`void`	`setApiDesc(String ApiDesc)` Set Custom API description.
`void`	`setApiName(String ApiName)` Set Custom API name.
`void`	`setApiType(String ApiType)` Set API type.
`void`	`setAuthRelationApiId(String AuthRelationApiId)` Set Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`.
`void`	`setAuthType(String AuthType)` Set API authentication type.
`void`	`setConstantParameters(ConstantParameter[] ConstantParameters)` Set Constant parameter.
`void`	`setEnableCORS(Boolean EnableCORS)` Set Whether to enable CORS.
`void`	`setIsDebugAfterCharge(Boolean IsDebugAfterCharge)` Set Billing after debugging starts (reserved field for marketplace).
`void`	`setIsDeleteResponseErrorCodes(Boolean IsDeleteResponseErrorCodes)` Set Whether to delete the error codes for custom response configuration.
`void`	`setMicroServices(MicroServiceReq[] MicroServices)` Set List of microservices bound to API.
`void`	`setOauthConfig(OauthConfig OauthConfig)` Set OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
`void`	`setProtocol(String Protocol)` Set API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
`void`	`setRequestConfig(ApiRequestConfig RequestConfig)` Set Request frontend configuration.
`void`	`setRequestParameters(RequestParameter[] RequestParameters)` Set Frontend request parameter.
`void`	`setResponseErrorCodes(ResponseErrorCodeReq[] ResponseErrorCodes)` Set Custom error code configuration.
`void`	`setResponseFailExample(String ResponseFailExample)` Set Sample response for failed custom response configuration.
`void`	`setResponseSuccessExample(String ResponseSuccessExample)` Set Sample response for successful custom response configuration.
`void`	`setResponseType(String ResponseType)` Set Return type.
`void`	`setServiceConfig(ServiceConfig ServiceConfig)` Set API backend service configuration.
`void`	`setServiceId(String ServiceId)` Set Unique service ID of API.
`void`	`setServiceMockReturnMessage(String ServiceMockReturnMessage)` Set Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
`void`	`setServiceParameters(ServiceParameter[] ServiceParameters)` Set API backend service parameter.
`void`	`setServiceScfFunctionName(String ServiceScfFunctionName)` Set SCF function name, which takes effect if the backend type is `SCF`.
`void`	`setServiceScfFunctionNamespace(String ServiceScfFunctionNamespace)` Set SCF function namespace, which takes effect if the backend type is `SCF`.
`void`	`setServiceScfFunctionQualifier(String ServiceScfFunctionQualifier)` Set SCF function version, which takes effect if the backend type is `SCF`.
`void`	`setServiceScfIsIntegratedResponse(Boolean ServiceScfIsIntegratedResponse)` Set Whether to enable response integration, which takes effect if the backend type is `SCF`.
`void`	`setServiceTimeout(Long ServiceTimeout)` Set API backend service timeout period in seconds.
`void`	`setServiceTsfHealthCheckConf(HealthCheckConf ServiceTsfHealthCheckConf)` Set Health check configuration of microservice.
`void`	`setServiceTsfLoadBalanceConf(TsfLoadBalanceConfResp ServiceTsfLoadBalanceConf)` Set Load balancing configuration of microservice.
`void`	`setServiceType(String ServiceType)` Set API backend service type.
`void`	`setServiceWebsocketCleanupFunctionName(String ServiceWebsocketCleanupFunctionName)` Set SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketCleanupFunctionNamespace(String ServiceWebsocketCleanupFunctionNamespace)` Set SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketCleanupFunctionQualifier(String ServiceWebsocketCleanupFunctionQualifier)` Set SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketRegisterFunctionName(String ServiceWebsocketRegisterFunctionName)` Set SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketRegisterFunctionNamespace(String ServiceWebsocketRegisterFunctionNamespace)` Set SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketRegisterFunctionQualifier(String ServiceWebsocketRegisterFunctionQualifier)` Set SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketTransportFunctionName(String ServiceWebsocketTransportFunctionName)` Set SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketTransportFunctionNamespace(String ServiceWebsocketTransportFunctionNamespace)` Set SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setServiceWebsocketTransportFunctionQualifier(String ServiceWebsocketTransportFunctionQualifier)` Set SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
`void`	`setTargetNamespaceId(String TargetNamespaceId)` Set TSF Serverless namespace ID (in beta test).
`void`	`setTargetServices(TargetServicesReq[] TargetServices)` Set `target` type backend resource information (in beta test).
`void`	`setTargetServicesHealthCheckConf(HealthCheckConf TargetServicesHealthCheckConf)` Set `target` health check configuration (in beta test).
`void`	`setTargetServicesLoadBalanceConf(Long TargetServicesLoadBalanceConf)` Set `target` type load balancing configuration (in beta test).
`void`	`setUserType(String UserType)` Set User type.
`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 Unique service ID of API.
    
    Returns:
    
    ServiceId Unique service ID of API.
  - setServiceId
```
public void setServiceId(String ServiceId)
```
    Set Unique service ID of API.
    
    Parameters:
    
    ServiceId - Unique service ID of API.
  - getServiceType
```
public String getServiceType()
```
    Get API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
    
    Returns:
    
    ServiceType API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
  - setServiceType
```
public void setServiceType(String ServiceType)
```
    Set API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
    
    Parameters:
    
    ServiceType - API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
  - getServiceTimeout
```
public Long getServiceTimeout()
```
    Get API backend service timeout period in seconds.
    
    Returns:
    
    ServiceTimeout API backend service timeout period in seconds.
  - setServiceTimeout
```
public void setServiceTimeout(Long ServiceTimeout)
```
    Set API backend service timeout period in seconds.
    
    Parameters:
    
    ServiceTimeout - API backend service timeout period in seconds.
  - getProtocol
```
public String getProtocol()
```
    Get API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
    
    Returns:
    
    Protocol API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
  - setProtocol
```
public void setProtocol(String Protocol)
```
    Set API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
    
    Parameters:
    
    Protocol - API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
  - getRequestConfig
```
public ApiRequestConfig getRequestConfig()
```
    Get Request frontend configuration.
    
    Returns:
    
    RequestConfig Request frontend configuration.
  - setRequestConfig
```
public void setRequestConfig(ApiRequestConfig RequestConfig)
```
    Set Request frontend configuration.
    
    Parameters:
    
    RequestConfig - Request frontend configuration.
  - getApiName
```
public String getApiName()
```
    Get Custom API name.
    
    Returns:
    
    ApiName Custom API name.
  - setApiName
```
public void setApiName(String ApiName)
```
    Set Custom API name.
    
    Parameters:
    
    ApiName - Custom API name.
  - getApiDesc
```
public String getApiDesc()
```
    Get Custom API description.
    
    Returns:
    
    ApiDesc Custom API description.
  - setApiDesc
```
public void setApiDesc(String ApiDesc)
```
    Set Custom API description.
    
    Parameters:
    
    ApiDesc - Custom API description.
  - getApiType
```
public String getApiType()
```
    Get API type. Valid values: NORMAL (general API), TSF (microservice API). Default value: NORMAL.
    
    Returns:
    
    ApiType API type. Valid values: NORMAL (general API), TSF (microservice API). Default value: NORMAL.
  - setApiType
```
public void setApiType(String ApiType)
```
    Set API type. Valid values: NORMAL (general API), TSF (microservice API). Default value: NORMAL.
    
    Parameters:
    
    ApiType - API type. Valid values: NORMAL (general API), TSF (microservice API). Default value: NORMAL.
  - getAuthType
```
public String getAuthType()
```
    Get API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Default value: NONE.
    
    Returns:
    
    AuthType API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Default value: NONE.
  - setAuthType
```
public void setAuthType(String AuthType)
```
    Set API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Default value: NONE.
    
    Parameters:
    
    AuthType - API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Default value: NONE.
  - getEnableCORS
```
public Boolean getEnableCORS()
```
    Get Whether to enable CORS.
    
    Returns:
    
    EnableCORS Whether to enable CORS.
  - setEnableCORS
```
public void setEnableCORS(Boolean EnableCORS)
```
    Set Whether to enable CORS.
    
    Parameters:
    
    EnableCORS - Whether to enable CORS.
  - getConstantParameters
```
public ConstantParameter[] getConstantParameters()
```
    Get Constant parameter.
    
    Returns:
    
    ConstantParameters Constant parameter.
  - setConstantParameters
```
public void setConstantParameters(ConstantParameter[] ConstantParameters)
```
    Set Constant parameter.
    
    Parameters:
    
    ConstantParameters - Constant parameter.
  - getRequestParameters
```
public RequestParameter[] getRequestParameters()
```
    Get Frontend request parameter.
    
    Returns:
    
    RequestParameters Frontend request parameter.
  - setRequestParameters
```
public void setRequestParameters(RequestParameter[] RequestParameters)
```
    Set Frontend request parameter.
    
    Parameters:
    
    RequestParameters - Frontend request parameter.
  - getApiBusinessType
```
public String getApiBusinessType()
```
    Get This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API.
    
    Returns:
    
    ApiBusinessType This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API.
  - setApiBusinessType
```
public void setApiBusinessType(String ApiBusinessType)
```
    Set This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API.
    
    Parameters:
    
    ApiBusinessType - This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API.
  - getServiceMockReturnMessage
```
public String getServiceMockReturnMessage()
```
    Get Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
    
    Returns:
    
    ServiceMockReturnMessage Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
  - setServiceMockReturnMessage
```
public void setServiceMockReturnMessage(String ServiceMockReturnMessage)
```
    Set Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
    
    Parameters:
    
    ServiceMockReturnMessage - Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
  - getMicroServices
```
public MicroServiceReq[] getMicroServices()
```
    Get List of microservices bound to API.
    
    Returns:
    
    MicroServices List of microservices bound to API.
  - setMicroServices
```
public void setMicroServices(MicroServiceReq[] MicroServices)
```
    Set List of microservices bound to API.
    
    Parameters:
    
    MicroServices - List of microservices bound to API.
  - getServiceTsfLoadBalanceConf
```
public TsfLoadBalanceConfResp getServiceTsfLoadBalanceConf()
```
    Get Load balancing configuration of microservice.
    
    Returns:
    
    ServiceTsfLoadBalanceConf Load balancing configuration of microservice.
  - setServiceTsfLoadBalanceConf
```
public void setServiceTsfLoadBalanceConf(TsfLoadBalanceConfResp ServiceTsfLoadBalanceConf)
```
    Set Load balancing configuration of microservice.
    
    Parameters:
    
    ServiceTsfLoadBalanceConf - Load balancing configuration of microservice.
  - getServiceTsfHealthCheckConf
```
public HealthCheckConf getServiceTsfHealthCheckConf()
```
    Get Health check configuration of microservice.
    
    Returns:
    
    ServiceTsfHealthCheckConf Health check configuration of microservice.
  - setServiceTsfHealthCheckConf
```
public void setServiceTsfHealthCheckConf(HealthCheckConf ServiceTsfHealthCheckConf)
```
    Set Health check configuration of microservice.
    
    Parameters:
    
    ServiceTsfHealthCheckConf - Health check configuration of microservice.
  - getTargetServices
```
public TargetServicesReq[] getTargetServices()
```
    Get `target` type backend resource information (in beta test).
    
    Returns:
    
    TargetServices `target` type backend resource information (in beta test).
  - setTargetServices
```
public void setTargetServices(TargetServicesReq[] TargetServices)
```
    Set `target` type backend resource information (in beta test).
    
    Parameters:
    
    TargetServices - `target` type backend resource information (in beta test).
  - getTargetServicesLoadBalanceConf
```
public Long getTargetServicesLoadBalanceConf()
```
    Get `target` type load balancing configuration (in beta test).
    
    Returns:
    
    TargetServicesLoadBalanceConf `target` type load balancing configuration (in beta test).
  - setTargetServicesLoadBalanceConf
```
public void setTargetServicesLoadBalanceConf(Long TargetServicesLoadBalanceConf)
```
    Set `target` type load balancing configuration (in beta test).
    
    Parameters:
    
    TargetServicesLoadBalanceConf - `target` type load balancing configuration (in beta test).
  - getTargetServicesHealthCheckConf
```
public HealthCheckConf getTargetServicesHealthCheckConf()
```
    Get `target` health check configuration (in beta test).
    
    Returns:
    
    TargetServicesHealthCheckConf `target` health check configuration (in beta test).
  - setTargetServicesHealthCheckConf
```
public void setTargetServicesHealthCheckConf(HealthCheckConf TargetServicesHealthCheckConf)
```
    Set `target` health check configuration (in beta test).
    
    Parameters:
    
    TargetServicesHealthCheckConf - `target` health check configuration (in beta test).
  - getServiceScfFunctionName
```
public String getServiceScfFunctionName()
```
    Get SCF function name, which takes effect if the backend type is `SCF`.
    
    Returns:
    
    ServiceScfFunctionName SCF function name, which takes effect if the backend type is `SCF`.
  - setServiceScfFunctionName
```
public void setServiceScfFunctionName(String ServiceScfFunctionName)
```
    Set SCF function name, which takes effect if the backend type is `SCF`.
    
    Parameters:
    
    ServiceScfFunctionName - SCF function name, which takes effect if the backend type is `SCF`.
  - getServiceWebsocketRegisterFunctionName
```
public String getServiceWebsocketRegisterFunctionName()
```
    Get SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketRegisterFunctionName SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketRegisterFunctionName
```
public void setServiceWebsocketRegisterFunctionName(String ServiceWebsocketRegisterFunctionName)
```
    Set SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketRegisterFunctionName - SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceWebsocketCleanupFunctionName
```
public String getServiceWebsocketCleanupFunctionName()
```
    Get SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketCleanupFunctionName SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketCleanupFunctionName
```
public void setServiceWebsocketCleanupFunctionName(String ServiceWebsocketCleanupFunctionName)
```
    Set SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketCleanupFunctionName - SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceWebsocketTransportFunctionName
```
public String getServiceWebsocketTransportFunctionName()
```
    Get SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketTransportFunctionName SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketTransportFunctionName
```
public void setServiceWebsocketTransportFunctionName(String ServiceWebsocketTransportFunctionName)
```
    Set SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketTransportFunctionName - SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceScfFunctionNamespace
```
public String getServiceScfFunctionNamespace()
```
    Get SCF function namespace, which takes effect if the backend type is `SCF`.
    
    Returns:
    
    ServiceScfFunctionNamespace SCF function namespace, which takes effect if the backend type is `SCF`.
  - setServiceScfFunctionNamespace
```
public void setServiceScfFunctionNamespace(String ServiceScfFunctionNamespace)
```
    Set SCF function namespace, which takes effect if the backend type is `SCF`.
    
    Parameters:
    
    ServiceScfFunctionNamespace - SCF function namespace, which takes effect if the backend type is `SCF`.
  - getServiceScfFunctionQualifier
```
public String getServiceScfFunctionQualifier()
```
    Get SCF function version, which takes effect if the backend type is `SCF`.
    
    Returns:
    
    ServiceScfFunctionQualifier SCF function version, which takes effect if the backend type is `SCF`.
  - setServiceScfFunctionQualifier
```
public void setServiceScfFunctionQualifier(String ServiceScfFunctionQualifier)
```
    Set SCF function version, which takes effect if the backend type is `SCF`.
    
    Parameters:
    
    ServiceScfFunctionQualifier - SCF function version, which takes effect if the backend type is `SCF`.
  - getServiceWebsocketRegisterFunctionNamespace
```
public String getServiceWebsocketRegisterFunctionNamespace()
```
    Get SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketRegisterFunctionNamespace SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketRegisterFunctionNamespace
```
public void setServiceWebsocketRegisterFunctionNamespace(String ServiceWebsocketRegisterFunctionNamespace)
```
    Set SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketRegisterFunctionNamespace - SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceWebsocketRegisterFunctionQualifier
```
public String getServiceWebsocketRegisterFunctionQualifier()
```
    Get SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketRegisterFunctionQualifier SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketRegisterFunctionQualifier
```
public void setServiceWebsocketRegisterFunctionQualifier(String ServiceWebsocketRegisterFunctionQualifier)
```
    Set SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketRegisterFunctionQualifier - SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceWebsocketTransportFunctionNamespace
```
public String getServiceWebsocketTransportFunctionNamespace()
```
    Get SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketTransportFunctionNamespace SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketTransportFunctionNamespace
```
public void setServiceWebsocketTransportFunctionNamespace(String ServiceWebsocketTransportFunctionNamespace)
```
    Set SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketTransportFunctionNamespace - SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceWebsocketTransportFunctionQualifier
```
public String getServiceWebsocketTransportFunctionQualifier()
```
    Get SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketTransportFunctionQualifier SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketTransportFunctionQualifier
```
public void setServiceWebsocketTransportFunctionQualifier(String ServiceWebsocketTransportFunctionQualifier)
```
    Set SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketTransportFunctionQualifier - SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceWebsocketCleanupFunctionNamespace
```
public String getServiceWebsocketCleanupFunctionNamespace()
```
    Get SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketCleanupFunctionNamespace SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketCleanupFunctionNamespace
```
public void setServiceWebsocketCleanupFunctionNamespace(String ServiceWebsocketCleanupFunctionNamespace)
```
    Set SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketCleanupFunctionNamespace - SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceWebsocketCleanupFunctionQualifier
```
public String getServiceWebsocketCleanupFunctionQualifier()
```
    Get SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Returns:
    
    ServiceWebsocketCleanupFunctionQualifier SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - setServiceWebsocketCleanupFunctionQualifier
```
public void setServiceWebsocketCleanupFunctionQualifier(String ServiceWebsocketCleanupFunctionQualifier)
```
    Set SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
    
    Parameters:
    
    ServiceWebsocketCleanupFunctionQualifier - SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
  - getServiceScfIsIntegratedResponse
```
public Boolean getServiceScfIsIntegratedResponse()
```
    Get Whether to enable response integration, which takes effect if the backend type is `SCF`.
    
    Returns:
    
    ServiceScfIsIntegratedResponse Whether to enable response integration, which takes effect if the backend type is `SCF`.
  - setServiceScfIsIntegratedResponse
```
public void setServiceScfIsIntegratedResponse(Boolean ServiceScfIsIntegratedResponse)
```
    Set Whether to enable response integration, which takes effect if the backend type is `SCF`.
    
    Parameters:
    
    ServiceScfIsIntegratedResponse - Whether to enable response integration, which takes effect if the backend type is `SCF`.
  - getIsDebugAfterCharge
```
public Boolean getIsDebugAfterCharge()
```
    Get Billing after debugging starts (reserved field for marketplace).
    
    Returns:
    
    IsDebugAfterCharge Billing after debugging starts (reserved field for marketplace).
  - setIsDebugAfterCharge
```
public void setIsDebugAfterCharge(Boolean IsDebugAfterCharge)
```
    Set Billing after debugging starts (reserved field for marketplace).
    
    Parameters:
    
    IsDebugAfterCharge - Billing after debugging starts (reserved field for marketplace).
  - getIsDeleteResponseErrorCodes
```
public Boolean getIsDeleteResponseErrorCodes()
```
    Get Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted.
    
    Returns:
    
    IsDeleteResponseErrorCodes Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted.
  - setIsDeleteResponseErrorCodes
```
public void setIsDeleteResponseErrorCodes(Boolean IsDeleteResponseErrorCodes)
```
    Set Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted.
    
    Parameters:
    
    IsDeleteResponseErrorCodes - Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted.
  - getResponseType
```
public String getResponseType()
```
    Get Return type.
    
    Returns:
    
    ResponseType Return type.
  - setResponseType
```
public void setResponseType(String ResponseType)
```
    Set Return type.
    
    Parameters:
    
    ResponseType - Return type.
  - getResponseSuccessExample
```
public String getResponseSuccessExample()
```
    Get Sample response for successful custom response configuration.
    
    Returns:
    
    ResponseSuccessExample Sample response for successful custom response configuration.
  - setResponseSuccessExample
```
public void setResponseSuccessExample(String ResponseSuccessExample)
```
    Set Sample response for successful custom response configuration.
    
    Parameters:
    
    ResponseSuccessExample - Sample response for successful custom response configuration.
  - getResponseFailExample
```
public String getResponseFailExample()
```
    Get Sample response for failed custom response configuration.
    
    Returns:
    
    ResponseFailExample Sample response for failed custom response configuration.
  - setResponseFailExample
```
public void setResponseFailExample(String ResponseFailExample)
```
    Set Sample response for failed custom response configuration.
    
    Parameters:
    
    ResponseFailExample - Sample response for failed custom response configuration.
  - getServiceConfig
```
public ServiceConfig getServiceConfig()
```
    Get API backend service configuration.
    
    Returns:
    
    ServiceConfig API backend service configuration.
  - setServiceConfig
```
public void setServiceConfig(ServiceConfig ServiceConfig)
```
    Set API backend service configuration.
    
    Parameters:
    
    ServiceConfig - API backend service configuration.
  - getAuthRelationApiId
```
public String getAuthRelationApiId()
```
    Get Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
    
    Returns:
    
    AuthRelationApiId Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
  - setAuthRelationApiId
```
public void setAuthRelationApiId(String AuthRelationApiId)
```
    Set Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
    
    Parameters:
    
    AuthRelationApiId - Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
  - getServiceParameters
```
public ServiceParameter[] getServiceParameters()
```
    Get API backend service parameter.
    
    Returns:
    
    ServiceParameters API backend service parameter.
  - setServiceParameters
```
public void setServiceParameters(ServiceParameter[] ServiceParameters)
```
    Set API backend service parameter.
    
    Parameters:
    
    ServiceParameters - API backend service parameter.
  - getOauthConfig
```
public OauthConfig getOauthConfig()
```
    Get OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
    
    Returns:
    
    OauthConfig OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
  - setOauthConfig
```
public void setOauthConfig(OauthConfig OauthConfig)
```
    Set OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
    
    Parameters:
    
    OauthConfig - OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
  - getResponseErrorCodes
```
public ResponseErrorCodeReq[] getResponseErrorCodes()
```
    Get Custom error code configuration.
    
    Returns:
    
    ResponseErrorCodes Custom error code configuration.
  - setResponseErrorCodes
```
public void setResponseErrorCodes(ResponseErrorCodeReq[] ResponseErrorCodes)
```
    Set Custom error code configuration.
    
    Parameters:
    
    ResponseErrorCodes - Custom error code configuration.
  - getTargetNamespaceId
```
public String getTargetNamespaceId()
```
    Get TSF Serverless namespace ID (in beta test).
    
    Returns:
    
    TargetNamespaceId TSF Serverless namespace ID (in beta test).
  - setTargetNamespaceId
```
public void setTargetNamespaceId(String TargetNamespaceId)
```
    Set TSF Serverless namespace ID (in beta test).
    
    Parameters:
    
    TargetNamespaceId - TSF Serverless namespace ID (in beta test).
  - getUserType
```
public String getUserType()
```
    Get User type.
    
    Returns:
    
    UserType User type.
  - setUserType
```
public void setUserType(String UserType)
```
    Set User type.
    
    Parameters:
    
    UserType - User type.
  - 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