DescribeDeployedApiResponseBody.Builder (alibabacloud-cloudapi20160714 2.2.15 API)

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

封闭类:: DescribeDeployedApiResponseBody

public static final class DescribeDeployedApiResponseBody.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

构造器
构造器和说明
`Builder()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DescribeDeployedApiResponseBody.Builder`	`allowSignatureMethod(String allowSignatureMethod)` The signature method used by the client.
`DescribeDeployedApiResponseBody.Builder`	`apiId(String apiId)` The ID of the API.
`DescribeDeployedApiResponseBody.Builder`	`apiName(String apiName)` The name of the API.
`DescribeDeployedApiResponseBody.Builder`	`authType(String authType)` The authentication method of the API.
`DescribeDeployedApiResponseBody`	`build()`
`DescribeDeployedApiResponseBody.Builder`	`constantParameters(DescribeDeployedApiResponseBody.ConstantParameters constantParameters)` The constant parameters.
`DescribeDeployedApiResponseBody.Builder`	`customSystemParameters(DescribeDeployedApiResponseBody.CustomSystemParameters customSystemParameters)` The custom system parameters.
`DescribeDeployedApiResponseBody.Builder`	`deployedTime(String deployedTime)` The deployment time.
`DescribeDeployedApiResponseBody.Builder`	`description(String description)` The description of the parameter.
`DescribeDeployedApiResponseBody.Builder`	`disableInternet(Boolean disableInternet)` * Indicates whether to call the API only in an internal network.
`DescribeDeployedApiResponseBody.Builder`	`errorCodeSamples(DescribeDeployedApiResponseBody.ErrorCodeSamples errorCodeSamples)` The sample error codes returned by the backend service.
`DescribeDeployedApiResponseBody.Builder`	`failResultSample(String failResultSample)` The sample error response from the backend service.
`DescribeDeployedApiResponseBody.Builder`	`forceNonceCheck(Boolean forceNonceCheck)` * Indicates whether to forcibly check X-Ca-Nonce.
`DescribeDeployedApiResponseBody.Builder`	`groupId(String groupId)` The ID of the API group.
`DescribeDeployedApiResponseBody.Builder`	`groupName(String groupName)` The name of the API group.
`DescribeDeployedApiResponseBody.Builder`	`openIdConnectConfig(DescribeDeployedApiResponseBody.OpenIdConnectConfig openIdConnectConfig)` The configuration items of the third-party OpenID Connect authentication method.
`DescribeDeployedApiResponseBody.Builder`	`regionId(String regionId)` The region in which the API group resides.
`DescribeDeployedApiResponseBody.Builder`	`requestConfig(DescribeDeployedApiResponseBody.RequestConfig requestConfig)` The configuration items of API requests sent by the consumer to API Gateway.
`DescribeDeployedApiResponseBody.Builder`	`requestId(String requestId)` The ID of the request.
`DescribeDeployedApiResponseBody.Builder`	`requestParameters(DescribeDeployedApiResponseBody.RequestParameters requestParameters)` The parameters of API requests sent by the consumer to API Gateway.
`DescribeDeployedApiResponseBody.Builder`	`resultBodyModel(String resultBodyModel)` The return description of the API.
`DescribeDeployedApiResponseBody.Builder`	`resultDescriptions(DescribeDeployedApiResponseBody.ResultDescriptions resultDescriptions)` The returned description of the API.
`DescribeDeployedApiResponseBody.Builder`	`resultSample(String resultSample)` The sample response from the backend service.
`DescribeDeployedApiResponseBody.Builder`	`resultType(String resultType)` The format of the response from the backend service.
`DescribeDeployedApiResponseBody.Builder`	`serviceConfig(DescribeDeployedApiResponseBody.ServiceConfig serviceConfig)` The configuration items of API requests sent by API Gateway to the backend service.
`DescribeDeployedApiResponseBody.Builder`	`serviceParameters(DescribeDeployedApiResponseBody.ServiceParameters serviceParameters)` The parameters of API requests sent by API Gateway to the backend service.
`DescribeDeployedApiResponseBody.Builder`	`serviceParametersMap(DescribeDeployedApiResponseBody.ServiceParametersMap 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.
`DescribeDeployedApiResponseBody.Builder`	`stageName(String stageName)` The environment in which the API runs.
`DescribeDeployedApiResponseBody.Builder`	`systemParameters(DescribeDeployedApiResponseBody.SystemParameters systemParameters)` The system parameters.
`DescribeDeployedApiResponseBody.Builder`	`visibility(String visibility)` Indicates whether the API is public.

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

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - allowSignatureMethod
```
public DescribeDeployedApiResponseBody.Builder allowSignatureMethod(String allowSignatureMethod)
```
    The signature method used by the client. Valid values:
    * HmacSHA256 * HmacSHA1,HmacSHA256
  - apiId
```
public DescribeDeployedApiResponseBody.Builder apiId(String apiId)
```
    The ID of the API.
  - apiName
```
public DescribeDeployedApiResponseBody.Builder apiName(String apiName)
```
    The name of the API.
  - authType
```
public DescribeDeployedApiResponseBody.Builder authType(String authType)
```
    The authentication method of the API. Valid values:
    * **APP:** Only authorized apps are allowed to call the API. * **ANONYMOUS**: The API can be anonymously called. In this mode, you must take note of the following rules: * All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If the API is made public, set API-specific throttling policies.
  - constantParameters
```
public DescribeDeployedApiResponseBody.Builder constantParameters(DescribeDeployedApiResponseBody.ConstantParameters constantParameters)
```
    The constant parameters.
  - customSystemParameters
```
public DescribeDeployedApiResponseBody.Builder customSystemParameters(DescribeDeployedApiResponseBody.CustomSystemParameters customSystemParameters)
```
    The custom system parameters.
  - deployedTime
```
public DescribeDeployedApiResponseBody.Builder deployedTime(String deployedTime)
```
    The deployment time. Format: yyyy-mm-ddhh:mm:ss.
  - description
```
public DescribeDeployedApiResponseBody.Builder description(String description)
```
    The description of the parameter.
  - disableInternet
```
public DescribeDeployedApiResponseBody.Builder disableInternet(Boolean disableInternet)
```
    * Indicates whether to call the API only in an internal network. If this parameter is set to **true**, the API can be called only in an internal network.
    * If this parameter is set to **false**, the API can be called over the Internet and in an internal network. > If you do not configure this parameter when you modify the API, the original value is used.
  - errorCodeSamples
```
public DescribeDeployedApiResponseBody.Builder errorCodeSamples(DescribeDeployedApiResponseBody.ErrorCodeSamples errorCodeSamples)
```
    The sample error codes returned by the backend service.
    For more information, see [ErrorCodeSample](~~44392~~).
  - failResultSample
```
public DescribeDeployedApiResponseBody.Builder failResultSample(String failResultSample)
```
    The sample error response from the backend service.
  - forceNonceCheck
```
public DescribeDeployedApiResponseBody.Builder forceNonceCheck(Boolean forceNonceCheck)
```
    * Indicates 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 a 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**, the X-Ca-Nonce is not checked. Default value: false.
  - groupId
```
public DescribeDeployedApiResponseBody.Builder groupId(String groupId)
```
    The ID of the API group.
  - groupName
```
public DescribeDeployedApiResponseBody.Builder groupName(String groupName)
```
    The name of the API group.
  - openIdConnectConfig
```
public DescribeDeployedApiResponseBody.Builder openIdConnectConfig(DescribeDeployedApiResponseBody.OpenIdConnectConfig openIdConnectConfig)
```
    The configuration items of the third-party OpenID Connect authentication method.
  - regionId
```
public DescribeDeployedApiResponseBody.Builder regionId(String regionId)
```
    The region in which the API group resides.
  - requestConfig
```
public DescribeDeployedApiResponseBody.Builder requestConfig(DescribeDeployedApiResponseBody.RequestConfig requestConfig)
```
    The configuration items of API requests sent by the consumer to API Gateway.
    For more information, see [RequestConfig](~~43985~~).
  - requestId
```
public DescribeDeployedApiResponseBody.Builder requestId(String requestId)
```
    The ID of the request.
  - requestParameters
```
public DescribeDeployedApiResponseBody.Builder requestParameters(DescribeDeployedApiResponseBody.RequestParameters requestParameters)
```
    The parameters of API requests sent by the consumer to API Gateway.
    For more information, see [RequestParameter](~~43986~~).
  - resultBodyModel
```
public DescribeDeployedApiResponseBody.Builder resultBodyModel(String resultBodyModel)
```
    The return description of the API.
  - resultDescriptions
```
public DescribeDeployedApiResponseBody.Builder resultDescriptions(DescribeDeployedApiResponseBody.ResultDescriptions resultDescriptions)
```
    The returned description of the API.
  - resultSample
```
public DescribeDeployedApiResponseBody.Builder resultSample(String resultSample)
```
    The sample response from the backend service.
  - resultType
```
public DescribeDeployedApiResponseBody.Builder resultType(String resultType)
```
    The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.
  - serviceConfig
```
public DescribeDeployedApiResponseBody.Builder serviceConfig(DescribeDeployedApiResponseBody.ServiceConfig serviceConfig)
```
    The configuration items of API requests sent by API Gateway to the backend service.
    For more information, see [ServiceConfig](~~43987~~).
  - serviceParameters
```
public DescribeDeployedApiResponseBody.Builder serviceParameters(DescribeDeployedApiResponseBody.ServiceParameters serviceParameters)
```
    The parameters of API requests sent by API Gateway to the backend service.
    For more information, see [ServiceParameter](~~43988~~).
  - serviceParametersMap
```
public DescribeDeployedApiResponseBody.Builder serviceParametersMap(DescribeDeployedApiResponseBody.ServiceParametersMap 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~~).
  - stageName
```
public DescribeDeployedApiResponseBody.Builder stageName(String stageName)
```
    The environment in which the API runs. Valid values:
    * **RELEASE**: the production environment * **PRE**: the pre-release environment * **TEST**: the test environment
  - systemParameters
```
public DescribeDeployedApiResponseBody.Builder systemParameters(DescribeDeployedApiResponseBody.SystemParameters systemParameters)
```
    The system parameters.
  - visibility
```
public DescribeDeployedApiResponseBody.Builder visibility(String visibility)
```
    Indicates whether the API is 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.
  - build
```
public DescribeDeployedApiResponseBody build()
```

类 DescribeDeployedApiResponseBody.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

allowSignatureMethod

apiId

apiName

authType

constantParameters

customSystemParameters

deployedTime

description

disableInternet

errorCodeSamples

failResultSample

forceNonceCheck

groupId

groupName

openIdConnectConfig

regionId

requestConfig

requestId

requestParameters

resultBodyModel

resultDescriptions

resultSample

resultType

serviceConfig

serviceParameters

serviceParametersMap

stageName

systemParameters

visibility

build