HttpApiProps
Properties for defining a HttpApi.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-httpapi
Initializer
import com.aliyun.ros.cdk.apig.HttpApiProps;
HttpApiProps.builder()
.httpApiName(java.lang.String)
.httpApiName(IResolvable)
// .agentProtocols(IResolvable)
// .agentProtocols(java.util.List<java.lang.String)
// .agentProtocols(IResolvable>)
// .aiProtocols(IResolvable)
// .aiProtocols(java.util.List<java.lang.String)
// .aiProtocols(IResolvable>)
// .authConfig(IResolvable)
// .authConfig(AuthConfigProperty)
// .basePath(java.lang.String)
// .basePath(IResolvable)
// .belongGatewayId(java.lang.String)
// .belongGatewayId(IResolvable)
// .builtinRouteNames(IResolvable)
// .builtinRouteNames(java.util.List<java.lang.String)
// .builtinRouteNames(IResolvable>)
// .deployConfigs(IResolvable)
// .deployConfigs(java.util.List<IResolvable)
// .deployConfigs(DeployConfigsProperty>)
// .description(java.lang.String)
// .description(IResolvable)
// .enableAuth(java.lang.Boolean)
// .enableAuth(IResolvable)
// .firstByteTimeout(java.lang.Number)
// .firstByteTimeout(IResolvable)
// .ingressConfig(IResolvable)
// .ingressConfig(IngressConfigProperty)
// .modelCategory(java.lang.String)
// .modelCategory(IResolvable)
// .onlyChangeConfig(java.lang.Boolean)
// .onlyChangeConfig(IResolvable)
// .protocols(IResolvable)
// .protocols(java.util.List<java.lang.String)
// .protocols(IResolvable>)
// .removeBasePathOnForward(java.lang.Boolean)
// .removeBasePathOnForward(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .strategy(java.lang.String)
// .strategy(IResolvable)
// .type(java.lang.String)
// .type(IResolvable)
// .versionConfig(IResolvable)
// .versionConfig(VersionConfigProperty)
.build();
Properties
| Name | Type | Description |
|---|---|---|
httpApiName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property httpApiName: The name of the HTTP API. |
agentProtocols | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property agentProtocols: The agent protocols of the HTTP API. |
aiProtocols | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property aiProtocols: The AI protocols of the HTTP API. |
authConfig | com.aliyun.ros.cdk.core.IResolvable OR AuthConfigProperty | Property authConfig: The authentication configuration. |
basePath | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property basePath: The base path of the HTTP API. |
belongGatewayId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property belongGatewayId: The gateway ID that the HTTP API belongs to. |
builtinRouteNames | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property builtinRouteNames: The builtin route names. |
deployConfigs | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property deployConfigs: The deploy configurations of the HTTP API. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the HTTP API. |
enableAuth | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enableAuth: Whether to enable authentication. |
firstByteTimeout | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property firstByteTimeout: The first byte timeout. |
ingressConfig | com.aliyun.ros.cdk.core.IResolvable OR IngressConfigProperty | Property ingressConfig: The ingress configuration of the HTTP API. |
modelCategory | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property modelCategory: The model category. |
onlyChangeConfig | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property onlyChangeConfig: Whether to only change config without triggering redeployment. |
protocols | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property protocols: The protocols supported by the HTTP API. |
removeBasePathOnForward | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property removeBasePathOnForward: Whether to remove the base path on forward. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group. |
strategy | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property strategy: The strategy of the HTTP API. |
type | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property type: The type of the HTTP API. |
versionConfig | com.aliyun.ros.cdk.core.IResolvable OR VersionConfigProperty | Property versionConfig: The version configuration of the HTTP API. |
httpApiNameRequired
public java.lang.Object getHttpApiName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property httpApiName: The name of the HTTP API.
agentProtocolsOptional
public java.lang.Object getAgentProtocols();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property agentProtocols: The agent protocols of the HTTP API.
aiProtocolsOptional
public java.lang.Object getAiProtocols();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property aiProtocols: The AI protocols of the HTTP API.
authConfigOptional
public java.lang.Object getAuthConfig();
- Type: com.aliyun.ros.cdk.core.IResolvable OR AuthConfigProperty
Property authConfig: The authentication configuration.
basePathOptional
public java.lang.Object getBasePath();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property basePath: The base path of the HTTP API.
belongGatewayIdOptional
public java.lang.Object getBelongGatewayId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property belongGatewayId: The gateway ID that the HTTP API belongs to.
builtinRouteNamesOptional
public java.lang.Object getBuiltinRouteNames();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property builtinRouteNames: The builtin route names.
deployConfigsOptional
public java.lang.Object getDeployConfigs();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
DeployConfigsProperty>
Property deployConfigs: The deploy configurations of the HTTP API.
descriptionOptional
public java.lang.Object getDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the HTTP API.
enableAuthOptional
public java.lang.Object getEnableAuth();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableAuth: Whether to enable authentication.
firstByteTimeoutOptional
public java.lang.Object getFirstByteTimeout();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property firstByteTimeout: The first byte timeout.
ingressConfigOptional
public java.lang.Object getIngressConfig();
- Type: com.aliyun.ros.cdk.core.IResolvable OR IngressConfigProperty
Property ingressConfig: The ingress configuration of the HTTP API.
modelCategoryOptional
public java.lang.Object getModelCategory();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property modelCategory: The model category.
onlyChangeConfigOptional
public java.lang.Object getOnlyChangeConfig();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property onlyChangeConfig: Whether to only change config without triggering redeployment.
True means only modify configuration without triggering redeployment.
protocolsOptional
public java.lang.Object getProtocols();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property protocols: The protocols supported by the HTTP API.
removeBasePathOnForwardOptional
public java.lang.Object getRemoveBasePathOnForward();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property removeBasePathOnForward: Whether to remove the base path on forward.
resourceGroupIdOptional
public java.lang.Object getResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
strategyOptional
public java.lang.Object getStrategy();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property strategy: The strategy of the HTTP API.
typeOptional
public java.lang.Object getType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property type: The type of the HTTP API.
versionConfigOptional
public java.lang.Object getVersionConfig();
- Type: com.aliyun.ros.cdk.core.IResolvable OR VersionConfigProperty
Property versionConfig: The version configuration of the HTTP API.