Skip to content

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

Name Type Description
apiName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
groupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
requestConfig com.aliyun.ros.cdk.core.IResolvable OR RequestConfigProperty No description.
serviceConfig com.aliyun.ros.cdk.core.IResolvable OR ServiceConfigProperty No description.
visibility java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
allowSignatureMethod java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
appCodeAuthType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
authType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
constParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty> No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
disableInternet java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
errorCodeSamples com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty> No description.
failResultSample java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
forceNonceCheck java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
openIdConnectConfig com.aliyun.ros.cdk.core.IResolvable OR OpenIdConnectConfigProperty No description.
requestParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty> No description.
resultBodyModel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultDescriptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultSample java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resultType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serviceParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty> No description.
serviceParametersMap com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty> No description.
systemParameters com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty> No description.
tags java.util.List<TagsProperty> No description.
webSocketApiType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

apiNameRequired 

public java.lang.Object getApiName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

groupIdRequired 

public java.lang.Object getGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

requestConfigRequired 

public java.lang.Object getRequestConfig();

serviceConfigRequired 

public java.lang.Object getServiceConfig();

visibilityRequired 

public java.lang.Object getVisibility();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

allowSignatureMethodOptional 

public java.lang.Object getAllowSignatureMethod();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

appCodeAuthTypeOptional 

public java.lang.Object getAppCodeAuthType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

authTypeOptional 

public java.lang.Object getAuthType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

constParametersOptional 

public java.lang.Object getConstParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty>

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

disableInternetOptional 

public java.lang.Object getDisableInternet();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

errorCodeSamplesOptional 

public java.lang.Object getErrorCodeSamples();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty>

failResultSampleOptional 

public java.lang.Object getFailResultSample();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

forceNonceCheckOptional 

public java.lang.Object getForceNonceCheck();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

openIdConnectConfigOptional 

public java.lang.Object getOpenIdConnectConfig();

requestParametersOptional 

public java.lang.Object getRequestParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty>

resultBodyModelOptional 

public java.lang.Object getResultBodyModel();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultDescriptionsOptional 

public java.lang.Object getResultDescriptions();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultSampleOptional 

public java.lang.Object getResultSample();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resultTypeOptional 

public java.lang.Object getResultType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

serviceParametersOptional 

public java.lang.Object getServiceParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty>

serviceParametersMapOptional 

public java.lang.Object getServiceParametersMap();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty>

systemParametersOptional 

public java.lang.Object getSystemParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty>

tagsOptional 

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

webSocketApiTypeOptional 

public java.lang.Object getWebSocketApiType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable