ModifyApiRequest.Builder (alibabacloud-cloudapi20160714 3.0.21 API)

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

所有已实现的接口:

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

封闭类:

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ModifyApiRequest.Builder`	`allowSignatureMethod(String allowSignatureMethod)` The type of the two-way communication API.
`ModifyApiRequest.Builder`	`apiId(String apiId)` The ID of the API.
`ModifyApiRequest.Builder`	`apiName(String apiName)` The name of the API.
`ModifyApiRequest.Builder`	`appCodeAuthType(String appCodeAuthType)` The ID of the backend service.
`ModifyApiRequest.Builder`	`authType(String authType)` The configuration items of API requests sent by the consumer to API Gateway.
`ModifyApiRequest.Builder`	`backendEnable(Boolean backendEnable)` Configuration Mode
`ModifyApiRequest.Builder`	`backendId(String backendId)` Specifies whether to enable backend services.
`ModifyApiRequest`	`build()`
`ModifyApiRequest.Builder`	`constantParameters(String constantParameters)` ConstantParameters.
`ModifyApiRequest.Builder`	`description(String description)` The description of the API.
`ModifyApiRequest.Builder`	`disableInternet(Boolean disableInternet)` The AppCode authentication type supported.
`ModifyApiRequest.Builder`	`errorCodeSamples(String errorCodeSamples)` ErrorCodeSamples.
`ModifyApiRequest.Builder`	`failResultSample(String failResultSample)` FailResultSample.
`ModifyApiRequest.Builder`	`forceNonceCheck(Boolean forceNonceCheck)` * Specifies whether to set DisableInternet to true to limit API calls to within the VPC.
`ModifyApiRequest.Builder`	`groupId(String groupId)` The ID of the API group.
`ModifyApiRequest.Builder`	`openIdConnectConfig(String openIdConnectConfig)` The client-side request signature method of the API.
`ModifyApiRequest.Builder`	`requestConfig(String requestConfig)` The configuration items of API requests sent by API Gateway to the backend service.
`ModifyApiRequest.Builder`	`requestParameters(String requestParameters)` RequestParameters.
`ModifyApiRequest.Builder`	`resultBodyModel(String resultBodyModel)` * Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request.
`ModifyApiRequest.Builder`	`resultDescriptions(String resultDescriptions)` ResultDescriptions.
`ModifyApiRequest.Builder`	`resultSample(String resultSample)` ResultSample.
`ModifyApiRequest.Builder`	`resultType(String resultType)` The sample response from the backend service.
`ModifyApiRequest.Builder`	`securityToken(String securityToken)` SecurityToken.
`ModifyApiRequest.Builder`	`serviceConfig(String serviceConfig)` The parameters of API requests sent by the consumer to API Gateway.
`ModifyApiRequest.Builder`	`serviceParameters(String serviceParameters)` ServiceParameters.
`ModifyApiRequest.Builder`	`serviceParametersMap(String serviceParametersMap)` ServiceParametersMap.
`ModifyApiRequest.Builder`	`systemParameters(String systemParameters)` SystemParameters.
`ModifyApiRequest.Builder`	`visibility(String visibility)` Specifies whether the API is public.
`ModifyApiRequest.Builder`	`webSocketApiType(String webSocketApiType)` The returned description of the API.

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

- 方法详细资料
  - allowSignatureMethod
```
public ModifyApiRequest.Builder allowSignatureMethod(String allowSignatureMethod)
```
    The type of the two-way communication API. Valid values:
    * **COMMON**: general APIs * **REGISTER**: registered APIs * **UNREGISTER**: unregistered APIs * **NOTIFY**: downstream notification
  - apiId
```
public ModifyApiRequest.Builder apiId(String apiId)
```
    The ID of the API.
  - apiName
```
public ModifyApiRequest.Builder apiName(String apiName)
```
    The name of the API. 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 ModifyApiRequest.Builder appCodeAuthType(String appCodeAuthType)
```
    The ID of the backend service.
  - authType
```
public ModifyApiRequest.Builder authType(String authType)
```
    The configuration items of API requests sent by the consumer to API Gateway.
  - backendEnable
```
public ModifyApiRequest.Builder backendEnable(Boolean backendEnable)
```
    Configuration Mode
  - backendId
```
public ModifyApiRequest.Builder backendId(String backendId)
```
    Specifies whether to enable backend services.
  - constantParameters
```
public ModifyApiRequest.Builder constantParameters(String constantParameters)
```
    ConstantParameters.
  - description
```
public ModifyApiRequest.Builder description(String description)
```
    The description of the API. The description can be up to 180 characters in length.
  - disableInternet
```
public ModifyApiRequest.Builder disableInternet(Boolean disableInternet)
```
    The AppCode authentication type supported. Valid values:
    * DEFAULT: supported after being made available in Alibaba Cloud Marketplace * DISABLE: not supported * HEADER : supported only in the Header parameter * HEADER_QUERY: supported in the Header or Query parameter
  - errorCodeSamples
```
public ModifyApiRequest.Builder errorCodeSamples(String errorCodeSamples)
```
    ErrorCodeSamples.
  - failResultSample
```
public ModifyApiRequest.Builder failResultSample(String failResultSample)
```
    FailResultSample.
  - forceNonceCheck
```
public ModifyApiRequest.Builder forceNonceCheck(Boolean forceNonceCheck)
```
    * Specifies whether to set DisableInternet to **true** to limit API calls to within the VPC.
    * If you set DisableInternet to **false**, the limit if lifted. > If you do not set this parameter, the original value is used.
  - groupId
```
public ModifyApiRequest.Builder groupId(String groupId)
```
    The ID of the API group.
  - openIdConnectConfig
```
public ModifyApiRequest.Builder openIdConnectConfig(String openIdConnectConfig)
```
    The client-side request signature method of the API. Valid values:
    * HmacSHA256 * HmacSHA1,HmacSHA256
  - requestConfig
```
public ModifyApiRequest.Builder requestConfig(String requestConfig)
```
    The configuration items of API requests sent by API Gateway to the backend service.
  - requestParameters
```
public ModifyApiRequest.Builder requestParameters(String requestParameters)
```
    RequestParameters.
  - resultBodyModel
```
public ModifyApiRequest.Builder resultBodyModel(String resultBodyModel)
```
    * 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. If you do not set this parameter, the original value is used.
  - resultDescriptions
```
public ModifyApiRequest.Builder resultDescriptions(String resultDescriptions)
```
    ResultDescriptions.
  - resultSample
```
public ModifyApiRequest.Builder resultSample(String resultSample)
```
    ResultSample.
  - resultType
```
public ModifyApiRequest.Builder resultType(String resultType)
```
    The sample response from the backend service.
  - securityToken
```
public ModifyApiRequest.Builder securityToken(String securityToken)
```
    SecurityToken.
  - serviceConfig
```
public ModifyApiRequest.Builder serviceConfig(String serviceConfig)
```
    The parameters of API requests sent by the consumer to API Gateway.
  - serviceParameters
```
public ModifyApiRequest.Builder serviceParameters(String serviceParameters)
```
    ServiceParameters.
  - serviceParametersMap
```
public ModifyApiRequest.Builder serviceParametersMap(String serviceParametersMap)
```
    ServiceParametersMap.
  - systemParameters
```
public ModifyApiRequest.Builder systemParameters(String systemParameters)
```
    SystemParameters.
  - visibility
```
public ModifyApiRequest.Builder visibility(String visibility)
```
    Specifies whether the API is 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 ModifyApiRequest.Builder webSocketApiType(String webSocketApiType)
```
    The returned description of the API.
  - build
```
public ModifyApiRequest build()
```

类 ModifyApiRequest.Builder

方法概要

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

方法详细资料

allowSignatureMethod

apiId

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