DescribeApiDocResponseBody.Builder (alibabacloud-cloudapi20160714 3.0.21 API)

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

封闭类:: DescribeApiDocResponseBody

public static final class DescribeApiDocResponseBody.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DescribeApiDocResponseBody.Builder`	`apiId(String apiId)` The ID of the API.
`DescribeApiDocResponseBody.Builder`	`apiName(String apiName)` The name of the API
`DescribeApiDocResponseBody.Builder`	`authType(String authType)` The security authentication method.
`DescribeApiDocResponseBody`	`build()`
`DescribeApiDocResponseBody.Builder`	`deployedTime(String deployedTime)` The publishing time.
`DescribeApiDocResponseBody.Builder`	`description(String description)` The API description.
`DescribeApiDocResponseBody.Builder`	`disableInternet(Boolean disableInternet)` * Specifies whether to set DisableInternet to true to limit API calls to within the VPC.
`DescribeApiDocResponseBody.Builder`	`errorCodeSamples(DescribeApiDocResponseBody.ErrorCodeSamples errorCodeSamples)` The sample error codes returned by the backend service.
`DescribeApiDocResponseBody.Builder`	`failResultSample(String failResultSample)` The sample error response from the backend service.
`DescribeApiDocResponseBody.Builder`	`forceNonceCheck(Boolean forceNonceCheck)` * Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request.
`DescribeApiDocResponseBody.Builder`	`groupId(String groupId)` The ID of the API group.
`DescribeApiDocResponseBody.Builder`	`groupName(String groupName)` The name of the API group.
`DescribeApiDocResponseBody.Builder`	`regionId(String regionId)` The region ID of the API group.
`DescribeApiDocResponseBody.Builder`	`requestConfig(DescribeApiDocResponseBody.RequestConfig requestConfig)` The returned API frontend definition information.
`DescribeApiDocResponseBody.Builder`	`requestId(String requestId)` The ID of the request.
`DescribeApiDocResponseBody.Builder`	`requestParameters(DescribeApiDocResponseBody.RequestParameters requestParameters)` The returned frontend input parameters in the API.
`DescribeApiDocResponseBody.Builder`	`resultSample(String resultSample)` The sample response.
`DescribeApiDocResponseBody.Builder`	`resultType(String resultType)` The return value type.
`DescribeApiDocResponseBody.Builder`	`stageName(String stageName)` The name of the runtime environment.
`DescribeApiDocResponseBody.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()
```
- 方法详细资料
  - apiId
```
public DescribeApiDocResponseBody.Builder apiId(String apiId)
```
    The ID of the API.
  - apiName
```
public DescribeApiDocResponseBody.Builder apiName(String apiName)
```
    The name of the API
  - authType
```
public DescribeApiDocResponseBody.Builder authType(String authType)
```
    The security authentication method. Valid values: APP, ANONYMOUS, and APPOPENID, indicating respectively Alibaba Cloud application authentication, anonymous authentication, and third-party OpenID Connect account authentication.
  - deployedTime
```
public DescribeApiDocResponseBody.Builder deployedTime(String deployedTime)
```
    The publishing time.
  - description
```
public DescribeApiDocResponseBody.Builder description(String description)
```
    The API description.
  - disableInternet
```
public DescribeApiDocResponseBody.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 DescribeApiDocResponseBody.Builder errorCodeSamples(DescribeApiDocResponseBody.ErrorCodeSamples errorCodeSamples)
```
    The sample error codes returned by the backend service.
  - failResultSample
```
public DescribeApiDocResponseBody.Builder failResultSample(String failResultSample)
```
    The sample error response from the backend service.
  - forceNonceCheck
```
public DescribeApiDocResponseBody.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 DescribeApiDocResponseBody.Builder groupId(String groupId)
```
    The ID of the API group.
  - groupName
```
public DescribeApiDocResponseBody.Builder groupName(String groupName)
```
    The name of the API group.
  - regionId
```
public DescribeApiDocResponseBody.Builder regionId(String regionId)
```
    The region ID of the API group.
  - requestConfig
```
public DescribeApiDocResponseBody.Builder requestConfig(DescribeApiDocResponseBody.RequestConfig requestConfig)
```
    The returned API frontend definition information. It is an array consisting of RequestConfig data.
  - requestId
```
public DescribeApiDocResponseBody.Builder requestId(String requestId)
```
    The ID of the request.
  - requestParameters
```
public DescribeApiDocResponseBody.Builder requestParameters(DescribeApiDocResponseBody.RequestParameters requestParameters)
```
    The returned frontend input parameters in the API. It is an array consisting of RequestParameter data.
  - resultSample
```
public DescribeApiDocResponseBody.Builder resultSample(String resultSample)
```
    The sample response.
  - resultType
```
public DescribeApiDocResponseBody.Builder resultType(String resultType)
```
    The return value type.
  - stageName
```
public DescribeApiDocResponseBody.Builder stageName(String stageName)
```
    The name of the runtime environment. Valid values:
    * **RELEASE** * **TEST**
  - visibility
```
public DescribeApiDocResponseBody.Builder visibility(String visibility)
```
    Indicates whether the API is public. Valid values: PUBLIC and PRIVATE.
  - build
```
public DescribeApiDocResponseBody build()
```

类 DescribeApiDocResponseBody.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

apiId

apiName

authType

deployedTime

description

disableInternet

errorCodeSamples

failResultSample

forceNonceCheck

groupId

groupName

regionId

requestConfig

requestId

requestParameters

resultSample

resultType

stageName

visibility

build