com.aliyun.ros.cdk.apigateway.ApiProps Maven / Gradle / Ivy
Show all versions of ros-cdk-apigateway Show documentation
package com.aliyun.ros.cdk.apigateway;
/**
* Properties for defining a Api.
*
* See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-api
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-12-13T06:45:04.305Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.apigateway.$Module.class, fqn = "@alicloud/ros-cdk-apigateway.ApiProps")
@software.amazon.jsii.Jsii.Proxy(ApiProps.Jsii$Proxy.class)
public interface ApiProps extends software.amazon.jsii.JsiiSerializable {
/**
* Property apiName: The name of the API.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getApiName();
/**
* Property groupId: The id of the Group.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getGroupId();
/**
* Property requestConfig: The configuration of the request.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getRequestConfig();
/**
* Property serviceConfig: The configuration of the service.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getServiceConfig();
/**
* Property visibility: Whether to make the API public.
*
* "PUBLIC" or "PRIVATE".
*/
@org.jetbrains.annotations.NotNull java.lang.Object getVisibility();
/**
* Property allowSignatureMethod: If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm.
*
* If you do not specify this parameter, the default value HmacSHA256 is used. Valid values:
* HmacSHA256
* HmacSHA1,HmacSHA256
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getAllowSignatureMethod() {
return null;
}
/**
* Property appCodeAuthType: When AuthType is APP authentication, the optional values are as follows: If not passed, the default value is DEFAULT: DEFAULT: Default (set by group).
*
* DISABLE: Not allowed
* HEADER: Allow AppCode header authentication
* HEADER_QUERY: Allow AppCode header and query authentication
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getAppCodeAuthType() {
return null;
}
/**
* Property authType: Type of authorization of the API .
*
* "APP","ANONYMOUS", or "APPOPENID"
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getAuthType() {
return null;
}
/**
* Property constParameters: The const parameters.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getConstParameters() {
return null;
}
/**
* Property description: Description of the API, less than 180 characters.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getDescription() {
return null;
}
/**
* Property disableInternet: Set DisableInternet to true, only support intranet to call API.
*
* Set DisableInternet to false, then the call is not restricted.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getDisableInternet() {
return null;
}
/**
* Property errorCodeSamples: The Error Code samples.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getErrorCodeSamples() {
return null;
}
/**
* Property failResultSample: The sample of the fail result.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getFailResultSample() {
return null;
}
/**
* Property forceNonceCheck: Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when requesting, this is the unique identifier of the request, generally using UUID to identify.
*
* The API gateway will verify the validity of this parameter after receiving this parameter.
* The same value can only be used once within 15 minutes. It can effectively prevent API replay attacks.
* Set ForceNonceCheck to false, then no check.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getForceNonceCheck() {
return null;
}
/**
* Property openIdConnectConfig: The configuration of the open id.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getOpenIdConnectConfig() {
return null;
}
/**
* Property requestParameters: The request parameters.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getRequestParameters() {
return null;
}
/**
* Property resultBodyModel: The return result of the API.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getResultBodyModel() {
return null;
}
/**
* Property resultDescriptions: The return description of the API.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getResultDescriptions() {
return null;
}
/**
* Property resultSample: The sample of the result.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getResultSample() {
return null;
}
/**
* Property resultType: The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML" or "PASSTHROUGH".
*
* Default is "JSON".
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getResultType() {
return null;
}
/**
* Property serviceParameters: The service parameters.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getServiceParameters() {
return null;
}
/**
* Property serviceParametersMap: The mapping relation between (request parameters\const parameters\system parameters) and service parameters.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getServiceParametersMap() {
return null;
}
/**
* Property systemParameters: The system parameters.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getSystemParameters() {
return null;
}
/**
* Property tags: Tags to attach to instance.
*
* Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
*/
default @org.jetbrains.annotations.Nullable java.util.List getTags() {
return null;
}
/**
* Property webSocketApiType: The type of the two-way communication API.
*
* COMMON: common API
* REGISTER: registered API
* UNREGISTER: unregistered API
* NOTIFY: downstream notification API
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getWebSocketApiType() {
return null;
}
/**
* @return a {@link Builder} of {@link ApiProps}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ApiProps}
*/
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Object apiName;
java.lang.Object groupId;
java.lang.Object requestConfig;
java.lang.Object serviceConfig;
java.lang.Object visibility;
java.lang.Object allowSignatureMethod;
java.lang.Object appCodeAuthType;
java.lang.Object authType;
java.lang.Object constParameters;
java.lang.Object description;
java.lang.Object disableInternet;
java.lang.Object errorCodeSamples;
java.lang.Object failResultSample;
java.lang.Object forceNonceCheck;
java.lang.Object openIdConnectConfig;
java.lang.Object requestParameters;
java.lang.Object resultBodyModel;
java.lang.Object resultDescriptions;
java.lang.Object resultSample;
java.lang.Object resultType;
java.lang.Object serviceParameters;
java.lang.Object serviceParametersMap;
java.lang.Object systemParameters;
java.util.List tags;
java.lang.Object webSocketApiType;
/**
* Sets the value of {@link ApiProps#getApiName}
* @param apiName Property apiName: The name of the API.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter. This parameter is required.
* @return {@code this}
*/
public Builder apiName(java.lang.String apiName) {
this.apiName = apiName;
return this;
}
/**
* Sets the value of {@link ApiProps#getApiName}
* @param apiName Property apiName: The name of the API.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter. This parameter is required.
* @return {@code this}
*/
public Builder apiName(com.aliyun.ros.cdk.core.IResolvable apiName) {
this.apiName = apiName;
return this;
}
/**
* Sets the value of {@link ApiProps#getGroupId}
* @param groupId Property groupId: The id of the Group. This parameter is required.
* @return {@code this}
*/
public Builder groupId(java.lang.String groupId) {
this.groupId = groupId;
return this;
}
/**
* Sets the value of {@link ApiProps#getGroupId}
* @param groupId Property groupId: The id of the Group. This parameter is required.
* @return {@code this}
*/
public Builder groupId(com.aliyun.ros.cdk.core.IResolvable groupId) {
this.groupId = groupId;
return this;
}
/**
* Sets the value of {@link ApiProps#getRequestConfig}
* @param requestConfig Property requestConfig: The configuration of the request. This parameter is required.
* @return {@code this}
*/
public Builder requestConfig(com.aliyun.ros.cdk.core.IResolvable requestConfig) {
this.requestConfig = requestConfig;
return this;
}
/**
* Sets the value of {@link ApiProps#getRequestConfig}
* @param requestConfig Property requestConfig: The configuration of the request. This parameter is required.
* @return {@code this}
*/
public Builder requestConfig(com.aliyun.ros.cdk.apigateway.RosApi.RequestConfigProperty requestConfig) {
this.requestConfig = requestConfig;
return this;
}
/**
* Sets the value of {@link ApiProps#getServiceConfig}
* @param serviceConfig Property serviceConfig: The configuration of the service. This parameter is required.
* @return {@code this}
*/
public Builder serviceConfig(com.aliyun.ros.cdk.core.IResolvable serviceConfig) {
this.serviceConfig = serviceConfig;
return this;
}
/**
* Sets the value of {@link ApiProps#getServiceConfig}
* @param serviceConfig Property serviceConfig: The configuration of the service. This parameter is required.
* @return {@code this}
*/
public Builder serviceConfig(com.aliyun.ros.cdk.apigateway.RosApi.ServiceConfigProperty serviceConfig) {
this.serviceConfig = serviceConfig;
return this;
}
/**
* Sets the value of {@link ApiProps#getVisibility}
* @param visibility Property visibility: Whether to make the API public. This parameter is required.
* "PUBLIC" or "PRIVATE".
* @return {@code this}
*/
public Builder visibility(java.lang.String visibility) {
this.visibility = visibility;
return this;
}
/**
* Sets the value of {@link ApiProps#getVisibility}
* @param visibility Property visibility: Whether to make the API public. This parameter is required.
* "PUBLIC" or "PRIVATE".
* @return {@code this}
*/
public Builder visibility(com.aliyun.ros.cdk.core.IResolvable visibility) {
this.visibility = visibility;
return this;
}
/**
* Sets the value of {@link ApiProps#getAllowSignatureMethod}
* @param allowSignatureMethod Property allowSignatureMethod: If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm.
* If you do not specify this parameter, the default value HmacSHA256 is used. Valid values:
* HmacSHA256
* HmacSHA1,HmacSHA256
* @return {@code this}
*/
public Builder allowSignatureMethod(java.lang.String allowSignatureMethod) {
this.allowSignatureMethod = allowSignatureMethod;
return this;
}
/**
* Sets the value of {@link ApiProps#getAllowSignatureMethod}
* @param allowSignatureMethod Property allowSignatureMethod: If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm.
* If you do not specify this parameter, the default value HmacSHA256 is used. Valid values:
* HmacSHA256
* HmacSHA1,HmacSHA256
* @return {@code this}
*/
public Builder allowSignatureMethod(com.aliyun.ros.cdk.core.IResolvable allowSignatureMethod) {
this.allowSignatureMethod = allowSignatureMethod;
return this;
}
/**
* Sets the value of {@link ApiProps#getAppCodeAuthType}
* @param appCodeAuthType Property appCodeAuthType: When AuthType is APP authentication, the optional values are as follows: If not passed, the default value is DEFAULT: DEFAULT: Default (set by group).
* DISABLE: Not allowed
* HEADER: Allow AppCode header authentication
* HEADER_QUERY: Allow AppCode header and query authentication
* @return {@code this}
*/
public Builder appCodeAuthType(java.lang.String appCodeAuthType) {
this.appCodeAuthType = appCodeAuthType;
return this;
}
/**
* Sets the value of {@link ApiProps#getAppCodeAuthType}
* @param appCodeAuthType Property appCodeAuthType: When AuthType is APP authentication, the optional values are as follows: If not passed, the default value is DEFAULT: DEFAULT: Default (set by group).
* DISABLE: Not allowed
* HEADER: Allow AppCode header authentication
* HEADER_QUERY: Allow AppCode header and query authentication
* @return {@code this}
*/
public Builder appCodeAuthType(com.aliyun.ros.cdk.core.IResolvable appCodeAuthType) {
this.appCodeAuthType = appCodeAuthType;
return this;
}
/**
* Sets the value of {@link ApiProps#getAuthType}
* @param authType Property authType: Type of authorization of the API .
* "APP","ANONYMOUS", or "APPOPENID"
* @return {@code this}
*/
public Builder authType(java.lang.String authType) {
this.authType = authType;
return this;
}
/**
* Sets the value of {@link ApiProps#getAuthType}
* @param authType Property authType: Type of authorization of the API .
* "APP","ANONYMOUS", or "APPOPENID"
* @return {@code this}
*/
public Builder authType(com.aliyun.ros.cdk.core.IResolvable authType) {
this.authType = authType;
return this;
}
/**
* Sets the value of {@link ApiProps#getConstParameters}
* @param constParameters Property constParameters: The const parameters.
* @return {@code this}
*/
public Builder constParameters(com.aliyun.ros.cdk.core.IResolvable constParameters) {
this.constParameters = constParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getConstParameters}
* @param constParameters Property constParameters: The const parameters.
* @return {@code this}
*/
public Builder constParameters(java.util.List constParameters) {
this.constParameters = constParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getDescription}
* @param description Property description: Description of the API, less than 180 characters.
* @return {@code this}
*/
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link ApiProps#getDescription}
* @param description Property description: Description of the API, less than 180 characters.
* @return {@code this}
*/
public Builder description(com.aliyun.ros.cdk.core.IResolvable description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link ApiProps#getDisableInternet}
* @param disableInternet Property disableInternet: Set DisableInternet to true, only support intranet to call API.
* Set DisableInternet to false, then the call is not restricted.
* @return {@code this}
*/
public Builder disableInternet(java.lang.Boolean disableInternet) {
this.disableInternet = disableInternet;
return this;
}
/**
* Sets the value of {@link ApiProps#getDisableInternet}
* @param disableInternet Property disableInternet: Set DisableInternet to true, only support intranet to call API.
* Set DisableInternet to false, then the call is not restricted.
* @return {@code this}
*/
public Builder disableInternet(com.aliyun.ros.cdk.core.IResolvable disableInternet) {
this.disableInternet = disableInternet;
return this;
}
/**
* Sets the value of {@link ApiProps#getErrorCodeSamples}
* @param errorCodeSamples Property errorCodeSamples: The Error Code samples.
* @return {@code this}
*/
public Builder errorCodeSamples(com.aliyun.ros.cdk.core.IResolvable errorCodeSamples) {
this.errorCodeSamples = errorCodeSamples;
return this;
}
/**
* Sets the value of {@link ApiProps#getErrorCodeSamples}
* @param errorCodeSamples Property errorCodeSamples: The Error Code samples.
* @return {@code this}
*/
public Builder errorCodeSamples(java.util.List errorCodeSamples) {
this.errorCodeSamples = errorCodeSamples;
return this;
}
/**
* Sets the value of {@link ApiProps#getFailResultSample}
* @param failResultSample Property failResultSample: The sample of the fail result.
* @return {@code this}
*/
public Builder failResultSample(java.lang.String failResultSample) {
this.failResultSample = failResultSample;
return this;
}
/**
* Sets the value of {@link ApiProps#getFailResultSample}
* @param failResultSample Property failResultSample: The sample of the fail result.
* @return {@code this}
*/
public Builder failResultSample(com.aliyun.ros.cdk.core.IResolvable failResultSample) {
this.failResultSample = failResultSample;
return this;
}
/**
* Sets the value of {@link ApiProps#getForceNonceCheck}
* @param forceNonceCheck Property forceNonceCheck: Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when requesting, this is the unique identifier of the request, generally using UUID to identify.
* The API gateway will verify the validity of this parameter after receiving this parameter.
* The same value can only be used once within 15 minutes. It can effectively prevent API replay attacks.
* Set ForceNonceCheck to false, then no check.
* @return {@code this}
*/
public Builder forceNonceCheck(java.lang.Boolean forceNonceCheck) {
this.forceNonceCheck = forceNonceCheck;
return this;
}
/**
* Sets the value of {@link ApiProps#getForceNonceCheck}
* @param forceNonceCheck Property forceNonceCheck: Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when requesting, this is the unique identifier of the request, generally using UUID to identify.
* The API gateway will verify the validity of this parameter after receiving this parameter.
* The same value can only be used once within 15 minutes. It can effectively prevent API replay attacks.
* Set ForceNonceCheck to false, then no check.
* @return {@code this}
*/
public Builder forceNonceCheck(com.aliyun.ros.cdk.core.IResolvable forceNonceCheck) {
this.forceNonceCheck = forceNonceCheck;
return this;
}
/**
* Sets the value of {@link ApiProps#getOpenIdConnectConfig}
* @param openIdConnectConfig Property openIdConnectConfig: The configuration of the open id.
* @return {@code this}
*/
public Builder openIdConnectConfig(com.aliyun.ros.cdk.core.IResolvable openIdConnectConfig) {
this.openIdConnectConfig = openIdConnectConfig;
return this;
}
/**
* Sets the value of {@link ApiProps#getOpenIdConnectConfig}
* @param openIdConnectConfig Property openIdConnectConfig: The configuration of the open id.
* @return {@code this}
*/
public Builder openIdConnectConfig(com.aliyun.ros.cdk.apigateway.RosApi.OpenIdConnectConfigProperty openIdConnectConfig) {
this.openIdConnectConfig = openIdConnectConfig;
return this;
}
/**
* Sets the value of {@link ApiProps#getRequestParameters}
* @param requestParameters Property requestParameters: The request parameters.
* @return {@code this}
*/
public Builder requestParameters(com.aliyun.ros.cdk.core.IResolvable requestParameters) {
this.requestParameters = requestParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getRequestParameters}
* @param requestParameters Property requestParameters: The request parameters.
* @return {@code this}
*/
public Builder requestParameters(java.util.List requestParameters) {
this.requestParameters = requestParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultBodyModel}
* @param resultBodyModel Property resultBodyModel: The return result of the API.
* @return {@code this}
*/
public Builder resultBodyModel(java.lang.String resultBodyModel) {
this.resultBodyModel = resultBodyModel;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultBodyModel}
* @param resultBodyModel Property resultBodyModel: The return result of the API.
* @return {@code this}
*/
public Builder resultBodyModel(com.aliyun.ros.cdk.core.IResolvable resultBodyModel) {
this.resultBodyModel = resultBodyModel;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultDescriptions}
* @param resultDescriptions Property resultDescriptions: The return description of the API.
* @return {@code this}
*/
public Builder resultDescriptions(java.lang.String resultDescriptions) {
this.resultDescriptions = resultDescriptions;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultDescriptions}
* @param resultDescriptions Property resultDescriptions: The return description of the API.
* @return {@code this}
*/
public Builder resultDescriptions(com.aliyun.ros.cdk.core.IResolvable resultDescriptions) {
this.resultDescriptions = resultDescriptions;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultSample}
* @param resultSample Property resultSample: The sample of the result.
* @return {@code this}
*/
public Builder resultSample(java.lang.String resultSample) {
this.resultSample = resultSample;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultSample}
* @param resultSample Property resultSample: The sample of the result.
* @return {@code this}
*/
public Builder resultSample(com.aliyun.ros.cdk.core.IResolvable resultSample) {
this.resultSample = resultSample;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultType}
* @param resultType Property resultType: The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML" or "PASSTHROUGH".
* Default is "JSON".
* @return {@code this}
*/
public Builder resultType(java.lang.String resultType) {
this.resultType = resultType;
return this;
}
/**
* Sets the value of {@link ApiProps#getResultType}
* @param resultType Property resultType: The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML" or "PASSTHROUGH".
* Default is "JSON".
* @return {@code this}
*/
public Builder resultType(com.aliyun.ros.cdk.core.IResolvable resultType) {
this.resultType = resultType;
return this;
}
/**
* Sets the value of {@link ApiProps#getServiceParameters}
* @param serviceParameters Property serviceParameters: The service parameters.
* @return {@code this}
*/
public Builder serviceParameters(com.aliyun.ros.cdk.core.IResolvable serviceParameters) {
this.serviceParameters = serviceParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getServiceParameters}
* @param serviceParameters Property serviceParameters: The service parameters.
* @return {@code this}
*/
public Builder serviceParameters(java.util.List serviceParameters) {
this.serviceParameters = serviceParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getServiceParametersMap}
* @param serviceParametersMap Property serviceParametersMap: The mapping relation between (request parameters\const parameters\system parameters) and service parameters.
* @return {@code this}
*/
public Builder serviceParametersMap(com.aliyun.ros.cdk.core.IResolvable serviceParametersMap) {
this.serviceParametersMap = serviceParametersMap;
return this;
}
/**
* Sets the value of {@link ApiProps#getServiceParametersMap}
* @param serviceParametersMap Property serviceParametersMap: The mapping relation between (request parameters\const parameters\system parameters) and service parameters.
* @return {@code this}
*/
public Builder serviceParametersMap(java.util.List serviceParametersMap) {
this.serviceParametersMap = serviceParametersMap;
return this;
}
/**
* Sets the value of {@link ApiProps#getSystemParameters}
* @param systemParameters Property systemParameters: The system parameters.
* @return {@code this}
*/
public Builder systemParameters(com.aliyun.ros.cdk.core.IResolvable systemParameters) {
this.systemParameters = systemParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getSystemParameters}
* @param systemParameters Property systemParameters: The system parameters.
* @return {@code this}
*/
public Builder systemParameters(java.util.List systemParameters) {
this.systemParameters = systemParameters;
return this;
}
/**
* Sets the value of {@link ApiProps#getTags}
* @param tags Property tags: Tags to attach to instance.
* Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
* @return {@code this}
*/
@SuppressWarnings("unchecked")
public Builder tags(java.util.List tags) {
this.tags = (java.util.List)tags;
return this;
}
/**
* Sets the value of {@link ApiProps#getWebSocketApiType}
* @param webSocketApiType Property webSocketApiType: The type of the two-way communication API.
* COMMON: common API
* REGISTER: registered API
* UNREGISTER: unregistered API
* NOTIFY: downstream notification API
* @return {@code this}
*/
public Builder webSocketApiType(java.lang.String webSocketApiType) {
this.webSocketApiType = webSocketApiType;
return this;
}
/**
* Sets the value of {@link ApiProps#getWebSocketApiType}
* @param webSocketApiType Property webSocketApiType: The type of the two-way communication API.
* COMMON: common API
* REGISTER: registered API
* UNREGISTER: unregistered API
* NOTIFY: downstream notification API
* @return {@code this}
*/
public Builder webSocketApiType(com.aliyun.ros.cdk.core.IResolvable webSocketApiType) {
this.webSocketApiType = webSocketApiType;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ApiProps}
* @throws NullPointerException if any required attribute was not provided
*/
@Override
public ApiProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link ApiProps}
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ApiProps {
private final java.lang.Object apiName;
private final java.lang.Object groupId;
private final java.lang.Object requestConfig;
private final java.lang.Object serviceConfig;
private final java.lang.Object visibility;
private final java.lang.Object allowSignatureMethod;
private final java.lang.Object appCodeAuthType;
private final java.lang.Object authType;
private final java.lang.Object constParameters;
private final java.lang.Object description;
private final java.lang.Object disableInternet;
private final java.lang.Object errorCodeSamples;
private final java.lang.Object failResultSample;
private final java.lang.Object forceNonceCheck;
private final java.lang.Object openIdConnectConfig;
private final java.lang.Object requestParameters;
private final java.lang.Object resultBodyModel;
private final java.lang.Object resultDescriptions;
private final java.lang.Object resultSample;
private final java.lang.Object resultType;
private final java.lang.Object serviceParameters;
private final java.lang.Object serviceParametersMap;
private final java.lang.Object systemParameters;
private final java.util.List tags;
private final java.lang.Object webSocketApiType;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.apiName = software.amazon.jsii.Kernel.get(this, "apiName", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.groupId = software.amazon.jsii.Kernel.get(this, "groupId", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.requestConfig = software.amazon.jsii.Kernel.get(this, "requestConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.serviceConfig = software.amazon.jsii.Kernel.get(this, "serviceConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.visibility = software.amazon.jsii.Kernel.get(this, "visibility", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.allowSignatureMethod = software.amazon.jsii.Kernel.get(this, "allowSignatureMethod", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.appCodeAuthType = software.amazon.jsii.Kernel.get(this, "appCodeAuthType", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.authType = software.amazon.jsii.Kernel.get(this, "authType", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.constParameters = software.amazon.jsii.Kernel.get(this, "constParameters", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.disableInternet = software.amazon.jsii.Kernel.get(this, "disableInternet", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.errorCodeSamples = software.amazon.jsii.Kernel.get(this, "errorCodeSamples", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.failResultSample = software.amazon.jsii.Kernel.get(this, "failResultSample", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.forceNonceCheck = software.amazon.jsii.Kernel.get(this, "forceNonceCheck", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.openIdConnectConfig = software.amazon.jsii.Kernel.get(this, "openIdConnectConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.requestParameters = software.amazon.jsii.Kernel.get(this, "requestParameters", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.resultBodyModel = software.amazon.jsii.Kernel.get(this, "resultBodyModel", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.resultDescriptions = software.amazon.jsii.Kernel.get(this, "resultDescriptions", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.resultSample = software.amazon.jsii.Kernel.get(this, "resultSample", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.resultType = software.amazon.jsii.Kernel.get(this, "resultType", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.serviceParameters = software.amazon.jsii.Kernel.get(this, "serviceParameters", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.serviceParametersMap = software.amazon.jsii.Kernel.get(this, "serviceParametersMap", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.systemParameters = software.amazon.jsii.Kernel.get(this, "systemParameters", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.tags = software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.apigateway.RosApi.TagsProperty.class)));
this.webSocketApiType = software.amazon.jsii.Kernel.get(this, "webSocketApiType", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.apiName = java.util.Objects.requireNonNull(builder.apiName, "apiName is required");
this.groupId = java.util.Objects.requireNonNull(builder.groupId, "groupId is required");
this.requestConfig = java.util.Objects.requireNonNull(builder.requestConfig, "requestConfig is required");
this.serviceConfig = java.util.Objects.requireNonNull(builder.serviceConfig, "serviceConfig is required");
this.visibility = java.util.Objects.requireNonNull(builder.visibility, "visibility is required");
this.allowSignatureMethod = builder.allowSignatureMethod;
this.appCodeAuthType = builder.appCodeAuthType;
this.authType = builder.authType;
this.constParameters = builder.constParameters;
this.description = builder.description;
this.disableInternet = builder.disableInternet;
this.errorCodeSamples = builder.errorCodeSamples;
this.failResultSample = builder.failResultSample;
this.forceNonceCheck = builder.forceNonceCheck;
this.openIdConnectConfig = builder.openIdConnectConfig;
this.requestParameters = builder.requestParameters;
this.resultBodyModel = builder.resultBodyModel;
this.resultDescriptions = builder.resultDescriptions;
this.resultSample = builder.resultSample;
this.resultType = builder.resultType;
this.serviceParameters = builder.serviceParameters;
this.serviceParametersMap = builder.serviceParametersMap;
this.systemParameters = builder.systemParameters;
this.tags = (java.util.List)builder.tags;
this.webSocketApiType = builder.webSocketApiType;
}
@Override
public final java.lang.Object getApiName() {
return this.apiName;
}
@Override
public final java.lang.Object getGroupId() {
return this.groupId;
}
@Override
public final java.lang.Object getRequestConfig() {
return this.requestConfig;
}
@Override
public final java.lang.Object getServiceConfig() {
return this.serviceConfig;
}
@Override
public final java.lang.Object getVisibility() {
return this.visibility;
}
@Override
public final java.lang.Object getAllowSignatureMethod() {
return this.allowSignatureMethod;
}
@Override
public final java.lang.Object getAppCodeAuthType() {
return this.appCodeAuthType;
}
@Override
public final java.lang.Object getAuthType() {
return this.authType;
}
@Override
public final java.lang.Object getConstParameters() {
return this.constParameters;
}
@Override
public final java.lang.Object getDescription() {
return this.description;
}
@Override
public final java.lang.Object getDisableInternet() {
return this.disableInternet;
}
@Override
public final java.lang.Object getErrorCodeSamples() {
return this.errorCodeSamples;
}
@Override
public final java.lang.Object getFailResultSample() {
return this.failResultSample;
}
@Override
public final java.lang.Object getForceNonceCheck() {
return this.forceNonceCheck;
}
@Override
public final java.lang.Object getOpenIdConnectConfig() {
return this.openIdConnectConfig;
}
@Override
public final java.lang.Object getRequestParameters() {
return this.requestParameters;
}
@Override
public final java.lang.Object getResultBodyModel() {
return this.resultBodyModel;
}
@Override
public final java.lang.Object getResultDescriptions() {
return this.resultDescriptions;
}
@Override
public final java.lang.Object getResultSample() {
return this.resultSample;
}
@Override
public final java.lang.Object getResultType() {
return this.resultType;
}
@Override
public final java.lang.Object getServiceParameters() {
return this.serviceParameters;
}
@Override
public final java.lang.Object getServiceParametersMap() {
return this.serviceParametersMap;
}
@Override
public final java.lang.Object getSystemParameters() {
return this.systemParameters;
}
@Override
public final java.util.List getTags() {
return this.tags;
}
@Override
public final java.lang.Object getWebSocketApiType() {
return this.webSocketApiType;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("apiName", om.valueToTree(this.getApiName()));
data.set("groupId", om.valueToTree(this.getGroupId()));
data.set("requestConfig", om.valueToTree(this.getRequestConfig()));
data.set("serviceConfig", om.valueToTree(this.getServiceConfig()));
data.set("visibility", om.valueToTree(this.getVisibility()));
if (this.getAllowSignatureMethod() != null) {
data.set("allowSignatureMethod", om.valueToTree(this.getAllowSignatureMethod()));
}
if (this.getAppCodeAuthType() != null) {
data.set("appCodeAuthType", om.valueToTree(this.getAppCodeAuthType()));
}
if (this.getAuthType() != null) {
data.set("authType", om.valueToTree(this.getAuthType()));
}
if (this.getConstParameters() != null) {
data.set("constParameters", om.valueToTree(this.getConstParameters()));
}
if (this.getDescription() != null) {
data.set("description", om.valueToTree(this.getDescription()));
}
if (this.getDisableInternet() != null) {
data.set("disableInternet", om.valueToTree(this.getDisableInternet()));
}
if (this.getErrorCodeSamples() != null) {
data.set("errorCodeSamples", om.valueToTree(this.getErrorCodeSamples()));
}
if (this.getFailResultSample() != null) {
data.set("failResultSample", om.valueToTree(this.getFailResultSample()));
}
if (this.getForceNonceCheck() != null) {
data.set("forceNonceCheck", om.valueToTree(this.getForceNonceCheck()));
}
if (this.getOpenIdConnectConfig() != null) {
data.set("openIdConnectConfig", om.valueToTree(this.getOpenIdConnectConfig()));
}
if (this.getRequestParameters() != null) {
data.set("requestParameters", om.valueToTree(this.getRequestParameters()));
}
if (this.getResultBodyModel() != null) {
data.set("resultBodyModel", om.valueToTree(this.getResultBodyModel()));
}
if (this.getResultDescriptions() != null) {
data.set("resultDescriptions", om.valueToTree(this.getResultDescriptions()));
}
if (this.getResultSample() != null) {
data.set("resultSample", om.valueToTree(this.getResultSample()));
}
if (this.getResultType() != null) {
data.set("resultType", om.valueToTree(this.getResultType()));
}
if (this.getServiceParameters() != null) {
data.set("serviceParameters", om.valueToTree(this.getServiceParameters()));
}
if (this.getServiceParametersMap() != null) {
data.set("serviceParametersMap", om.valueToTree(this.getServiceParametersMap()));
}
if (this.getSystemParameters() != null) {
data.set("systemParameters", om.valueToTree(this.getSystemParameters()));
}
if (this.getTags() != null) {
data.set("tags", om.valueToTree(this.getTags()));
}
if (this.getWebSocketApiType() != null) {
data.set("webSocketApiType", om.valueToTree(this.getWebSocketApiType()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@alicloud/ros-cdk-apigateway.ApiProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
ApiProps.Jsii$Proxy that = (ApiProps.Jsii$Proxy) o;
if (!apiName.equals(that.apiName)) return false;
if (!groupId.equals(that.groupId)) return false;
if (!requestConfig.equals(that.requestConfig)) return false;
if (!serviceConfig.equals(that.serviceConfig)) return false;
if (!visibility.equals(that.visibility)) return false;
if (this.allowSignatureMethod != null ? !this.allowSignatureMethod.equals(that.allowSignatureMethod) : that.allowSignatureMethod != null) return false;
if (this.appCodeAuthType != null ? !this.appCodeAuthType.equals(that.appCodeAuthType) : that.appCodeAuthType != null) return false;
if (this.authType != null ? !this.authType.equals(that.authType) : that.authType != null) return false;
if (this.constParameters != null ? !this.constParameters.equals(that.constParameters) : that.constParameters != null) return false;
if (this.description != null ? !this.description.equals(that.description) : that.description != null) return false;
if (this.disableInternet != null ? !this.disableInternet.equals(that.disableInternet) : that.disableInternet != null) return false;
if (this.errorCodeSamples != null ? !this.errorCodeSamples.equals(that.errorCodeSamples) : that.errorCodeSamples != null) return false;
if (this.failResultSample != null ? !this.failResultSample.equals(that.failResultSample) : that.failResultSample != null) return false;
if (this.forceNonceCheck != null ? !this.forceNonceCheck.equals(that.forceNonceCheck) : that.forceNonceCheck != null) return false;
if (this.openIdConnectConfig != null ? !this.openIdConnectConfig.equals(that.openIdConnectConfig) : that.openIdConnectConfig != null) return false;
if (this.requestParameters != null ? !this.requestParameters.equals(that.requestParameters) : that.requestParameters != null) return false;
if (this.resultBodyModel != null ? !this.resultBodyModel.equals(that.resultBodyModel) : that.resultBodyModel != null) return false;
if (this.resultDescriptions != null ? !this.resultDescriptions.equals(that.resultDescriptions) : that.resultDescriptions != null) return false;
if (this.resultSample != null ? !this.resultSample.equals(that.resultSample) : that.resultSample != null) return false;
if (this.resultType != null ? !this.resultType.equals(that.resultType) : that.resultType != null) return false;
if (this.serviceParameters != null ? !this.serviceParameters.equals(that.serviceParameters) : that.serviceParameters != null) return false;
if (this.serviceParametersMap != null ? !this.serviceParametersMap.equals(that.serviceParametersMap) : that.serviceParametersMap != null) return false;
if (this.systemParameters != null ? !this.systemParameters.equals(that.systemParameters) : that.systemParameters != null) return false;
if (this.tags != null ? !this.tags.equals(that.tags) : that.tags != null) return false;
return this.webSocketApiType != null ? this.webSocketApiType.equals(that.webSocketApiType) : that.webSocketApiType == null;
}
@Override
public final int hashCode() {
int result = this.apiName.hashCode();
result = 31 * result + (this.groupId.hashCode());
result = 31 * result + (this.requestConfig.hashCode());
result = 31 * result + (this.serviceConfig.hashCode());
result = 31 * result + (this.visibility.hashCode());
result = 31 * result + (this.allowSignatureMethod != null ? this.allowSignatureMethod.hashCode() : 0);
result = 31 * result + (this.appCodeAuthType != null ? this.appCodeAuthType.hashCode() : 0);
result = 31 * result + (this.authType != null ? this.authType.hashCode() : 0);
result = 31 * result + (this.constParameters != null ? this.constParameters.hashCode() : 0);
result = 31 * result + (this.description != null ? this.description.hashCode() : 0);
result = 31 * result + (this.disableInternet != null ? this.disableInternet.hashCode() : 0);
result = 31 * result + (this.errorCodeSamples != null ? this.errorCodeSamples.hashCode() : 0);
result = 31 * result + (this.failResultSample != null ? this.failResultSample.hashCode() : 0);
result = 31 * result + (this.forceNonceCheck != null ? this.forceNonceCheck.hashCode() : 0);
result = 31 * result + (this.openIdConnectConfig != null ? this.openIdConnectConfig.hashCode() : 0);
result = 31 * result + (this.requestParameters != null ? this.requestParameters.hashCode() : 0);
result = 31 * result + (this.resultBodyModel != null ? this.resultBodyModel.hashCode() : 0);
result = 31 * result + (this.resultDescriptions != null ? this.resultDescriptions.hashCode() : 0);
result = 31 * result + (this.resultSample != null ? this.resultSample.hashCode() : 0);
result = 31 * result + (this.resultType != null ? this.resultType.hashCode() : 0);
result = 31 * result + (this.serviceParameters != null ? this.serviceParameters.hashCode() : 0);
result = 31 * result + (this.serviceParametersMap != null ? this.serviceParametersMap.hashCode() : 0);
result = 31 * result + (this.systemParameters != null ? this.systemParameters.hashCode() : 0);
result = 31 * result + (this.tags != null ? this.tags.hashCode() : 0);
result = 31 * result + (this.webSocketApiType != null ? this.webSocketApiType.hashCode() : 0);
return result;
}
}
}