com.aliyun.cloudapi20160714.models

类 DescribeApiDocResponseBody

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.cloudapi20160714.models.DescribeApiDocResponseBody

public class DescribeApiDocResponseBody
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamples
static class	DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamplesErrorCodeSample
static class	DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestConfig
static class	DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParameters
static class	DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParametersRequestParameter
static class	DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptions
static class	DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptionsResultDescription

字段概要

字段

限定符和类型	字段和说明
String	apiId The ID of the API.
String	apiName The name of the API operation.
String	authType The authentication method.
String	deployedTime The publishing time.
String	description The description of the API.
Boolean	disableInternet * If the value of **DisableInternet** is set to **true**, API calls are limited within the VPC.
DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamples	errorCodeSamples The sample error codes returned by the backend service.
String	failResultSample The sample error response from the backend service.
Boolean	forceNonceCheck * If the value of **ForceNonceCheck** is set to **true**, X-Ca-Nonce must be checked during the request.
String	groupId The ID of the API group.
String	groupName The name of the group to which the API belongs.
String	regionId The region ID of the API group.
DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestConfig	requestConfig The returned API frontend definition information.
String	requestId The ID of the request.
DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParameters	requestParameters The returned frontend request parameters.
DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptions	resultDescriptions The return descriptions of the API.
String	resultSample The sample response.
String	resultType The format of the return value.
String	stageName The name of the runtime environment.
String	visibility Indicates whether the API is public.

构造器概要

构造器

构造器和说明
DescribeApiDocResponseBody()

方法概要

方法

限定符和类型	方法和说明
static DescribeApiDocResponseBody	build(Map<String,?> map)
String	getApiId()
String	getApiName()
String	getAuthType()
String	getDeployedTime()
String	getDescription()
Boolean	getDisableInternet()
DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamples	getErrorCodeSamples()
String	getFailResultSample()
Boolean	getForceNonceCheck()
String	getGroupId()
String	getGroupName()
String	getRegionId()
DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestConfig	getRequestConfig()
String	getRequestId()
DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParameters	getRequestParameters()
DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptions	getResultDescriptions()
String	getResultSample()
String	getResultType()
String	getStageName()
String	getVisibility()
DescribeApiDocResponseBody	setApiId(String apiId)
DescribeApiDocResponseBody	setApiName(String apiName)
DescribeApiDocResponseBody	setAuthType(String authType)
DescribeApiDocResponseBody	setDeployedTime(String deployedTime)
DescribeApiDocResponseBody	setDescription(String description)
DescribeApiDocResponseBody	setDisableInternet(Boolean disableInternet)
DescribeApiDocResponseBody	setErrorCodeSamples(DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamples errorCodeSamples)
DescribeApiDocResponseBody	setFailResultSample(String failResultSample)
DescribeApiDocResponseBody	setForceNonceCheck(Boolean forceNonceCheck)
DescribeApiDocResponseBody	setGroupId(String groupId)
DescribeApiDocResponseBody	setGroupName(String groupName)
DescribeApiDocResponseBody	setRegionId(String regionId)
DescribeApiDocResponseBody	setRequestConfig(DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestConfig requestConfig)
DescribeApiDocResponseBody	setRequestId(String requestId)
DescribeApiDocResponseBody	setRequestParameters(DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParameters requestParameters)
DescribeApiDocResponseBody	setResultDescriptions(DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptions resultDescriptions)
DescribeApiDocResponseBody	setResultSample(String resultSample)
DescribeApiDocResponseBody	setResultType(String resultType)
DescribeApiDocResponseBody	setStageName(String stageName)
DescribeApiDocResponseBody	setVisibility(String visibility)

从类继承的方法 com.aliyun.tea.TeaModel

build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

apiId

@NameInMap(value="ApiId")
public String apiId

The ID of the API.

apiName

@NameInMap(value="ApiName")
public String apiName

The name of the API operation.

authType

@NameInMap(value="AuthType")
public String authType

The authentication method. Valid values: APP and ANONYMOUS. APP indicates that only Alibaba Cloud applications can call the API. ANONYMOUS indicates that anonymous users can call the API.

deployedTime

@NameInMap(value="DeployedTime")
public String deployedTime

The publishing time.

description

@NameInMap(value="Description")
public String description

The description of the API.

disableInternet

@NameInMap(value="DisableInternet")
public Boolean disableInternet

* If the value of **DisableInternet** is set to **true**, API calls are limited within the VPC.

* If the value of **DisableInternet** is set to **false**, the limit is lifted. The default value is false when you create an API.

errorCodeSamples

@NameInMap(value="ErrorCodeSamples")
public DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamples errorCodeSamples

The sample error codes returned by the backend service.

failResultSample

@NameInMap(value="FailResultSample")
public String failResultSample

The sample error response from the backend service.

forceNonceCheck

@NameInMap(value="ForceNonceCheck")
public Boolean forceNonceCheck

* If the value of **ForceNonceCheck** is set to **true**, X-Ca-Nonce must be checked during the request. This is the unique identifier of the request and is 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 value of **ForceNonceCheck** is set to **false**, the X-Ca-Nonce is not checked. The default value is false when you create an API.

groupId

@NameInMap(value="GroupId")
public String groupId

The ID of the API group.

groupName

@NameInMap(value="GroupName")
public String groupName

The name of the group to which the API belongs.

regionId

@NameInMap(value="RegionId")
public String regionId

The region ID of the API group.

requestConfig

@NameInMap(value="RequestConfig")
public DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestConfig requestConfig

The returned API frontend definition information. It is an array consisting of RequestConfig data.

requestId

@NameInMap(value="RequestId")
public String requestId

The ID of the request.

requestParameters

@NameInMap(value="RequestParameters")
public DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParameters requestParameters

The returned frontend request parameters.

resultDescriptions

@NameInMap(value="ResultDescriptions")
public DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptions resultDescriptions

The return descriptions of the API.

resultSample

@NameInMap(value="ResultSample")
public String resultSample

The sample response.

resultType

@NameInMap(value="ResultType")
public String resultType

The format of the return value.

stageName

@NameInMap(value="StageName")
public String stageName

The name of the runtime environment. Valid values:

* **RELEASE**

* **TEST**

visibility

@NameInMap(value="Visibility")
public String visibility

Indicates whether the API is public. Valid values: PUBLIC and PRIVATE.

构造器详细资料

DescribeApiDocResponseBody

public DescribeApiDocResponseBody()

方法详细资料

build

public static DescribeApiDocResponseBody build(Map<String,?> map)
                                        throws Exception

抛出:

Exception

setApiId

public DescribeApiDocResponseBody setApiId(String apiId)

getApiId

public String getApiId()

setApiName

public DescribeApiDocResponseBody setApiName(String apiName)

getApiName

public String getApiName()

setAuthType

public DescribeApiDocResponseBody setAuthType(String authType)

getAuthType

public String getAuthType()

setDeployedTime

public DescribeApiDocResponseBody setDeployedTime(String deployedTime)

getDeployedTime

public String getDeployedTime()

setDescription

public DescribeApiDocResponseBody setDescription(String description)

getDescription

public String getDescription()

setDisableInternet

public DescribeApiDocResponseBody setDisableInternet(Boolean disableInternet)

getDisableInternet

public Boolean getDisableInternet()

setErrorCodeSamples

public DescribeApiDocResponseBody setErrorCodeSamples(DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamples errorCodeSamples)

getErrorCodeSamples

public DescribeApiDocResponseBody.DescribeApiDocResponseBodyErrorCodeSamples getErrorCodeSamples()

setFailResultSample

public DescribeApiDocResponseBody setFailResultSample(String failResultSample)

getFailResultSample

public String getFailResultSample()

setForceNonceCheck

public DescribeApiDocResponseBody setForceNonceCheck(Boolean forceNonceCheck)

getForceNonceCheck

public Boolean getForceNonceCheck()

setGroupId

public DescribeApiDocResponseBody setGroupId(String groupId)

getGroupId

public String getGroupId()

setGroupName

public DescribeApiDocResponseBody setGroupName(String groupName)

getGroupName

public String getGroupName()

setRegionId

public DescribeApiDocResponseBody setRegionId(String regionId)

getRegionId

public String getRegionId()

setRequestConfig

public DescribeApiDocResponseBody setRequestConfig(DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestConfig requestConfig)

getRequestConfig

public DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestConfig getRequestConfig()

setRequestId

public DescribeApiDocResponseBody setRequestId(String requestId)

getRequestId

public String getRequestId()

setRequestParameters

public DescribeApiDocResponseBody setRequestParameters(DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParameters requestParameters)

getRequestParameters

public DescribeApiDocResponseBody.DescribeApiDocResponseBodyRequestParameters getRequestParameters()

setResultDescriptions

public DescribeApiDocResponseBody setResultDescriptions(DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptions resultDescriptions)

getResultDescriptions

public DescribeApiDocResponseBody.DescribeApiDocResponseBodyResultDescriptions getResultDescriptions()

setResultSample

public DescribeApiDocResponseBody setResultSample(String resultSample)

getResultSample

public String getResultSample()

setResultType

public DescribeApiDocResponseBody setResultType(String resultType)

getResultType

public String getResultType()

setStageName

public DescribeApiDocResponseBody setStageName(String stageName)

getStageName

public String getStageName()

setVisibility

public DescribeApiDocResponseBody setVisibility(String visibility)

getVisibility

public String getVisibility()