PluginClass
- Implements: IPluginClass
This class encapsulates and extends the ROS resource type ALIYUN::APIG::PluginClass.
Initializers
import com.aliyun.ros.cdk.apig.PluginClass;
PluginClass.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.description(java.lang.String)
.description(IResolvable)
.executePriority(java.lang.Number)
.executePriority(IResolvable)
.executeStage(java.lang.String)
.executeStage(IResolvable)
.pluginClassName(java.lang.String)
.pluginClassName(IResolvable)
.version(java.lang.String)
.version(IResolvable)
.versionDescription(java.lang.String)
.versionDescription(IResolvable)
.wasmLanguage(java.lang.String)
.wasmLanguage(IResolvable)
.wasmUrl(java.lang.String)
.wasmUrl(IResolvable)
// .alias(java.lang.String)
// .alias(IResolvable)
// .supportedMinGatewayVersion(java.lang.String)
// .supportedMinGatewayVersion(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the plugin class. |
executePriority | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property executePriority: The execute priority of the Plugin. |
executeStage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property executeStage: The Execution stage. |
pluginClassName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property pluginClassName: The name of the plugin class. |
version | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property version: The version of plugin class. |
versionDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property versionDescription: The description of the version . |
wasmLanguage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property wasmLanguage: the language of the wasm. |
wasmUrl | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property wasmUrl: The url of the wasm. |
alias | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property alias: The alias of the plugin class. |
supportedMinGatewayVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property supportedMinGatewayVersion: The supported minimum gateway version. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
descriptionRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the plugin class.
executePriorityRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property executePriority: The execute priority of the Plugin.
executeStageRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property executeStage: The Execution stage.
pluginClassNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property pluginClassName: The name of the plugin class.
versionRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property version: The version of plugin class.
versionDescriptionRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property versionDescription: The description of the version .
wasmLanguageRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property wasmLanguage: the language of the wasm.
wasmUrlRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property wasmUrl: The url of the wasm.
aliasOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property alias: The alias of the plugin class.
supportedMinGatewayVersionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property supportedMinGatewayVersion: The supported minimum gateway version.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.apig.PluginClass;
PluginClass.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrAlias | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Alias: The alias of the plugin class. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the plugin class. |
attrDocument | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Document: The document of plugin. |
attrPluginClassName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PluginClassName: The name of the plugin class. |
attrType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Type: The type of the plugin class. |
attrWasmLanguage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute WasmLanguage: Wasm language. |
props | PluginClassProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrAliasRequired
public java.lang.Object getAttrAlias();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Alias: The alias of the plugin class.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the plugin class.
attrDocumentRequired
public java.lang.Object getAttrDocument();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Document: The document of plugin.
attrPluginClassNameRequired
public java.lang.Object getAttrPluginClassName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PluginClassName: The name of the plugin class.
attrTypeRequired
public java.lang.Object getAttrType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Type: The type of the plugin class.
attrWasmLanguageRequired
public java.lang.Object getAttrWasmLanguage();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute WasmLanguage: Wasm language.
propsRequired
public PluginClassProps getProps();
- Type: PluginClassProps