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 Default value of API frontend parameter.
String	getDesc() Get API frontend parameter remarks.
String	getName() Get API frontend parameter name.
String	getPosition() Get Position of the API frontend parameter, such as the header.
Boolean	getRequired() Get Whether the API frontend parameter is required.
String	getType() Get API frontend parameter type, such as `String` and `int`.
void	setDefaultValue(String DefaultValue) Set Default value of API frontend parameter.
void	setDesc(String Desc) Set API frontend parameter remarks.
void	setName(String Name) Set API frontend parameter name.
void	setPosition(String Position) Set Position of the API frontend parameter, such as the header.
void	setRequired(Boolean Required) Set Whether the API frontend parameter is required.
void	setType(String Type) Set API frontend parameter type, such as `String` and `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, 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 frontend parameter name.

Returns:

Name API frontend parameter name.

setName

public void setName(String Name)

Set API frontend parameter name.

Parameters:

Name - API frontend parameter name.

getPosition

public String getPosition()

Get Position of the API frontend parameter, such as the header. Supported values: `header`, `query`, and `path`.

Returns:

Position Position of the API frontend parameter, such as the header. Supported values: `header`, `query`, and `path`.

setPosition

public void setPosition(String Position)

Set Position of the API frontend parameter, such as the header. Supported values: `header`, `query`, and `path`.

Parameters:

Position - Position of the API frontend parameter, such as the header. Supported values: `header`, `query`, and `path`.

getType

public String getType()

Get API frontend parameter type, such as `String` and `int`.

Returns:

Type API frontend parameter type, such as `String` and `int`.

setType

public void setType(String Type)

Set API frontend parameter type, such as `String` and `int`.

Parameters:

Type - API frontend parameter type, such as `String` and `int`.

getDefaultValue

public String getDefaultValue()

Get Default value of API frontend parameter.

Returns:

DefaultValue Default value of API frontend parameter.

setDefaultValue

public void setDefaultValue(String DefaultValue)

Set Default value of API frontend parameter.

Parameters:

DefaultValue - Default value of API frontend parameter.

getRequired

public Boolean getRequired()

Get Whether the API frontend parameter is required. True: yes; False: no.

Returns:

Required Whether the API frontend parameter is required. True: yes; False: no.

setRequired

public void setRequired(Boolean Required)

Set Whether the API frontend parameter is required. True: yes; False: no.

Parameters:

Required - Whether the API frontend parameter is required. True: yes; False: no.

getDesc

public String getDesc()

Get API frontend parameter remarks.

Returns:

Desc API frontend parameter remarks.

setDesc

public void setDesc(String Desc)

Set API frontend parameter remarks.

Parameters:

Desc - API frontend parameter remarks.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel