WorkFlow

• Implements: IWorkFlow

This class encapsulates and extends the ROS resource type ALIYUN::SchedulerX::WorkFlow.

Initializers

import com.aliyun.ros.cdk.schedulerx.WorkFlow;
WorkFlow.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .groupId(java.lang.String)
    .groupId(IResolvable)
    .namespace(java.lang.String)
    .namespace(IResolvable)
    .timeType(java.lang.Number)
    .timeType(IResolvable)
    .workflowName(java.lang.String)
    .workflowName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .maxConcurrency(java.lang.Number)
//  .maxConcurrency(IResolvable)
//  .namespaceSource(java.lang.String)
//  .namespaceSource(IResolvable)
//  .timeExpression(java.lang.String)
//  .timeExpression(IResolvable)
//  .timezone(java.lang.String)
//  .timezone(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

groupId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property groupId: The application Group ID, which is obtained from the application management page of the console.

namespace^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property namespace: The namespace ID, which is obtained from the namespace page in the console.

timeType^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeType: Time type.

Currently, the following time types are supported:

• cron: 1
• api: 100.

workflowName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property workflowName: Workflow Name.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Workflow description.

maxConcurrency^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxConcurrency: The maximum number of workflow instances running at the same time.

The default value is 1, that is, the last trigger is not completed, and the next trigger will not be performed even when the running time is reached.

namespaceSource^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property namespaceSource: Special third parties are required.

timeExpression^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property timeExpression: Time expression, which is set based on the selected time type.

• cron: Fill in standard cron expressions to support online verification.
• api: No time expression.

timezone^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property timezone: Time Zone.

Methods

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.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• 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)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.schedulerx.WorkFlow;
WorkFlow.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

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

attrDescription^Required

public java.lang.Object getAttrDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: Workflow description.

attrGroupId^Required

public java.lang.Object getAttrGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GroupId: The application Group ID, which is obtained from the application management page of the console.

attrMaxConcurrency^Required

public java.lang.Object getAttrMaxConcurrency();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MaxConcurrency: The maximum number of workflow instances running at the same time.

The default value is 1, that is, the last trigger is not completed, and the next trigger will not be performed even when the running time is reached.

attrNamespace^Required

public java.lang.Object getAttrNamespace();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Namespace: The namespace ID, which is obtained from the namespace page in the console.

attrTimeExpression^Required

public java.lang.Object getAttrTimeExpression();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TimeExpression: Time expression, which is set based on the selected time type.

attrTimeType^Required

public java.lang.Object getAttrTimeType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TimeType: Time type.

attrWorkFlowId^Required

public java.lang.Object getAttrWorkFlowId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WorkFlowId: workflow id.

attrWorkflowName^Required

public java.lang.Object getAttrWorkflowName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WorkflowName: Workflow Name.

props^Required

public WorkFlowProps getProps();

• Type: WorkFlowProps

Structs