com.tencentcloudapi.apigateway.v20180808.models

Class ServiceParameter

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.apigateway.v20180808.models.ServiceParameter

public class ServiceParameter
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

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

ServiceParameter

public ServiceParameter()

ServiceParameter

public ServiceParameter(ServiceParameter 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, which is used only if `ServiceType` is `HTTP`. The frontend and backend parameter names can be different. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Name API backend service parameter name, which is used only if `ServiceType` is `HTTP`. The frontend and backend parameter names 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, which is used only if `ServiceType` is `HTTP`. The frontend and backend parameter names can be different. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Name - API backend service parameter name, which is used only if `ServiceType` is `HTTP`. The frontend and backend parameter names can be different. Note: this field may return null, indicating that no valid values can be obtained.

getPosition

public String getPosition()

Get Position of API backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. The positions of frontend and backend parameters can be different. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Position Position of API backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. The positions 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 Position of API backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. The positions of frontend and backend parameters can be different. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Position - Position of API backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. The positions 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 Position of the API frontend parameter corresponding to the backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RelevantRequestParameterPosition Position of the API frontend parameter corresponding to the backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

setRelevantRequestParameterPosition

public void setRelevantRequestParameterPosition(String RelevantRequestParameterPosition)

Set Position of the API frontend parameter corresponding to the backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RelevantRequestParameterPosition - Position of the API frontend parameter corresponding to the backend service parameter, such as `head`, which is used only if `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 API frontend parameter corresponding to the backend service parameter, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RelevantRequestParameterName Name of the API frontend parameter corresponding to the backend service parameter, which is used only if `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 API frontend parameter corresponding to the backend service parameter, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RelevantRequestParameterName - Name of the API frontend parameter corresponding to the backend service parameter, which is used only if `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, which is used only if `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, which is used only if `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, which is used only if `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, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

getRelevantRequestParameterDesc

public String getRelevantRequestParameterDesc()

Get API backend service parameter remarks, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RelevantRequestParameterDesc API backend service parameter remarks, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

setRelevantRequestParameterDesc

public void setRelevantRequestParameterDesc(String RelevantRequestParameterDesc)

Set API backend service parameter remarks, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RelevantRequestParameterDesc - API backend service parameter remarks, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

getRelevantRequestParameterType

public String getRelevantRequestParameterType()

Get API backend service parameter type, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

RelevantRequestParameterType API backend service parameter type, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

setRelevantRequestParameterType

public void setRelevantRequestParameterType(String RelevantRequestParameterType)

Set API backend service parameter type, which is used only if `ServiceType` is `HTTP`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

RelevantRequestParameterType - API backend service parameter type, which is used only if `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