RosApiProps

Properties for defining a RosApi.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-api

Initializer

import com.aliyun.ros.cdk.apigateway.RosApiProps;
RosApiProps.builder()
    .apiName(java.lang.String)
    .apiName(IResolvable)
    .groupId(java.lang.String)
    .groupId(IResolvable)
    .requestConfig(IResolvable)
    .requestConfig(RequestConfigProperty)
    .serviceConfig(IResolvable)
    .serviceConfig(ServiceConfigProperty)
    .visibility(java.lang.String)
    .visibility(IResolvable)
//  .allowSignatureMethod(java.lang.String)
//  .allowSignatureMethod(IResolvable)
//  .appCodeAuthType(java.lang.String)
//  .appCodeAuthType(IResolvable)
//  .authType(java.lang.String)
//  .authType(IResolvable)
//  .constParameters(IResolvable)
//  .constParameters(java.util.List<IResolvable)
//  .constParameters(ConstParametersProperty>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disableInternet(java.lang.Boolean)
//  .disableInternet(IResolvable)
//  .errorCodeSamples(IResolvable)
//  .errorCodeSamples(java.util.List<IResolvable)
//  .errorCodeSamples(ErrorCodeSamplesProperty>)
//  .failResultSample(java.lang.String)
//  .failResultSample(IResolvable)
//  .forceNonceCheck(java.lang.Boolean)
//  .forceNonceCheck(IResolvable)
//  .openIdConnectConfig(IResolvable)
//  .openIdConnectConfig(OpenIdConnectConfigProperty)
//  .requestParameters(IResolvable)
//  .requestParameters(java.util.List<IResolvable)
//  .requestParameters(RequestParametersProperty>)
//  .resultBodyModel(java.lang.String)
//  .resultBodyModel(IResolvable)
//  .resultDescriptions(java.lang.String)
//  .resultDescriptions(IResolvable)
//  .resultSample(java.lang.String)
//  .resultSample(IResolvable)
//  .resultType(java.lang.String)
//  .resultType(IResolvable)
//  .serviceParameters(IResolvable)
//  .serviceParameters(java.util.List<IResolvable)
//  .serviceParameters(ServiceParametersProperty>)
//  .serviceParametersMap(IResolvable)
//  .serviceParametersMap(java.util.List<IResolvable)
//  .serviceParametersMap(ServiceParametersMapProperty>)
//  .systemParameters(IResolvable)
//  .systemParameters(java.util.List<IResolvable)
//  .systemParameters(SystemParametersProperty>)
//  .tags(java.util.List<TagsProperty>)
//  .webSocketApiType(java.lang.String)
//  .webSocketApiType(IResolvable)
    .build();

Properties

apiName^Required

public java.lang.Object getApiName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

groupId^Required

public java.lang.Object getGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

requestConfig^Required

public java.lang.Object getRequestConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR RequestConfigProperty

serviceConfig^Required

public java.lang.Object getServiceConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR ServiceConfigProperty

visibility^Required

public java.lang.Object getVisibility();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

allowSignatureMethod^Optional

public java.lang.Object getAllowSignatureMethod();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

appCodeAuthType^Optional

public java.lang.Object getAppCodeAuthType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

authType^Optional

public java.lang.Object getAuthType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

constParameters^Optional

public java.lang.Object getConstParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty>

description^Optional

public java.lang.Object getDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

disableInternet^Optional

public java.lang.Object getDisableInternet();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

errorCodeSamples^Optional

public java.lang.Object getErrorCodeSamples();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty>

failResultSample^Optional

public java.lang.Object getFailResultSample();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

forceNonceCheck^Optional

public java.lang.Object getForceNonceCheck();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

openIdConnectConfig^Optional

public java.lang.Object getOpenIdConnectConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR OpenIdConnectConfigProperty

requestParameters^Optional

public java.lang.Object getRequestParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty>

resultBodyModel^Optional

public java.lang.Object getResultBodyModel();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultDescriptions^Optional

public java.lang.Object getResultDescriptions();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultSample^Optional

public java.lang.Object getResultSample();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultType^Optional

public java.lang.Object getResultType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

serviceParameters^Optional

public java.lang.Object getServiceParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty>

serviceParametersMap^Optional

public java.lang.Object getServiceParametersMap();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty>

systemParameters^Optional

public java.lang.Object getSystemParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty>

tags^Optional

public java.util.List<TagsProperty> getTags();

• Type: java.util.List<TagsProperty>

webSocketApiType^Optional

public java.lang.Object getWebSocketApiType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable