DeliverTask
- Implements: IDeliverTask
This class encapsulates and extends the ROS resource type ALIYUN::ARMS::DeliverTask, which is used to create a delivery task.
Initializers
import com.aliyun.ros.cdk.arms.DeliverTask;
DeliverTask.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.targetList(IResolvable)
.targetList(java.util.List<IResolvable)
.targetList(TargetListProperty>)
.taskName(java.lang.String)
.taskName(IResolvable)
// .dataSourceId(java.lang.String)
// .dataSourceId(IResolvable)
// .dataSourceName(java.lang.String)
// .dataSourceName(IResolvable)
// .externalLabel(java.lang.String)
// .externalLabel(IResolvable)
// .filterList(java.lang.String)
// .filterList(IResolvable)
// .filterType(java.lang.Boolean)
// .filterType(IResolvable)
// .taskDescription(java.lang.String)
// .taskDescription(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. |
targetList | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property targetList: The list of the target. |
taskName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property taskName: The name of the task. |
dataSourceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dataSourceId: The ID of the data source. |
dataSourceName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dataSourceName: The name of the data source. |
externalLabel | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property externalLabel: The external label of the task. |
filterList | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property filterList: Set metrics to filter, support for regular expressions, multiple line breaks, and multiple conditions to deliver. |
filterType | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property filterType: Whether the data filtering adopts the whitelist mechanism. |
taskDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property taskDescription: The description of the task. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
targetListRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
TargetListProperty>
Property targetList: The list of the target.
taskNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property taskName: The name of the task.
dataSourceIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dataSourceId: The ID of the data source.
dataSourceNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dataSourceName: The name of the data source.
externalLabelOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property externalLabel: The external label of the task.
filterListOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property filterList: Set metrics to filter, support for regular expressions, multiple line breaks, and multiple conditions to deliver.
filterTypeOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property filterType: Whether the data filtering adopts the whitelist mechanism.
Default value: true.
taskDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property taskDescription: The description of the task.
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.arms.DeliverTask;
DeliverTask.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. |
attrTaskId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TaskId: The ID of the task. |
props | DeliverTaskProps | 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
attrTaskIdRequired
public java.lang.Object getAttrTaskId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TaskId: The ID of the task.
propsRequired
public DeliverTaskProps getProps();
- Type: DeliverTaskProps