PipelineRun

This class encapsulates and extends the ROS resource type ALIYUN::DEVOPS::PipelineRun, which is used to run a pipeline.

Initializers

import com.aliyun.ros.cdk.devops.PipelineRun;
PipelineRun.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .organizationId(java.lang.String)
    .organizationId(IResolvable)
    .pipelineId(java.lang.Number)
    .pipelineId(IResolvable)
//  .params(IResolvable)
//  .params(java.util.Map<java.lang.String, java.lang.Object>)
//  .sync(java.lang.Boolean)
//  .sync(IResolvable)
//  .timeout(java.lang.Number)
//  .timeout(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.
organizationId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links.
pipelineId	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property pipelineId: The pipeline ID, which can be obtained from the pipeline link.
params	com.aliyun.ros.cdk.core.IResolvable OR java.util.Map	Property params: Pipeline operating parameters.
sync	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property sync: Whether to wait synchronously for the result of the pipeline execution.
timeout	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property timeout: Maximum wait time for pipeline execution in minutes.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

organizationId^Required

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

Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links.

---

pipelineId^Required

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

Property pipelineId: The pipeline ID, which can be obtained from the pipeline link.

---

params^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property params: Pipeline operating parameters.

Keys:

• branchModeBranchs: Branch mode runs branches.
• envs: Running variables.
• runningBranchs: Running branches whose key is the warehouse address.
• runningTags: Running tags whose key is the warehouse address.

---

sync^Optional

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

Property sync: Whether to wait synchronously for the result of the pipeline execution.

If you select true, the resource will not be created until the pipeline is complete. Default is false. Note: Do not set this option to true when the pipeline has a pause policy configured, as publishing requires manual intervention and synchronization is not appropriate.

---

timeout^Optional

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

Property timeout: Maximum wait time for pipeline execution in minutes.

This parameter need only be configured if Sync is set to true. Default is 10.

---

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.

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

---

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

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.devops.PipelineRun;
PipelineRun.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• 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.
attrPipelineRunId	com.aliyun.ros.cdk.core.IResolvable	Attribute PipelineRunId: Pipeline run id.

---

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

---

attrPipelineRunId^Required

public IResolvable getAttrPipelineRunId();

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

Attribute PipelineRunId: Pipeline run id.

---