com.tencentcloudapi.apigateway.v20180808.models

Class ReqParameter

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.apigateway.v20180808.models.ReqParameter

public class ReqParameter
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ReqParameter()
ReqParameter(ReqParameter 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	getDefaultValue() Get API 的前端参数默认值。
String	getDesc() Get API 的前端参数备注。
String	getName() Get API 的前端参数名称。
String	getPosition() Get API 的前端参数位置，如 header。目前支持 header、query、path。
Boolean	getRequired() Get API 的前端参数是否必填，True：表示必填，False：表示可选。
String	getType() Get API 的前端参数类型，如 String、int。
void	setDefaultValue(String DefaultValue) Set API 的前端参数默认值。
void	setDesc(String Desc) Set API 的前端参数备注。
void	setName(String Name) Set API 的前端参数名称。
void	setPosition(String Position) Set API 的前端参数位置，如 header。目前支持 header、query、path。
void	setRequired(Boolean Required) Set API 的前端参数是否必填，True：表示必填，False：表示可选。
void	setType(String Type) Set API 的前端参数类型，如 String、int。
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

ReqParameter

public ReqParameter()

ReqParameter

public ReqParameter(ReqParameter 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

getName

public String getName()

Get API 的前端参数名称。

Returns:

Name API 的前端参数名称。

setName

public void setName(String Name)

Set API 的前端参数名称。

Parameters:

Name - API 的前端参数名称。

getPosition

public String getPosition()

Get API 的前端参数位置，如 header。目前支持 header、query、path。

Returns:

Position API 的前端参数位置，如 header。目前支持 header、query、path。

setPosition

public void setPosition(String Position)

Set API 的前端参数位置，如 header。目前支持 header、query、path。

Parameters:

Position - API 的前端参数位置，如 header。目前支持 header、query、path。

getType

public String getType()

Get API 的前端参数类型，如 String、int。

Returns:

Type API 的前端参数类型，如 String、int。

setType

public void setType(String Type)

Set API 的前端参数类型，如 String、int。

Parameters:

Type - API 的前端参数类型，如 String、int。

getDefaultValue

public String getDefaultValue()

Get API 的前端参数默认值。

Returns:

DefaultValue API 的前端参数默认值。

setDefaultValue

public void setDefaultValue(String DefaultValue)

Set API 的前端参数默认值。

Parameters:

DefaultValue - API 的前端参数默认值。

getRequired

public Boolean getRequired()

Get API 的前端参数是否必填，True：表示必填，False：表示可选。

Returns:

Required API 的前端参数是否必填，True：表示必填，False：表示可选。

setRequired

public void setRequired(Boolean Required)

Set API 的前端参数是否必填，True：表示必填，False：表示可选。

Parameters:

Required - API 的前端参数是否必填，True：表示必填，False：表示可选。

getDesc

public String getDesc()

Get API 的前端参数备注。

Returns:

Desc API 的前端参数备注。

setDesc

public void setDesc(String Desc)

Set API 的前端参数备注。

Parameters:

Desc - API 的前端参数备注。

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.