Assert
This class encapsulates and extends the ROS resource type ALIYUN::ROS::Assert
.
Initializers
import com.aliyun.ros.cdk.ros.Assert;
Assert.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.values(java.util.List<java.lang.Object>)
.values(IResolvable)
// .abortCreation(java.lang.Boolean)
// .abortCreation(IResolvable)
// .errorMessage(java.lang.String)
// .errorMessage(IResolvable)
// .operation(java.lang.String)
// .operation(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. |
values |
java.util.List |
Property values: A list of values to assert. |
abortCreation |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property abortCreation: Whether to abort creation when the assert fails. |
errorMessage |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property errorMessage: The error message to be returned when the assert fails. |
operation |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property operation: The type of assertion to make. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
values
Required
- Type: java.util.List
OR com.aliyun.ros.cdk.core.IResolvable
Property values: A list of values to assert.
The items in the list are compared in order. The range of length is one to three.
- Three values are supported only if the operation is Equal or NotEqual.
- One value is supported only if the operation is Not.
abortCreation
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property abortCreation: Whether to abort creation when the assert fails.
Default is True.
errorMessage
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property errorMessage: The error message to be returned when the assert fails.
operation
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property operation: The type of assertion to make.
The supported operations are: Equal, NotEqual, Greater, GreaterOrEqual, Less, LessOrEqual, Contain, NotContain, And, Or, Not. Default is Equal.
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. |
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
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.ros.Assert;
Assert.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. |
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. |
attrFailureCause |
com.aliyun.ros.cdk.core.IResolvable |
Attribute FailureCause: The reason the assertion failed. |
attrResult |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Result: The result of the assert. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
ref
Required
public java.lang.String getRef();
- Type: java.lang.String
stack
Required
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resource
Optional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrFailureCause
Required
public IResolvable getAttrFailureCause();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute FailureCause: The reason the assertion failed.
attrResult
Required
public IResolvable getAttrResult();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Result: The result of the assert.