com.tencentcloudapi.apigateway.v20180808.models

Class DescribeApiResultServiceParametersInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.apigateway.v20180808.models.DescribeApiResultServiceParametersInfo

public class DescribeApiResultServiceParametersInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeApiResultServiceParametersInfo()
DescribeApiResultServiceParametersInfo(DescribeApiResultServiceParametersInfo 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 backend service parameter.
String	getName() Get API backend service parameter name.
String	getPosition() Get Location of the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`.
String	getRelevantRequestParameterDesc() Get Description of API backend service parameter.
String	getRelevantRequestParameterName() Get Name of the frontend parameter corresponding to the API backend service parameter.
String	getRelevantRequestParameterPosition() Get Location of the frontend parameter corresponding to the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`.
void	setDefaultValue(String DefaultValue) Set Default value of API backend service parameter.
void	setName(String Name) Set API backend service parameter name.
void	setPosition(String Position) Set Location of the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`.
void	setRelevantRequestParameterDesc(String RelevantRequestParameterDesc) Set Description of API backend service parameter.
void	setRelevantRequestParameterName(String RelevantRequestParameterName) Set Name of the frontend parameter corresponding to the API backend service parameter.
void	setRelevantRequestParameterPosition(String RelevantRequestParameterPosition) Set Location of the frontend parameter corresponding to the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`.
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

DescribeApiResultServiceParametersInfo

public DescribeApiResultServiceParametersInfo()

DescribeApiResultServiceParametersInfo

public DescribeApiResultServiceParametersInfo(DescribeApiResultServiceParametersInfo 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 backend service parameter name. This is only applicable when `ServiceType` is `HTTP`. Names of frontend and backend parameters can be different. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Name API backend service parameter name. This is only applicable when `ServiceType` is `HTTP`. Names of frontend and backend parameters can be different. Note: This field may return null, indicating that no valid values can be obtained.

setName

public void setName(String Name)

Set API backend service parameter name. This is only applicable when `ServiceType` is `HTTP`. Names of frontend and backend parameters can be different. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Name - API backend service parameter name. This is only applicable when `ServiceType` is `HTTP`. Names of frontend and backend parameters can be different. Note: This field may return null, indicating that no valid values can be obtained.

getPosition

public String getPosition()

Get Location of the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Configurations of frontend and backend parameters can be different. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Position Location of the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Configurations of frontend and backend parameters can be different. Note: this field may return null, indicating that no valid values can be obtained.

setPosition

public void setPosition(String Position)

Set Location of the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Configurations of frontend and backend parameters can be different. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Position - Location of the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Configurations of frontend and backend parameters can be different. Note: this field may return null, indicating that no valid values can be obtained.

getRelevantRequestParameterPosition

public String getRelevantRequestParameterPosition()

Get Location of the frontend parameter corresponding to the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

RelevantRequestParameterPosition Location of the frontend parameter corresponding to the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

setRelevantRequestParameterPosition

public void setRelevantRequestParameterPosition(String RelevantRequestParameterPosition)

Set Location of the frontend parameter corresponding to the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

RelevantRequestParameterPosition - Location of the frontend parameter corresponding to the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

getRelevantRequestParameterName

public String getRelevantRequestParameterName()

Get Name of the frontend parameter corresponding to the API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

RelevantRequestParameterName Name of the frontend parameter corresponding to the API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

setRelevantRequestParameterName

public void setRelevantRequestParameterName(String RelevantRequestParameterName)

Set Name of the frontend parameter corresponding to the API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

RelevantRequestParameterName - Name of the frontend parameter corresponding to the API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

getDefaultValue

public String getDefaultValue()

Get Default value of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DefaultValue Default value of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

setDefaultValue

public void setDefaultValue(String DefaultValue)

Set Default value of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DefaultValue - Default value of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

getRelevantRequestParameterDesc

public String getRelevantRequestParameterDesc()

Get Description of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

RelevantRequestParameterDesc Description of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

setRelevantRequestParameterDesc

public void setRelevantRequestParameterDesc(String RelevantRequestParameterDesc)

Set Description of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

RelevantRequestParameterDesc - Description of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`. 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.