com.tencentcloudapi.apigateway.v20180808.models

Class DesApisStatus

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.apigateway.v20180808.models.DesApisStatus

public class DesApisStatus
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DesApisStatus()
DesApisStatus(DesApisStatus source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getApiBusinessType() Get OAuth API type, which is valid if `AuthType` is `OAUTH`.
String	getApiDesc() Get Custom API description.
String	getApiId() Get Unique API ID.
String	getApiName() Get API name.
String	getApiType() Get API type.
String	getAuthRelationApiId() Get Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`.
String	getAuthType() Get API authentication type.
String	getCreatedTime() Get Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
Boolean	getIsDebugAfterCharge() Get Whether to enable debugging after purchase (reserved field for the marketplace) Note: this field may return null, indicating that no valid values can be obtained.
String	getMethod() Get API request method, such as `GET`.
String	getModifiedTime() Get Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
OauthConfig	getOauthConfig() Get OAuth configuration information, which takes effect if `AuthType` is `OAUTH`.
String	getPath() Get API path, such as `/path`.
String	getProtocol() Get API protocol.
String[]	getRelationBuniessApiIds() Deprecated.
String	getServiceId() Get Unique service ID.
String[]	getTags() Get Information of tags associated with API.
String	getUniqVpcId() Get Unique VPC ID.
Long	getVpcId() Get VPC ID.
void	setApiBusinessType(String ApiBusinessType) Set OAuth API type, which is valid if `AuthType` is `OAUTH`.
void	setApiDesc(String ApiDesc) Set Custom API description.
void	setApiId(String ApiId) Set Unique API ID.
void	setApiName(String ApiName) Set API name.
void	setApiType(String ApiType) Set API type.
void	setAuthRelationApiId(String AuthRelationApiId) Set Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`.
void	setAuthType(String AuthType) Set API authentication type.
void	setCreatedTime(String CreatedTime) Set Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
void	setIsDebugAfterCharge(Boolean IsDebugAfterCharge) Set Whether to enable debugging after purchase (reserved field for the marketplace) Note: this field may return null, indicating that no valid values can be obtained.
void	setMethod(String Method) Set API request method, such as `GET`.
void	setModifiedTime(String ModifiedTime) Set Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard.
void	setOauthConfig(OauthConfig OauthConfig) Set OAuth configuration information, which takes effect if `AuthType` is `OAUTH`.
void	setPath(String Path) Set API path, such as `/path`.
void	setProtocol(String Protocol) Set API protocol.
void	setRelationBuniessApiIds(String[] RelationBuniessApiIds) Deprecated.
void	setServiceId(String ServiceId) Set Unique service ID.
void	setTags(String[] Tags) Set Information of tags associated with API.
void	setUniqVpcId(String UniqVpcId) Set Unique VPC ID.
void	setVpcId(Long VpcId) Set VPC ID.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

DesApisStatus

public DesApisStatus()

DesApisStatus

public DesApisStatus(DesApisStatus source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getServiceId

public String getServiceId()

Get Unique service ID.

Returns:

ServiceId Unique service ID.

setServiceId

public void setServiceId(String ServiceId)

Set Unique service ID.

Parameters:

ServiceId - Unique service ID.

getApiId

public String getApiId()

Get Unique API ID.

Returns:

ApiId Unique API ID.

setApiId

public void setApiId(String ApiId)

Set Unique API ID.

Parameters:

ApiId - Unique API ID.

getApiDesc

public String getApiDesc()

Get Custom API description. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiDesc Custom API description. Note: this field may return null, indicating that no valid values can be obtained.

setApiDesc

public void setApiDesc(String ApiDesc)

Set Custom API description. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiDesc - Custom API description. Note: this field may return null, indicating that no valid values can be obtained.

getCreatedTime

public String getCreatedTime()

Get Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

CreatedTime Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

setCreatedTime

public void setCreatedTime(String CreatedTime)

Set Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

CreatedTime - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

getModifiedTime

public String getModifiedTime()

Get Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ModifiedTime Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

setModifiedTime

public void setModifiedTime(String ModifiedTime)

Set Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ModifiedTime - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. Note: this field may return null, indicating that no valid values can be obtained.

getApiName

public String getApiName()

Get API name. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiName API name. Note: this field may return null, indicating that no valid values can be obtained.

setApiName

public void setApiName(String ApiName)

Set API name. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiName - API name. Note: this field may return null, indicating that no valid values can be obtained.

getVpcId

public Long getVpcId()

Get VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

VpcId VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

setVpcId

public void setVpcId(Long VpcId)

Set VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

VpcId - VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

getUniqVpcId

public String getUniqVpcId()

Get Unique VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

UniqVpcId Unique VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

setUniqVpcId

public void setUniqVpcId(String UniqVpcId)

Set Unique VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

UniqVpcId - Unique VPC ID. Note: this field may return null, indicating that no valid values can be obtained.

getApiType

public String getApiType()

Get API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiType API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

setApiType

public void setApiType(String ApiType)

Set API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiType - API type. Valid values: NORMAL (general API), TSF (microservice API). Note: this field may return null, indicating that no valid values can be obtained.

getProtocol

public String getProtocol()

Get API protocol. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Protocol API protocol. Note: this field may return null, indicating that no valid values can be obtained.

setProtocol

public void setProtocol(String Protocol)

Set API protocol. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Protocol - API protocol. Note: this field may return null, indicating that no valid values can be obtained.

getIsDebugAfterCharge

public Boolean getIsDebugAfterCharge()

Get Whether to enable debugging after purchase (reserved field for the marketplace) Note: this field may return null, indicating that no valid values can be obtained.

Returns:

IsDebugAfterCharge Whether to enable debugging after purchase (reserved field for the marketplace) Note: this field may return null, indicating that no valid values can be obtained.

setIsDebugAfterCharge

public void setIsDebugAfterCharge(Boolean IsDebugAfterCharge)

Set Whether to enable debugging after purchase (reserved field for the marketplace) Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

IsDebugAfterCharge - Whether to enable debugging after purchase (reserved field for the marketplace) Note: this field may return null, indicating that no valid values can be obtained.

getAuthType

public String getAuthType()

Get API authentication type. Valid values: `SECRET` (key pair authentication), `NONE` (no authentication), `OAUTH`, and `EIAM` Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

AuthType API authentication type. Valid values: `SECRET` (key pair authentication), `NONE` (no authentication), `OAUTH`, and `EIAM` Note: this field may return `null`, indicating that no valid values can be obtained.

setAuthType

public void setAuthType(String AuthType)

Set API authentication type. Valid values: `SECRET` (key pair authentication), `NONE` (no authentication), `OAUTH`, and `EIAM` Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

AuthType - API authentication type. Valid values: `SECRET` (key pair authentication), `NONE` (no authentication), `OAUTH`, and `EIAM` Note: this field may return `null`, indicating that no valid values can be obtained.

getApiBusinessType

public String getApiBusinessType()

Get OAuth API type, which is valid if `AuthType` is `OAUTH`. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ApiBusinessType OAuth API type, which is valid if `AuthType` is `OAUTH`. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

setApiBusinessType

public void setApiBusinessType(String ApiBusinessType)

Set OAuth API type, which is valid if `AuthType` is `OAUTH`. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ApiBusinessType - OAuth API type, which is valid if `AuthType` is `OAUTH`. Valid values: NORMAL (business API), OAUTH (authorization API). Note: this field may return null, indicating that no valid values can be obtained.

getAuthRelationApiId

public String getAuthRelationApiId()

Get Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

AuthRelationApiId Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API. Note: this field may return null, indicating that no valid values can be obtained.

setAuthRelationApiId

public void setAuthRelationApiId(String AuthRelationApiId)

Set Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

AuthRelationApiId - Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API. Note: this field may return null, indicating that no valid values can be obtained.

getOauthConfig

public OauthConfig getOauthConfig()

Get OAuth configuration information, which takes effect if `AuthType` is `OAUTH`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

OauthConfig OAuth configuration information, which takes effect if `AuthType` is `OAUTH`. Note: this field may return null, indicating that no valid values can be obtained.

setOauthConfig

public void setOauthConfig(OauthConfig OauthConfig)

Set OAuth configuration information, which takes effect if `AuthType` is `OAUTH`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

OauthConfig - OAuth configuration information, which takes effect if `AuthType` is `OAUTH`. Note: this field may return null, indicating that no valid values can be obtained.

getRelationBuniessApiIds

@Deprecated
public String[] getRelationBuniessApiIds()

Deprecated.

Get List of business APIs associated with authorization API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RelationBuniessApiIds List of business APIs associated with authorization API. Note: this field may return null, indicating that no valid values can be obtained.

setRelationBuniessApiIds

@Deprecated
public void setRelationBuniessApiIds(String[] RelationBuniessApiIds)

Deprecated.

Set List of business APIs associated with authorization API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RelationBuniessApiIds - List of business APIs associated with authorization API. Note: this field may return null, indicating that no valid values can be obtained.

getTags

public String[] getTags()

Get Information of tags associated with API. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Tags Information of tags associated with API. Note: this field may return null, indicating that no valid values can be obtained.

setTags

public void setTags(String[] Tags)

Set Information of tags associated with API. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Tags - Information of tags associated with API. Note: this field may return null, indicating that no valid values can be obtained.

getPath

public String getPath()

Get API path, such as `/path`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Path API path, such as `/path`. Note: this field may return null, indicating that no valid values can be obtained.

setPath

public void setPath(String Path)

Set API path, such as `/path`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Path - API path, such as `/path`. Note: this field may return null, indicating that no valid values can be obtained.

getMethod

public String getMethod()

Get API request method, such as `GET`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Method API request method, such as `GET`. Note: this field may return null, indicating that no valid values can be obtained.

setMethod

public void setMethod(String Method)

Set API request method, such as `GET`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Method - API request method, such as `GET`. Note: this field may return null, indicating that no valid values can be obtained.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.