ModifyApiConfigurationRequest.Builder (alibabacloud-cloudapi20160714 3.0.21 API)

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

所有已实现的接口:

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

封闭类:

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ModifyApiConfigurationRequest.Builder`	`allowSignatureMethod(String allowSignatureMethod)` If the AuthType parameter is set to APP, you must include this parameter to specify the signature algorithm.
`ModifyApiConfigurationRequest.Builder`	`apiId(String apiId)` The ID of the API.
`ModifyApiConfigurationRequest.Builder`	`apiName(String apiName)` The name of the API.
`ModifyApiConfigurationRequest.Builder`	`appCodeAuthType(String appCodeAuthType)` If the AuthType parameter is set to APP, the valid values are: * DEFAULT: The default value that is used if no other values are passed.
`ModifyApiConfigurationRequest.Builder`	`authType(String authType)` API安全认证类型，目前可以取值： - APP：只允许已授权的APP调用 - ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意： - 任何能够获取该API服务信息的人，都将能够调用该API。
`ModifyApiConfigurationRequest.Builder`	`backendName(String backendName)` The name of the backend service.
`ModifyApiConfigurationRequest.Builder`	`bodyFormat(String bodyFormat)` This parameter takes effect only when the RequestMode parameter is set to MAPPING.
`ModifyApiConfigurationRequest.Builder`	`bodyModel(String bodyModel)` The body model.
`ModifyApiConfigurationRequest`	`build()`
`ModifyApiConfigurationRequest.Builder`	`contentTypeCategory(String contentTypeCategory)` The ContentType configuration of the backend request.
`ModifyApiConfigurationRequest.Builder`	`contentTypeValue(String contentTypeValue)` The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.
`ModifyApiConfigurationRequest.Builder`	`description(String description)` The description of the API.
`ModifyApiConfigurationRequest.Builder`	`disableInternet(Boolean disableInternet)` * Specifies whether to call the API only in an internal network.
`ModifyApiConfigurationRequest.Builder`	`errorCodeSamples(String errorCodeSamples)` The sample error codes returned by the backend service.
`ModifyApiConfigurationRequest.Builder`	`failResultSample(String failResultSample)` The sample error response from the backend service.
`ModifyApiConfigurationRequest.Builder`	`forceNonceCheck(Boolean forceNonceCheck)` * Specifies whether to forcibly check X-Ca-Nonce.
`ModifyApiConfigurationRequest.Builder`	`functionComputeConfig(String functionComputeConfig)` The Function Compute configuration.
`ModifyApiConfigurationRequest.Builder`	`httpConfig(String httpConfig)` The HTTP configuration.
`ModifyApiConfigurationRequest.Builder`	`mockConfig(String mockConfig)` The Mock configuration.
`ModifyApiConfigurationRequest.Builder`	`modelName(String modelName)` The name of the model.
`ModifyApiConfigurationRequest.Builder`	`ossConfig(String ossConfig)` The OSS configuration.
`ModifyApiConfigurationRequest.Builder`	`postBodyDescription(String postBodyDescription)` The description of the request body.
`ModifyApiConfigurationRequest.Builder`	`requestHttpMethod(String requestHttpMethod)` The HTTP method used to make the request.
`ModifyApiConfigurationRequest.Builder`	`requestMode(String requestMode)` The request mode.
`ModifyApiConfigurationRequest.Builder`	`requestParameters(String requestParameters)` The parameters of API requests sent by the consumer to API Gateway.
`ModifyApiConfigurationRequest.Builder`	`requestPath(String requestPath)` The path of the API request.
`ModifyApiConfigurationRequest.Builder`	`requestProtocol(String requestProtocol)` The protocol type supported by the API.
`ModifyApiConfigurationRequest.Builder`	`resultSample(String resultSample)` The sample response from the backend service.
`ModifyApiConfigurationRequest.Builder`	`resultType(String resultType)` The format of the response from the backend service.
`ModifyApiConfigurationRequest.Builder`	`securityToken(String securityToken)` SecurityToken.
`ModifyApiConfigurationRequest.Builder`	`serviceParameters(String serviceParameters)` The parameters of API requests sent by API Gateway to the backend service.
`ModifyApiConfigurationRequest.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.
`ModifyApiConfigurationRequest.Builder`	`serviceProtocol(String serviceProtocol)` The protocol that is used to access backend services.
`ModifyApiConfigurationRequest.Builder`	`serviceTimeout(Integer serviceTimeout)` The timeout period of the backend service.
`ModifyApiConfigurationRequest.Builder`	`useBackendService(Boolean useBackendService)` Specifies whether to use the information about the created backend service.
`ModifyApiConfigurationRequest.Builder`	`visibility(String visibility)` Specifies whether to make the API public.
`ModifyApiConfigurationRequest.Builder`	`vpcConfig(String vpcConfig)` The VPC configuration.

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

- 方法详细资料
  - allowSignatureMethod
```
public ModifyApiConfigurationRequest.Builder allowSignatureMethod(String allowSignatureMethod)
```
    If the **AuthType** parameter is set to **APP**, you must include this parameter to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:
    * HmacSHA256 * HmacSHA1,HmacSHA256
  - apiId
```
public ModifyApiConfigurationRequest.Builder apiId(String apiId)
```
    The ID of the API.
  - apiName
```
public ModifyApiConfigurationRequest.Builder apiName(String apiName)
```
    The name of the API.
  - appCodeAuthType
```
public ModifyApiConfigurationRequest.Builder appCodeAuthType(String appCodeAuthType)
```
    If the **AuthType** parameter is set to **APP**, the valid values are:
    * **DEFAULT**: The default value that is used if no other values are passed. This value indicates that the settings of the group are 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 ModifyApiConfigurationRequest.Builder authType(String authType)
```
    API安全认证类型，目前可以取值：
    - **APP**：只允许已授权的APP调用 - **ANONYMOUS**：允许匿名调用，设置为允许匿名调用需要注意： - 任何能够获取该API服务信息的人，都将能够调用该API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该API请设置好按API的流量控制； - AppCodeAuthType的值不会生效。
  - backendName
```
public ModifyApiConfigurationRequest.Builder backendName(String backendName)
```
    The name of the backend service. This parameter takes effect only when the UseBackendService parameter is set to TRUE.
  - bodyFormat
```
public ModifyApiConfigurationRequest.Builder bodyFormat(String bodyFormat)
```
    This parameter takes effect only when the **RequestMode** parameter is set to **MAPPING**.
    The format in which data is transmitted to the server for POST and PUT requests. Valid values: **FORM** and **STREAM**. FORM indicates that data is transmitted in the key-value pair format. STREAM indicates that data is transmitted as byte streams.
  - bodyModel
```
public ModifyApiConfigurationRequest.Builder bodyModel(String bodyModel)
```
    The body model.
  - contentTypeCategory
```
public ModifyApiConfigurationRequest.Builder contentTypeCategory(String contentTypeCategory)
```
    The ContentType configuration of the backend request.
    * DEFAULT: the default configuration in API Gateway * CUSTOM: a custom configuration
  - contentTypeValue
```
public ModifyApiConfigurationRequest.Builder contentTypeValue(String contentTypeValue)
```
    The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.
  - description
```
public ModifyApiConfigurationRequest.Builder description(String description)
```
    The description of the API.
  - disableInternet
```
public ModifyApiConfigurationRequest.Builder disableInternet(Boolean disableInternet)
```
    * Specifies whether to call the API only in an internal network. If the **DisableInternet** parameter is set to **true**, the API can be called only in an internal network.
    * If the **DisableInternet** parameter is set to **false**, the API can be called over the Internet and in an internal network.
  - errorCodeSamples
```
public ModifyApiConfigurationRequest.Builder errorCodeSamples(String errorCodeSamples)
```
    The sample error codes returned by the backend service.
    For more information, see [ErrorCodeSample](~~44392~~).
  - failResultSample
```
public ModifyApiConfigurationRequest.Builder failResultSample(String failResultSample)
```
    The sample error response from the backend service. This value is used only to generate documents. It does not affect the returned result.
  - forceNonceCheck
```
public ModifyApiConfigurationRequest.Builder forceNonceCheck(Boolean forceNonceCheck)
```
    * Specifies whether to forcibly check X-Ca-Nonce. If the **ForceNonceCheck** parameter is set to **true**, X-Ca-Nonce is forcibly checked. X-Ca-Nonce 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 the **ForceNonceCheck** parameter is set to **false**, X-Ca-Nonce is not checked. If you do not modify this parameter when you modify an API, the original value is used.
  - functionComputeConfig
```
public ModifyApiConfigurationRequest.Builder functionComputeConfig(String functionComputeConfig)
```
    The Function Compute configuration.
  - httpConfig
```
public ModifyApiConfigurationRequest.Builder httpConfig(String httpConfig)
```
    The HTTP configuration.
  - mockConfig
```
public ModifyApiConfigurationRequest.Builder mockConfig(String mockConfig)
```
    The Mock configuration.
  - modelName
```
public ModifyApiConfigurationRequest.Builder modelName(String modelName)
```
    The name of the model.
  - ossConfig
```
public ModifyApiConfigurationRequest.Builder ossConfig(String ossConfig)
```
    The OSS configuration.
  - postBodyDescription
```
public ModifyApiConfigurationRequest.Builder postBodyDescription(String postBodyDescription)
```
    The description of the request body.
  - requestHttpMethod
```
public ModifyApiConfigurationRequest.Builder requestHttpMethod(String requestHttpMethod)
```
    The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.
  - requestMode
```
public ModifyApiConfigurationRequest.Builder requestMode(String requestMode)
```
    The request mode. Valid values:
    * MAPPING: Parameters are mapped. Unknown parameters are filtered out. * PASSTHROUGH: Parameters are passed through. * MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.
  - requestParameters
```
public ModifyApiConfigurationRequest.Builder requestParameters(String requestParameters)
```
    The parameters of API requests sent by the consumer to API Gateway.
    For more information, see [RequestParameter](~~43986~~).
  - requestPath
```
public ModifyApiConfigurationRequest.Builder requestPath(String requestPath)
```
    The path of the API request. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the path of the API request is `/object/add`.
  - requestProtocol
```
public ModifyApiConfigurationRequest.Builder requestProtocol(String requestProtocol)
```
    The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".
  - resultSample
```
public ModifyApiConfigurationRequest.Builder resultSample(String resultSample)
```
    The sample response from the backend service. This value is used only to generate documents. It does not affect the returned result.
  - resultType
```
public ModifyApiConfigurationRequest.Builder resultType(String resultType)
```
    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 result.
  - securityToken
```
public ModifyApiConfigurationRequest.Builder securityToken(String securityToken)
```
    SecurityToken.
  - serviceParameters
```
public ModifyApiConfigurationRequest.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 ModifyApiConfigurationRequest.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~~).
  - serviceProtocol
```
public ModifyApiConfigurationRequest.Builder serviceProtocol(String serviceProtocol)
```
    The protocol that is used to access backend services. Valid values:
    * Http: for backend services that use HTTP or HTTPS * Vpc: for backend services that use VPC * FC: for Function Compute * OSS: for Object Storage Service * Mock: for backend services that use the Mock mode * EventBridge: for EventBridge You must specify the config value for the corresponding backend service.
  - serviceTimeout
```
public ModifyApiConfigurationRequest.Builder serviceTimeout(Integer serviceTimeout)
```
    The timeout period of the backend service. Unit: milliseconds.
  - useBackendService
```
public ModifyApiConfigurationRequest.Builder useBackendService(Boolean useBackendService)
```
    Specifies whether to use the information about the created backend service. Valid values:
    * TRUE: uses the information about the created backend service. * FALSE: uses the information about the custom backend service.
  - visibility
```
public ModifyApiConfigurationRequest.Builder visibility(String visibility)
```
    Specifies whether to make the API public. Valid values:
    * **PUBLIC:** The API is public. If this parameter is set to PUBLIC, the API is displayed on the APIs page for all users after the API is published to the production environment. * **PRIVATE:** The API is private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.
  - vpcConfig
```
public ModifyApiConfigurationRequest.Builder vpcConfig(String vpcConfig)
```
    The VPC configuration.
  - build
```
public ModifyApiConfigurationRequest build()
```

类 ModifyApiConfigurationRequest.Builder

方法概要

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

方法详细资料

allowSignatureMethod

apiId

apiName

appCodeAuthType

authType

backendName

bodyFormat

bodyModel

contentTypeCategory

contentTypeValue

description

disableInternet

errorCodeSamples

failResultSample

forceNonceCheck

functionComputeConfig

httpConfig

mockConfig

modelName

ossConfig

postBodyDescription

requestHttpMethod

requestMode

requestParameters

requestPath

requestProtocol

resultSample

resultType

securityToken

serviceParameters

serviceParametersMap

serviceProtocol

serviceTimeout

useBackendService

visibility

vpcConfig

build