Skip to content

PipelineRunProps

Properties for defining a PipelineRun.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipelinerun

Initializer 

import com.aliyun.ros.cdk.devops.PipelineRunProps;
PipelineRunProps.builder()
    .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();

Properties

Name Type 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.

organizationIdRequired 

public java.lang.Object getOrganizationId();
  • 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.

pipelineIdRequired 

public java.lang.Object getPipelineId();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

paramsOptional 

public java.lang.Object getParams();
  • 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.

syncOptional 

public java.lang.Object getSync();
  • 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.

timeoutOptional 

public java.lang.Object getTimeout();
  • 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.