com.tencentcloudapi.apigateway.v20180808.models

Class ApiInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.apigateway.v20180808.models.ApiInfo

public class ApiInfo
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ApiInfo()
ApiInfo(ApiInfo source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getApiBusinessType() Get OAuth API type.
String	getApiDesc() Get API description.
String	getApiId() Get Unique API ID.
String	getApiName() Get API name.
String	getApiType() Get API type.
String	getAuthRelationApiId() Get Unique ID of the authorization API associated with OAuth business API.
String	getAuthType() Get API authentication type.
Base64EncodedTriggerRule[]	getBase64EncodedTriggerRules() Get Header trigger rules.
ConstantParameter[]	getConstantParameters() Get Constant parameter.
String	getCreatedTime() Get Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
Boolean	getEnableCORS() Get Whether to enable CORS.
String[]	getEnvironments() Get Environment information published for API.
String	getInternalDomain() Get WebSocket callback address.
Boolean	getIsBase64Encoded() Get Whether to enable Base64 encoding.
Boolean	getIsBase64Trigger() Get Whether to trigger Base64 encoding by header.
Boolean	getIsDebugAfterCharge() Get Whether to enable debugging after purchase (reserved field for the marketplace).
MicroService[]	getMicroServices() Get List of microservices bound to API.
Long[]	getMicroServicesInfo() Get Microservice details.
String	getModifiedTime() Get Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
OauthConfig	getOauthConfig() Get OAuth configuration.
String	getProtocol() Get API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
RequestConfig	getRequestConfig() Get Request frontend configuration.
ReqParameter[]	getRequestParameters() Get Frontend request parameter.
ErrorCodes[]	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	getServiceDesc() Get Service description of API.
String	getServiceId() Get Unique service ID of API.
String	getServiceMockReturnMessage() Get Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
String	getServiceName() Get Service name of API.
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 integrated response is enabled.
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 namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF` Note: this field may return null, indicating that no valid values can be obtained.
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`.
Tag[]	getTags() Get Information of tags bound to API.
void	setApiBusinessType(String ApiBusinessType) Set OAuth API type.
void	setApiDesc(String ApiDesc) Set API description.
void	setApiId(String ApiId) Set Unique API ID.
void	setApiName(String ApiName) Set API name.
void	setApiType(String ApiType) Set API type.
void	setAuthRelationApiId(String AuthRelationApiId) Set Unique ID of the authorization API associated with OAuth business API.
void	setAuthType(String AuthType) Set API authentication type.
void	setBase64EncodedTriggerRules(Base64EncodedTriggerRule[] Base64EncodedTriggerRules) Set Header trigger rules.
void	setConstantParameters(ConstantParameter[] ConstantParameters) Set Constant parameter.
void	setCreatedTime(String CreatedTime) Set Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
void	setEnableCORS(Boolean EnableCORS) Set Whether to enable CORS.
void	setEnvironments(String[] Environments) Set Environment information published for API.
void	setInternalDomain(String InternalDomain) Set WebSocket callback address.
void	setIsBase64Encoded(Boolean IsBase64Encoded) Set Whether to enable Base64 encoding.
void	setIsBase64Trigger(Boolean IsBase64Trigger) Set Whether to trigger Base64 encoding by header.
void	setIsDebugAfterCharge(Boolean IsDebugAfterCharge) Set Whether to enable debugging after purchase (reserved field for the marketplace).
void	setMicroServices(MicroService[] MicroServices) Set List of microservices bound to API.
void	setMicroServicesInfo(Long[] MicroServicesInfo) Set Microservice details.
void	setModifiedTime(String ModifiedTime) Set Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
void	setOauthConfig(OauthConfig OauthConfig) Set OAuth configuration.
void	setProtocol(String Protocol) Set API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
void	setRequestConfig(RequestConfig RequestConfig) Set Request frontend configuration.
void	setRequestParameters(ReqParameter[] RequestParameters) Set Frontend request parameter.
void	setResponseErrorCodes(ErrorCodes[] 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	setServiceDesc(String ServiceDesc) Set Service description of API.
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	setServiceName(String ServiceName) Set Service name of API.
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 integrated response is enabled.
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 namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF` Note: this field may return null, indicating that no valid values can be obtained.
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	setTags(Tag[] Tags) Set Information of tags bound to API.
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

ApiInfo

public ApiInfo()

ApiInfo

public ApiInfo(ApiInfo source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getServiceId

public String getServiceId()

Get Unique service ID of API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceId Unique service ID of API. Note: this field may return null, indicating that no valid values can be obtained.

setServiceId

public void setServiceId(String ServiceId)

Set Unique service ID of API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceId - Unique service ID of API. Note: this field may return null, indicating that no valid values can be obtained.

getServiceName

public String getServiceName()

Get Service name of API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceName Service name of API. Note: this field may return null, indicating that no valid values can be obtained.

setServiceName

public void setServiceName(String ServiceName)

Set Service name of API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceName - Service name of API. Note: this field may return null, indicating that no valid values can be obtained.

getServiceDesc

public String getServiceDesc()

Get Service description of API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceDesc Service description of API. Note: this field may return null, indicating that no valid values can be obtained.

setServiceDesc

public void setServiceDesc(String ServiceDesc)

Set Service description of API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceDesc - Service description of API. Note: this field may return null, indicating that no valid values can be obtained.

getApiId

public String getApiId()

Get Unique API ID. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiId Unique API ID. Note: this field may return null, indicating that no valid values can be obtained.

setApiId

public void setApiId(String ApiId)

Set Unique API ID. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiId - Unique API ID. Note: this field may return null, indicating that no valid values can be obtained.

getApiDesc

public String getApiDesc()

Get API description. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiDesc API description. Note: this field may return null, indicating that no valid values can be obtained.

setApiDesc

public void setApiDesc(String ApiDesc)

Set API description. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiDesc - API description. Note: this field may return null, indicating that no valid values can be obtained.

getCreatedTime

public String getCreatedTime()

Get Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

CreatedTime Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

setCreatedTime

public void setCreatedTime(String CreatedTime)

Set Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

CreatedTime - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

getModifiedTime

public String getModifiedTime()

Get Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ModifiedTime Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

setModifiedTime

public void setModifiedTime(String ModifiedTime)

Set Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ModifiedTime - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

getApiName

public String getApiName()

Get API name. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiName API name. Note: this field may return null, indicating that no valid values can be obtained.

setApiName

public void setApiName(String ApiName)

Set API name. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiName - API name. Note: this field may return null, indicating that no valid values can be obtained.

getApiType

public String getApiType()

Get API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiType API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

setApiType

public void setApiType(String ApiType)

Set API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiType - API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

getProtocol

public String getProtocol()

Get API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Protocol API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS. Note: this field may return null, indicating that no valid values can be obtained.

setProtocol

public void setProtocol(String Protocol)

Set API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Protocol - API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS. Note: this field may return null, indicating that no valid values can be obtained.

getAuthType

public String getAuthType()

Get API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

AuthType API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Note: this field may return null, indicating that no valid values can be obtained.

setAuthType

public void setAuthType(String AuthType)

Set API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

AuthType - API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Note: this field may return null, indicating that no valid values can be obtained.

getApiBusinessType

public String getApiBusinessType()

Get OAuth API type. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiBusinessType OAuth API type. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

setApiBusinessType

public void setApiBusinessType(String ApiBusinessType)

Set OAuth API type. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiBusinessType - OAuth API type. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

getAuthRelationApiId

public String getAuthRelationApiId()

Get Unique ID of the authorization API associated with OAuth business API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

AuthRelationApiId Unique ID of the authorization API associated with OAuth business API. Note: this field may return null, indicating that no valid values can be obtained.

setAuthRelationApiId

public void setAuthRelationApiId(String AuthRelationApiId)

Set Unique ID of the authorization API associated with OAuth business API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

AuthRelationApiId - Unique ID of the authorization API associated with OAuth business API. Note: this field may return null, indicating that no valid values can be obtained.

getOauthConfig

public OauthConfig getOauthConfig()

Get OAuth configuration. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

OauthConfig OAuth configuration. Note: this field may return null, indicating that no valid values can be obtained.

setOauthConfig

public void setOauthConfig(OauthConfig OauthConfig)

Set OAuth configuration. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

OauthConfig - OAuth configuration. Note: this field may return null, indicating that no valid values can be obtained.

getIsDebugAfterCharge

public Boolean getIsDebugAfterCharge()

Get Whether to enable debugging after purchase (reserved field for the marketplace). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

IsDebugAfterCharge Whether to enable debugging after purchase (reserved field for the marketplace). Note: this field may return null, indicating that no valid values can be obtained.

setIsDebugAfterCharge

public void setIsDebugAfterCharge(Boolean IsDebugAfterCharge)

Set Whether to enable debugging after purchase (reserved field for the marketplace). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

IsDebugAfterCharge - Whether to enable debugging after purchase (reserved field for the marketplace). Note: this field may return null, indicating that no valid values can be obtained.

getRequestConfig

public RequestConfig getRequestConfig()

Get Request frontend configuration. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RequestConfig Request frontend configuration. Note: this field may return null, indicating that no valid values can be obtained.

setRequestConfig

public void setRequestConfig(RequestConfig RequestConfig)

Set Request frontend configuration. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RequestConfig - Request frontend configuration. Note: this field may return null, indicating that no valid values can be obtained.

getResponseType

public String getResponseType()

Get Return type. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ResponseType Return type. Note: this field may return null, indicating that no valid values can be obtained.

setResponseType

public void setResponseType(String ResponseType)

Set Return type. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ResponseType - Return type. Note: this field may return null, indicating that no valid values can be obtained.

getResponseSuccessExample

public String getResponseSuccessExample()

Get Sample response for successful custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ResponseSuccessExample Sample response for successful custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

setResponseSuccessExample

public void setResponseSuccessExample(String ResponseSuccessExample)

Set Sample response for successful custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ResponseSuccessExample - Sample response for successful custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

getResponseFailExample

public String getResponseFailExample()

Get Sample response for failed custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ResponseFailExample Sample response for failed custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

setResponseFailExample

public void setResponseFailExample(String ResponseFailExample)

Set Sample response for failed custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ResponseFailExample - Sample response for failed custom response configuration. Note: this field may return null, indicating that no valid values can be obtained.

getResponseErrorCodes

public ErrorCodes[] getResponseErrorCodes()

Get Custom error code configuration. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ResponseErrorCodes Custom error code configuration. Note: this field may return null, indicating that no valid values can be obtained.

setResponseErrorCodes

public void setResponseErrorCodes(ErrorCodes[] ResponseErrorCodes)

Set Custom error code configuration. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ResponseErrorCodes - Custom error code configuration. Note: this field may return null, indicating that no valid values can be obtained.

getRequestParameters

public ReqParameter[] getRequestParameters()

Get Frontend request parameter. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RequestParameters Frontend request parameter. Note: this field may return null, indicating that no valid values can be obtained.

setRequestParameters

public void setRequestParameters(ReqParameter[] RequestParameters)

Set Frontend request parameter. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RequestParameters - Frontend request parameter. Note: this field may return null, indicating that no valid values can be obtained.

getServiceTimeout

public Long getServiceTimeout()

Get API backend service timeout period in seconds. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceTimeout API backend service timeout period in seconds. Note: this field may return null, indicating that no valid values can be obtained.

setServiceTimeout

public void setServiceTimeout(Long ServiceTimeout)

Set API backend service timeout period in seconds. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceTimeout - API backend service timeout period in seconds. Note: this field may return null, indicating that no valid values can be obtained.

getServiceType

public String getServiceType()

Get API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceType API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test). Note: this field may return null, indicating that no valid values can be obtained.

setServiceType

public void setServiceType(String ServiceType)

Set API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceType - API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test). Note: this field may return null, indicating that no valid values can be obtained.

getServiceConfig

public ServiceConfig getServiceConfig()

Get API backend service configuration. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceConfig API backend service configuration. Note: this field may return null, indicating that no valid values can be obtained.

setServiceConfig

public void setServiceConfig(ServiceConfig ServiceConfig)

Set API backend service configuration. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceConfig - API backend service configuration. Note: this field may return null, indicating that no valid values can be obtained.

getServiceParameters

public ServiceParameter[] getServiceParameters()

Get API backend service parameter. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceParameters API backend service parameter. Note: this field may return null, indicating that no valid values can be obtained.

setServiceParameters

public void setServiceParameters(ServiceParameter[] ServiceParameters)

Set API backend service parameter. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceParameters - API backend service parameter. Note: this field may return null, indicating that no valid values can be obtained.

getConstantParameters

public ConstantParameter[] getConstantParameters()

Get Constant parameter. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ConstantParameters Constant parameter. Note: this field may return null, indicating that no valid values can be obtained.

setConstantParameters

public void setConstantParameters(ConstantParameter[] ConstantParameters)

Set Constant parameter. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ConstantParameters - Constant parameter. Note: this field may return null, indicating that no valid values can be obtained.

getServiceMockReturnMessage

public String getServiceMockReturnMessage()

Get Returned message of API backend Mock, which is required if `ServiceType` is `Mock`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceMockReturnMessage Returned message of API backend Mock, which is required if `ServiceType` is `Mock`. Note: this field may return null, indicating that no valid values can be obtained.

setServiceMockReturnMessage

public void setServiceMockReturnMessage(String ServiceMockReturnMessage)

Set Returned message of API backend Mock, which is required if `ServiceType` is `Mock`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceMockReturnMessage - Returned message of API backend Mock, which is required if `ServiceType` is `Mock`. Note: this field may return null, indicating that no valid values can be obtained.

getServiceScfFunctionName

public String getServiceScfFunctionName()

Get SCF function name, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceScfFunctionName SCF function name, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

setServiceScfFunctionName

public void setServiceScfFunctionName(String ServiceScfFunctionName)

Set SCF function name, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceScfFunctionName - SCF function name, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

getServiceScfFunctionNamespace

public String getServiceScfFunctionNamespace()

Get SCF function namespace, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceScfFunctionNamespace SCF function namespace, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

setServiceScfFunctionNamespace

public void setServiceScfFunctionNamespace(String ServiceScfFunctionNamespace)

Set SCF function namespace, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceScfFunctionNamespace - SCF function namespace, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

getServiceScfFunctionQualifier

public String getServiceScfFunctionQualifier()

Get SCF function version, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceScfFunctionQualifier SCF function version, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

setServiceScfFunctionQualifier

public void setServiceScfFunctionQualifier(String ServiceScfFunctionQualifier)

Set SCF function version, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceScfFunctionQualifier - SCF function version, which takes effect if the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

getServiceScfIsIntegratedResponse

public Boolean getServiceScfIsIntegratedResponse()

Get Whether integrated response is enabled. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceScfIsIntegratedResponse Whether integrated response is enabled. Note: this field may return null, indicating that no valid values can be obtained.

setServiceScfIsIntegratedResponse

public void setServiceScfIsIntegratedResponse(Boolean ServiceScfIsIntegratedResponse)

Set Whether integrated response is enabled. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceScfIsIntegratedResponse - Whether integrated response is enabled. Note: this field may return null, indicating that no valid values can be obtained.

getServiceWebsocketRegisterFunctionName

public String getServiceWebsocketRegisterFunctionName()

Get SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF` Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketRegisterFunctionName SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF` Note: this field may return null, indicating that no valid values can be obtained.

setServiceWebsocketRegisterFunctionName

public void setServiceWebsocketRegisterFunctionName(String ServiceWebsocketRegisterFunctionName)

Set SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF` Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketRegisterFunctionName - SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF` Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketRegisterFunctionNamespace SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketRegisterFunctionNamespace - SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketRegisterFunctionQualifier SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketRegisterFunctionQualifier - SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

getServiceWebsocketCleanupFunctionName

public String getServiceWebsocketCleanupFunctionName()

Get SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketCleanupFunctionName SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketCleanupFunctionName - SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketCleanupFunctionNamespace SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketCleanupFunctionNamespace - SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketCleanupFunctionQualifier SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketCleanupFunctionQualifier - SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

getInternalDomain

public String getInternalDomain()

Get WebSocket callback address. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

InternalDomain WebSocket callback address. Note: this field may return null, indicating that no valid values can be obtained.

setInternalDomain

public void setInternalDomain(String InternalDomain)

Set WebSocket callback address. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

InternalDomain - WebSocket callback address. Note: this field may return null, indicating that no valid values can be obtained.

getServiceWebsocketTransportFunctionName

public String getServiceWebsocketTransportFunctionName()

Get SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketTransportFunctionName SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketTransportFunctionName - SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketTransportFunctionNamespace SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketTransportFunctionNamespace - SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceWebsocketTransportFunctionQualifier SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

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`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceWebsocketTransportFunctionQualifier - SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. Note: this field may return null, indicating that no valid values can be obtained.

getMicroServices

public MicroService[] getMicroServices()

Get List of microservices bound to API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

MicroServices List of microservices bound to API. Note: this field may return null, indicating that no valid values can be obtained.

setMicroServices

public void setMicroServices(MicroService[] MicroServices)

Set List of microservices bound to API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

MicroServices - List of microservices bound to API. Note: this field may return null, indicating that no valid values can be obtained.

getMicroServicesInfo

public Long[] getMicroServicesInfo()

Get Microservice details. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

MicroServicesInfo Microservice details. Note: this field may return null, indicating that no valid values can be obtained.

setMicroServicesInfo

public void setMicroServicesInfo(Long[] MicroServicesInfo)

Set Microservice details. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

MicroServicesInfo - Microservice details. Note: this field may return null, indicating that no valid values can be obtained.

getServiceTsfLoadBalanceConf

public TsfLoadBalanceConfResp getServiceTsfLoadBalanceConf()

Get Load balancing configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceTsfLoadBalanceConf Load balancing configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

setServiceTsfLoadBalanceConf

public void setServiceTsfLoadBalanceConf(TsfLoadBalanceConfResp ServiceTsfLoadBalanceConf)

Set Load balancing configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceTsfLoadBalanceConf - Load balancing configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

getServiceTsfHealthCheckConf

public HealthCheckConf getServiceTsfHealthCheckConf()

Get Health check configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ServiceTsfHealthCheckConf Health check configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

setServiceTsfHealthCheckConf

public void setServiceTsfHealthCheckConf(HealthCheckConf ServiceTsfHealthCheckConf)

Set Health check configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ServiceTsfHealthCheckConf - Health check configuration of microservice. Note: this field may return null, indicating that no valid values can be obtained.

getEnableCORS

public Boolean getEnableCORS()

Get Whether to enable CORS. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

EnableCORS Whether to enable CORS. Note: this field may return null, indicating that no valid values can be obtained.

setEnableCORS

public void setEnableCORS(Boolean EnableCORS)

Set Whether to enable CORS. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

EnableCORS - Whether to enable CORS. Note: this field may return null, indicating that no valid values can be obtained.

getTags

public Tag[] getTags()

Get Information of tags bound to API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Tags Information of tags bound to API. Note: this field may return null, indicating that no valid values can be obtained.

setTags

public void setTags(Tag[] Tags)

Set Information of tags bound to API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Tags - Information of tags bound to API. Note: this field may return null, indicating that no valid values can be obtained.

getEnvironments

public String[] getEnvironments()

Get Environment information published for API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Environments Environment information published for API. Note: this field may return null, indicating that no valid values can be obtained.

setEnvironments

public void setEnvironments(String[] Environments)

Set Environment information published for API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Environments - Environment information published for API. Note: this field may return null, indicating that no valid values can be obtained.

getIsBase64Encoded

public Boolean getIsBase64Encoded()

Get Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

IsBase64Encoded Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

setIsBase64Encoded

public void setIsBase64Encoded(Boolean IsBase64Encoded)

Set Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

IsBase64Encoded - Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

getIsBase64Trigger

public Boolean getIsBase64Trigger()

Get Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

IsBase64Trigger Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

setIsBase64Trigger

public void setIsBase64Trigger(Boolean IsBase64Trigger)

Set Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

IsBase64Trigger - Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF. Note: This field may return `null`, indicating that no valid values can be obtained.

getBase64EncodedTriggerRules

public Base64EncodedTriggerRule[] getBase64EncodedTriggerRules()

Get Header trigger rules. The number of rules cannot exceed 10. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

Base64EncodedTriggerRules Header trigger rules. The number of rules cannot exceed 10. Note: This field may return `null`, indicating that no valid values can be obtained.

setBase64EncodedTriggerRules

public void setBase64EncodedTriggerRules(Base64EncodedTriggerRule[] Base64EncodedTriggerRules)

Set Header trigger rules. The number of rules cannot exceed 10. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

Base64EncodedTriggerRules - Header trigger rules. The number of rules cannot exceed 10. Note: This field may return `null`, indicating that no valid values can be obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel