ModifyApiRequest.Builder (alibabacloud-cloudapi20160714 2.2.15 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 returned description of the API.
`ModifyApiRequest.Builder`	`apiId(String apiId)` The name of the API.
`ModifyApiRequest.Builder`	`apiName(String apiName)` The description of the API.
`ModifyApiRequest.Builder`	`appCodeAuthType(String appCodeAuthType)` Specifies whether to enable backend services.
`ModifyApiRequest.Builder`	`authType(String authType)` The configuration items of API requests sent by API Gateway to the backend service.
`ModifyApiRequest.Builder`	`backendEnable(Boolean backendEnable)` auditing
`ModifyApiRequest.Builder`	`backendId(String backendId)` The ID of the request.
`ModifyApiRequest`	`build()`
`ModifyApiRequest.Builder`	`constantParameters(String constantParameters)` 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.
`ModifyApiRequest.Builder`	`description(String description)` Specifies whether the API is public.
`ModifyApiRequest.Builder`	`disableInternet(Boolean disableInternet)` The ID of the backend service.
`ModifyApiRequest.Builder`	`errorCodeSamples(String errorCodeSamples)` The configuration items of the third-party OpenID Connect authentication method.
`ModifyApiRequest.Builder`	`failResultSample(String failResultSample)` The returned description of the API.
`ModifyApiRequest.Builder`	`forceNonceCheck(Boolean forceNonceCheck)` The AppCode authentication type supported.
`ModifyApiRequest.Builder`	`groupId(String groupId)` The ID of the API.
`ModifyApiRequest.Builder`	`openIdConnectConfig(String openIdConnectConfig)` The type of the two-way communication API.
`ModifyApiRequest.Builder`	`requestConfig(String requestConfig)` The parameters of API requests sent by the consumer to API Gateway.
`ModifyApiRequest.Builder`	`requestParameters(String requestParameters)` System parameter
`ModifyApiRequest.Builder`	`resultBodyModel(String resultBodyModel)` * Specifies whether to set DisableInternet to true to limit API calls to within the VPC.
`ModifyApiRequest.Builder`	`resultDescriptions(String resultDescriptions)` The client-side request signature method of the API.
`ModifyApiRequest.Builder`	`resultSample(String resultSample)` The sample error codes returned by the backend service.
`ModifyApiRequest.Builder`	`resultType(String resultType)` The sample error response from the backend service.
`ModifyApiRequest.Builder`	`securityToken(String securityToken)` SecurityToken.
`ModifyApiRequest.Builder`	`serviceConfig(String serviceConfig)` \[{"ParameterType":"Number","Required":"OPTIONAL","isHide":false,"ApiParameterName":"age","DefaultValue":"20","DemoValue":"20","Description":"age","MinValue":18,"MaxValue":100,"Location":"Head"},{"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"sex","DefaultValue":"boy","DemoValue":"boy","Description":"gender","EnumValue":"boy,girl","Location":"Query"},{"ParameterType":"Number","Required":"REQUIRED","isHide":false,"ApiParameterName":"userId","MaxLength":10,"MinValue":10000000,"MaxValue":100000000,"Location":"Path"},{"ApiParameterName":"CaClientIp","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","Description":"Client IP"},{"ApiParameterName":"constance","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","DefaultValue":"constance","Description":"constance"}]
`ModifyApiRequest.Builder`	`serviceParameters(String serviceParameters)` The format of the response from the backend service.
`ModifyApiRequest.Builder`	`serviceParametersMap(String serviceParametersMap)` The sample response from the backend service.
`ModifyApiRequest.Builder`	`systemParameters(String systemParameters)` The parameters of API requests sent by API Gateway to the backend service.
`ModifyApiRequest.Builder`	`visibility(String visibility)` The configuration items of API requests sent by the consumer to API Gateway.
`ModifyApiRequest.Builder`	`webSocketApiType(String webSocketApiType)` * Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request.

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

- 方法详细资料
  - allowSignatureMethod
```
public ModifyApiRequest.Builder allowSignatureMethod(String allowSignatureMethod)
```
    The returned description of the API.
  - apiId
```
public ModifyApiRequest.Builder apiId(String apiId)
```
    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 (\_).
  - apiName
```
public ModifyApiRequest.Builder apiName(String apiName)
```
    The description of the API. The description can be up to 180 characters in length.
  - appCodeAuthType
```
public ModifyApiRequest.Builder appCodeAuthType(String appCodeAuthType)
```
    Specifies whether to enable backend services.
  - authType
```
public ModifyApiRequest.Builder authType(String authType)
```
    The configuration items of API requests sent by API Gateway to the backend service.
  - backendEnable
```
public ModifyApiRequest.Builder backendEnable(Boolean backendEnable)
```
    auditing
  - backendId
```
public ModifyApiRequest.Builder backendId(String backendId)
```
    The ID of the request.
  - constantParameters
```
public ModifyApiRequest.Builder constantParameters(String constantParameters)
```
    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.
  - description
```
public ModifyApiRequest.Builder description(String description)
```
    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.
  - disableInternet
```
public ModifyApiRequest.Builder disableInternet(Boolean disableInternet)
```
    The ID of the backend service.
  - errorCodeSamples
```
public ModifyApiRequest.Builder errorCodeSamples(String errorCodeSamples)
```
    The configuration items of the third-party OpenID Connect authentication method.
  - failResultSample
```
public ModifyApiRequest.Builder failResultSample(String failResultSample)
```
    The returned description of the API.
  - forceNonceCheck
```
public ModifyApiRequest.Builder forceNonceCheck(Boolean forceNonceCheck)
```
    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
  - groupId
```
public ModifyApiRequest.Builder groupId(String groupId)
```
    The ID of the API.
  - openIdConnectConfig
```
public ModifyApiRequest.Builder openIdConnectConfig(String openIdConnectConfig)
```
    The type of the two-way communication API. Valid values:
    * **COMMON**: general APIs * **REGISTER**: registered APIs * **UNREGISTER**: unregistered APIs * **NOTIFY**: downstream notification
  - requestConfig
```
public ModifyApiRequest.Builder requestConfig(String requestConfig)
```
    The parameters of API requests sent by the consumer to API Gateway.
  - requestParameters
```
public ModifyApiRequest.Builder requestParameters(String requestParameters)
```
    System parameter
  - resultBodyModel
```
public ModifyApiRequest.Builder resultBodyModel(String resultBodyModel)
```
    * 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.
  - resultDescriptions
```
public ModifyApiRequest.Builder resultDescriptions(String resultDescriptions)
```
    The client-side request signature method of the API. Valid values:
    * HmacSHA256 * HmacSHA1,HmacSHA256
  - resultSample
```
public ModifyApiRequest.Builder resultSample(String resultSample)
```
    The sample error codes returned by the backend service.
  - resultType
```
public ModifyApiRequest.Builder resultType(String resultType)
```
    The sample error response from the backend service.
  - securityToken
```
public ModifyApiRequest.Builder securityToken(String securityToken)
```
    SecurityToken.
  - serviceConfig
```
public ModifyApiRequest.Builder serviceConfig(String serviceConfig)
```
    \[{"ParameterType":"Number","Required":"OPTIONAL","isHide":false,"ApiParameterName":"age","DefaultValue":"20","DemoValue":"20","Description":"age","MinValue":18,"MaxValue":100,"Location":"Head"},{"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"sex","DefaultValue":"boy","DemoValue":"boy","Description":"gender","EnumValue":"boy,girl","Location":"Query"},{"ParameterType":"Number","Required":"REQUIRED","isHide":false,"ApiParameterName":"userId","MaxLength":10,"MinValue":10000000,"MaxValue":100000000,"Location":"Path"},{"ApiParameterName":"CaClientIp","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","Description":"Client IP"},{"ApiParameterName":"constance","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","DefaultValue":"constance","Description":"constance"}]
  - serviceParameters
```
public ModifyApiRequest.Builder serviceParameters(String serviceParameters)
```
    The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. This value is used only to generate documents. It does not affect the returned results.
  - serviceParametersMap
```
public ModifyApiRequest.Builder serviceParametersMap(String serviceParametersMap)
```
    The sample response from the backend service.
  - systemParameters
```
public ModifyApiRequest.Builder systemParameters(String systemParameters)
```
    The parameters of API requests sent by API Gateway to the backend service.
  - visibility
```
public ModifyApiRequest.Builder visibility(String visibility)
```
    The configuration items of API requests sent by the consumer to API Gateway.
  - webSocketApiType
```
public ModifyApiRequest.Builder webSocketApiType(String webSocketApiType)
```
    * 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.
  - 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