CreateApiRequest.Builder (alibabacloud-cloudapi20160714 2.2.15 API)

java.lang.Object
- com.aliyun.sdk.service.cloudapi20160714.models.CreateApiRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<CreateApiRequest,CreateApiRequest.Builder>

封闭类:

CreateApiRequest
```
public static final class CreateApiRequest.Builder
extends Object
```

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CreateApiRequest.Builder`	`allowSignatureMethod(String allowSignatureMethod)` If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm.
`CreateApiRequest.Builder`	`apiName(String apiName)` The name of the API that you want to create.
`CreateApiRequest.Builder`	`appCodeAuthType(String appCodeAuthType)` If AuthType is set to APP, the valid values are: * DEFAULT: The default value that is used if no other values are passed.
`CreateApiRequest.Builder`	`authType(String authType)` API安全认证类型，目前可以取值： - APP：只允许已授权的APP调用 - ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意：任何能够获取该API服务信息的人，都将能够调用该API。
`CreateApiRequest.Builder`	`backendEnable(Boolean backendEnable)` Specifies whether to enable backend services.
`CreateApiRequest.Builder`	`backendId(String backendId)` The IDof the backend service
`CreateApiRequest`	`build()`
`CreateApiRequest.Builder`	`constantParameters(String constantParameters)` The parameters of the API.
`CreateApiRequest.Builder`	`description(String description)` The description of the API.
`CreateApiRequest.Builder`	`disableInternet(Boolean disableInternet)` * Specifies whether to set DisableInternet to true to limit API calls to within the VPC.
`CreateApiRequest.Builder`	`errorCodeSamples(String errorCodeSamples)` The sample error codes returned by the backend service.
`CreateApiRequest.Builder`	`failResultSample(String failResultSample)` The sample error response from the backend service.
`CreateApiRequest.Builder`	`forceNonceCheck(Boolean forceNonceCheck)` * Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request.
`CreateApiRequest.Builder`	`groupId(String groupId)` The ID of the API group.
`CreateApiRequest.Builder`	`openIdConnectConfig(String openIdConnectConfig)` The switch status of ACL.
`CreateApiRequest.Builder`	`requestConfig(String requestConfig)` The configuration items of API requests sent by the consumer to API Gateway.
`CreateApiRequest.Builder`	`requestParameters(String requestParameters)` The parameters of API requests sent by the consumer to API Gateway.
`CreateApiRequest.Builder`	`resultBodyModel(String resultBodyModel)` The return description of the API.
`CreateApiRequest.Builder`	`resultDescriptions(String resultDescriptions)` The return description of the API.
`CreateApiRequest.Builder`	`resultSample(String resultSample)` The sample response from the backend service.
`CreateApiRequest.Builder`	`resultType(String resultType)` The format of the response from the backend service.
`CreateApiRequest.Builder`	`securityToken(String securityToken)` SecurityToken.
`CreateApiRequest.Builder`	`serviceConfig(String serviceConfig)` The configuration items of API requests sent by API Gateway to the backend service.
`CreateApiRequest.Builder`	`serviceParameters(String serviceParameters)` The parameters of API requests sent by API Gateway to the backend service.
`CreateApiRequest.Builder`	`serviceParametersMap(String serviceParametersMap)` The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.
`CreateApiRequest.Builder`	`systemParameters(String systemParameters)` The common parameters of APIs in JSON format.
`CreateApiRequest.Builder`	`visibility(String visibility)` Specifies whether to make the API public.
`CreateApiRequest.Builder`	`webSocketApiType(String webSocketApiType)` The type of the two-way communication API.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - allowSignatureMethod
```
public CreateApiRequest.Builder allowSignatureMethod(String allowSignatureMethod)
```
    If the **AuthType** is **APP** authentication, you need to pass this value to specify the signature algorithm. If you do not specify this parameter, the default value HmacSHA256 is used. Valid values:
    * HmacSHA256 * HmacSHA1,HmacSHA256
  - apiName
```
public CreateApiRequest.Builder apiName(String apiName)
```
    The name of the API that you want to create. The name must be unique within the API group. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (\_).
  - appCodeAuthType
```
public CreateApiRequest.Builder appCodeAuthType(String appCodeAuthType)
```
    If **AuthType** is set to **APP**, the valid values are:
    * **DEFAULT**: The default value that is used if no other values are passed. This value means that the setting of the group is used. * **DISABLE**: The authentication is disabled. * **HEADER**: AppCode can be placed in the Header parameter for authentication. * **HEADER_QUERY**: AppCode can be placed in the Header or Query parameter for authentication.
  - authType
```
public CreateApiRequest.Builder authType(String authType)
```
    API安全认证类型，目前可以取值：
    - **APP**：只允许已授权的APP调用 - **ANONYMOUS**：允许匿名调用，设置为允许匿名调用需要注意：任何能够获取该API服务信息的人，都将能够调用该API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该API请设置好按API的流量控制。
  - backendEnable
```
public CreateApiRequest.Builder backendEnable(Boolean backendEnable)
```
    Specifies whether to enable backend services.
  - backendId
```
public CreateApiRequest.Builder backendId(String backendId)
```
    The IDof the backend service
  - constantParameters
```
public CreateApiRequest.Builder constantParameters(String constantParameters)
```
    The parameters of the API.
  - description
```
public CreateApiRequest.Builder description(String description)
```
    The description of the API. The description can be up to 180 characters in length.
  - disableInternet
```
public CreateApiRequest.Builder disableInternet(Boolean disableInternet)
```
    * Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.
    * If you set **DisableInternet** to **false**, the limit is lifted. The default value is false when you create an API.
  - errorCodeSamples
```
public CreateApiRequest.Builder errorCodeSamples(String errorCodeSamples)
```
    The sample error codes returned by the backend service.
    For more information, see [ErrorCodeSample](~~44392~~).
  - failResultSample
```
public CreateApiRequest.Builder failResultSample(String failResultSample)
```
    The sample error response from the backend service.
  - forceNonceCheck
```
public CreateApiRequest.Builder forceNonceCheck(Boolean forceNonceCheck)
```
    * Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.
    * If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.
  - groupId
```
public CreateApiRequest.Builder groupId(String groupId)
```
    The ID of the API group.
  - openIdConnectConfig
```
public CreateApiRequest.Builder openIdConnectConfig(String openIdConnectConfig)
```
    The switch status of ACL. Valid values:- **on** and **off**.
  - requestConfig
```
public CreateApiRequest.Builder requestConfig(String requestConfig)
```
    The configuration items of API requests sent by the consumer to API Gateway.
    For more information, see [RequestConfig](~~43985~~).
  - requestParameters
```
public CreateApiRequest.Builder requestParameters(String requestParameters)
```
    The parameters of API requests sent by the consumer to API Gateway.
    For more information, see [RequestParameter](~~43986~~).
  - resultBodyModel
```
public CreateApiRequest.Builder resultBodyModel(String resultBodyModel)
```
    The return description of the API.
  - resultDescriptions
```
public CreateApiRequest.Builder resultDescriptions(String resultDescriptions)
```
    The return description of the API.
  - resultSample
```
public CreateApiRequest.Builder resultSample(String resultSample)
```
    The sample response from the backend service.
  - resultType
```
public CreateApiRequest.Builder resultType(String resultType)
```
    The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.
  - securityToken
```
public CreateApiRequest.Builder securityToken(String securityToken)
```
    SecurityToken.
  - serviceConfig
```
public CreateApiRequest.Builder serviceConfig(String serviceConfig)
```
    The configuration items of API requests sent by API Gateway to the backend service.
    For more information, see [ServiceConfig](~~43987~~).
  - serviceParameters
```
public CreateApiRequest.Builder serviceParameters(String serviceParameters)
```
    The parameters of API requests sent by API Gateway to the backend service.
    For more information, see [ServiceParameter](~~43988~~).
  - serviceParametersMap
```
public CreateApiRequest.Builder serviceParametersMap(String serviceParametersMap)
```
    The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.
    For more information, see [ServiceParameterMap](~~43989~~).
  - systemParameters
```
public CreateApiRequest.Builder systemParameters(String systemParameters)
```
    The common parameters of APIs in JSON format.
  - visibility
```
public CreateApiRequest.Builder visibility(String visibility)
```
    Specifies whether to make the API public. Valid values:
    * **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment. * **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.
  - webSocketApiType
```
public CreateApiRequest.Builder webSocketApiType(String webSocketApiType)
```
    The type of the two-way communication API.
    * **COMMON**: normal APIs * **REGISTER**: registered APIs * **UNREGISTER**: unregistered APIs * **NOTIFY**: downstream notification APIs
  - build
```
public CreateApiRequest build()
```

类 CreateApiRequest.Builder

方法概要

从类继承的方法 java.lang.Object

方法详细资料

allowSignatureMethod

apiName

appCodeAuthType

authType

backendEnable

backendId

constantParameters

description

disableInternet

errorCodeSamples

failResultSample

forceNonceCheck

groupId

openIdConnectConfig

requestConfig

requestParameters

resultBodyModel

resultDescriptions

resultSample

resultType

securityToken

serviceConfig

serviceParameters

serviceParametersMap

systemParameters

visibility

webSocketApiType

build