DescribeApiResponseBody.Builder (alibabacloud-cloudapi20160714 2.2.15 API)

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

封闭类:: DescribeApiResponseBody

public static final class DescribeApiResponseBody.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DescribeApiResponseBody.Builder`	`allowSignatureMethod(String allowSignatureMethod)` The region ID of the API.
`DescribeApiResponseBody.Builder`	`apiId(String apiId)` The format of the response from the backend service.
`DescribeApiResponseBody.Builder`	`apiName(String apiName)` Specifies whether to enable backend services.
`DescribeApiResponseBody.Builder`	`appCodeAuthType(String appCodeAuthType)` If AuthType is set to APP, this value must be passed to specify the signature algorithm.
`DescribeApiResponseBody.Builder`	`authType(String authType)` The last modification time of the API.
`DescribeApiResponseBody.Builder`	`backendConfig(DescribeApiResponseBody.BackendConfig backendConfig)` The ID of the backend service.
`DescribeApiResponseBody.Builder`	`backendEnable(Boolean backendEnable)` Backend configurations
`DescribeApiResponseBody`	`build()`
`DescribeApiResponseBody.Builder`	`constantParameters(DescribeApiResponseBody.ConstantParameters constantParameters)` Description
`DescribeApiResponseBody.Builder`	`createdTime(String createdTime)` The name of the API, which is unique in the group.
`DescribeApiResponseBody.Builder`	`customSystemParameters(DescribeApiResponseBody.CustomSystemParameters customSystemParameters)` Examples
`DescribeApiResponseBody.Builder`	`deployedInfos(DescribeApiResponseBody.DeployedInfos deployedInfos)` The name of the runtime environment.
`DescribeApiResponseBody.Builder`	`description(String description)` The name of the API group.
`DescribeApiResponseBody.Builder`	`disableInternet(Boolean disableInternet)` The returned description of the API.
`DescribeApiResponseBody.Builder`	`errorCodeSamples(DescribeApiResponseBody.ErrorCodeSamples errorCodeSamples)` Error codes
`DescribeApiResponseBody.Builder`	`failResultSample(String failResultSample)` The security authentication method of the API.
`DescribeApiResponseBody.Builder`	`forceNonceCheck(Boolean forceNonceCheck)` Specifies whether to make the API public.
`DescribeApiResponseBody.Builder`	`groupId(String groupId)` Specifies whether to enable the Mock mode.
`DescribeApiResponseBody.Builder`	`groupName(String groupName)` The ID of the API group.
`DescribeApiResponseBody.Builder`	`mock(String mock)` The result returned for service mocking.
`DescribeApiResponseBody.Builder`	`mockResult(String mockResult)` The creation time of the API.
`DescribeApiResponseBody.Builder`	`modifiedTime(String modifiedTime)` The ID of the request.
`DescribeApiResponseBody.Builder`	`openIdConnectConfig(DescribeApiResponseBody.OpenIdConnectConfig openIdConnectConfig)` The OpenID Connect mode.
`DescribeApiResponseBody.Builder`	`regionId(String regionId)` Specifies whether to carry the header : X-Ca-Nonce when calling an API.
`DescribeApiResponseBody.Builder`	`requestConfig(DescribeApiResponseBody.RequestConfig requestConfig)` The body model.
`DescribeApiResponseBody.Builder`	`requestId(String requestId)` The description of the API.
`DescribeApiResponseBody.Builder`	`requestParameters(DescribeApiResponseBody.RequestParameters requestParameters)` The JSON Schema used for JSON validation when ParameterType is set to String.
`DescribeApiResponseBody.Builder`	`resultBodyModel(String resultBodyModel)` The sample response from the backend service.
`DescribeApiResponseBody.Builder`	`resultDescriptions(DescribeApiResponseBody.ResultDescriptions resultDescriptions)` The returned description of the API.
`DescribeApiResponseBody.Builder`	`resultSample(String resultSample)` If AuthType is set to APP, the valid values are: * DEFAULT: The default value that is used if no other values are passed.
`DescribeApiResponseBody.Builder`	`resultType(String resultType)` The type of the two-way communication API.
`DescribeApiResponseBody.Builder`	`serviceConfig(DescribeApiResponseBody.ServiceConfig serviceConfig)` The application name in AONE.
`DescribeApiResponseBody.Builder`	`serviceParameters(DescribeApiResponseBody.ServiceParameters serviceParameters)` The parameter location.
`DescribeApiResponseBody.Builder`	`serviceParametersMap(DescribeApiResponseBody.ServiceParametersMap serviceParametersMap)` The corresponding frontend parameter name.
`DescribeApiResponseBody.Builder`	`systemParameters(DescribeApiResponseBody.SystemParameters systemParameters)` Examples
`DescribeApiResponseBody.Builder`	`visibility(String visibility)` The sample error response from the backend service.
`DescribeApiResponseBody.Builder`	`webSocketApiType(String webSocketApiType)` Specifies whether to limit API calls to within the VPC.

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

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - allowSignatureMethod
```
public DescribeApiResponseBody.Builder allowSignatureMethod(String allowSignatureMethod)
```
    The region ID of the API.
  - apiId
```
public DescribeApiResponseBody.Builder apiId(String apiId)
```
    The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML.
  - apiName
```
public DescribeApiResponseBody.Builder apiName(String apiName)
```
    Specifies whether to enable backend services.
  - appCodeAuthType
```
public DescribeApiResponseBody.Builder appCodeAuthType(String appCodeAuthType)
```
    If **AuthType** is set to **APP**, this value must be passed to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:
    * HmacSHA256 * HmacSHA1,HmacSHA256
  - authType
```
public DescribeApiResponseBody.Builder authType(String authType)
```
    The last modification time of the API.
  - backendConfig
```
public DescribeApiResponseBody.Builder backendConfig(DescribeApiResponseBody.BackendConfig backendConfig)
```
    The ID of the backend service.
  - backendEnable
```
public DescribeApiResponseBody.Builder backendEnable(Boolean backendEnable)
```
    Backend configurations
  - constantParameters
```
public DescribeApiResponseBody.Builder constantParameters(DescribeApiResponseBody.ConstantParameters constantParameters)
```
    Description
  - createdTime
```
public DescribeApiResponseBody.Builder createdTime(String createdTime)
```
    The name of the API, which is unique in the group.
  - customSystemParameters
```
public DescribeApiResponseBody.Builder customSystemParameters(DescribeApiResponseBody.CustomSystemParameters customSystemParameters)
```
    Examples
  - deployedInfos
```
public DescribeApiResponseBody.Builder deployedInfos(DescribeApiResponseBody.DeployedInfos deployedInfos)
```
    The name of the runtime environment. Valid values: RELEASE and TEST.
  - description
```
public DescribeApiResponseBody.Builder description(String description)
```
    The name of the API group.
  - disableInternet
```
public DescribeApiResponseBody.Builder disableInternet(Boolean disableInternet)
```
    The returned description of the API.
  - errorCodeSamples
```
public DescribeApiResponseBody.Builder errorCodeSamples(DescribeApiResponseBody.ErrorCodeSamples errorCodeSamples)
```
    Error codes
  - failResultSample
```
public DescribeApiResponseBody.Builder failResultSample(String failResultSample)
```
    The security authentication method of the API. Valid values:
    * **APP**: Only authorized applications can 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 you make this API public, set API-specific throttling policies. * We recommend that you do not make the API whose security authentication method is ANONYMOUS available in Alibaba Cloud Marketplace because API Gateway cannot meter calls on the caller or limit the number of calls on the API. If you want to make the API group to which the API belongs available in Alibaba Cloud Marketplace, we recommend that you move the API to another group, set its type to PRIVATE, or set its security authentication method to APP. * **APPOPENID**: The OpenID Connect account authentication method is used. Only applications authorized by OpenID Connect can call the API. If this method is selected, the OpenIdConnectConfig parameter is required.
  - forceNonceCheck
```
public DescribeApiResponseBody.Builder forceNonceCheck(Boolean forceNonceCheck)
```
    Specifies whether to make the API 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.
  - groupId
```
public DescribeApiResponseBody.Builder groupId(String groupId)
```
    Specifies whether to enable the Mock mode. Valid values:
    * OPEN: The Mock mode is enabled. * CLOSED: The Mock mode is not enabled.
  - groupName
```
public DescribeApiResponseBody.Builder groupName(String groupName)
```
    The ID of the API group.
  - mock
```
public DescribeApiResponseBody.Builder mock(String mock)
```
    The result returned for service mocking.
  - mockResult
```
public DescribeApiResponseBody.Builder mockResult(String mockResult)
```
    The creation time of the API.
  - modifiedTime
```
public DescribeApiResponseBody.Builder modifiedTime(String modifiedTime)
```
    The ID of the request.
  - openIdConnectConfig
```
public DescribeApiResponseBody.Builder openIdConnectConfig(DescribeApiResponseBody.OpenIdConnectConfig openIdConnectConfig)
```
    The OpenID Connect mode. Valid values:
    * **IDTOKEN**: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required. * **BUSINESS**: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.
  - regionId
```
public DescribeApiResponseBody.Builder regionId(String regionId)
```
    Specifies whether to carry the header : X-Ca-Nonce when calling an API. 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 reply attacks. Valid values:
    * **true**: This field is forcibly checked when an API is requested to prevent replay attacks. * **false**: This field is not checked.
  - requestConfig
```
public DescribeApiResponseBody.Builder requestConfig(DescribeApiResponseBody.RequestConfig requestConfig)
```
    The body model.
  - requestId
```
public DescribeApiResponseBody.Builder requestId(String requestId)
```
    The description of the API.
  - requestParameters
```
public DescribeApiResponseBody.Builder requestParameters(DescribeApiResponseBody.RequestParameters requestParameters)
```
    The JSON Schema used for JSON validation when **ParameterType** is set to String.
  - resultBodyModel
```
public DescribeApiResponseBody.Builder resultBodyModel(String resultBodyModel)
```
    The sample response from the backend service.
  - resultDescriptions
```
public DescribeApiResponseBody.Builder resultDescriptions(DescribeApiResponseBody.ResultDescriptions resultDescriptions)
```
    The returned description of the API.
  - resultSample
```
public DescribeApiResponseBody.Builder resultSample(String resultSample)
```
    If **AuthType** is set to **APP**, the valid values are:
    * **DEFAULT**: The default value that is used if no other values are passed. This value means that the setting of the group is 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.
  - resultType
```
public DescribeApiResponseBody.Builder resultType(String resultType)
```
    The type of the two-way communication API. Valid values:
    * **COMMON**: general APIs * **REGISTER**: registered APIs * **UNREGISTER**: unregistered APIs * **NOTIFY**: downstream notification
  - serviceConfig
```
public DescribeApiResponseBody.Builder serviceConfig(DescribeApiResponseBody.ServiceConfig serviceConfig)
```
    The application name in AONE.
  - serviceParameters
```
public DescribeApiResponseBody.Builder serviceParameters(DescribeApiResponseBody.ServiceParameters serviceParameters)
```
    The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.
  - serviceParametersMap
```
public DescribeApiResponseBody.Builder serviceParametersMap(DescribeApiResponseBody.ServiceParametersMap serviceParametersMap)
```
    The corresponding frontend parameter name. It must be included in RequestParametersObject and matches ApiParameterName in RequestParameter data.
  - systemParameters
```
public DescribeApiResponseBody.Builder systemParameters(DescribeApiResponseBody.SystemParameters systemParameters)
```
    Examples
  - visibility
```
public DescribeApiResponseBody.Builder visibility(String visibility)
```
    The sample error response from the backend service.
  - webSocketApiType
```
public DescribeApiResponseBody.Builder webSocketApiType(String webSocketApiType)
```
    Specifies whether to limit API calls to within the VPC. Valid values:
    * **true**: Only API calls from the VPC are supported. * **false**: API calls from the VPC and Internet are both supported.
  - build
```
public DescribeApiResponseBody build()
```

类 DescribeApiResponseBody.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

allowSignatureMethod

apiId

apiName

appCodeAuthType

authType

backendConfig

backendEnable

constantParameters

createdTime

customSystemParameters

deployedInfos

description

disableInternet

errorCodeSamples

failResultSample

forceNonceCheck

groupId

groupName

mock

mockResult

modifiedTime

openIdConnectConfig

regionId

requestConfig

requestId

requestParameters

resultBodyModel

resultDescriptions

resultSample

resultType

serviceConfig

serviceParameters

serviceParametersMap

systemParameters

visibility

webSocketApiType

build