software.amazon.awscdk.services.codepipeline.actions

Class JenkinsAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.JenkinsAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JenkinsAction>

Enclosing class:

JenkinsAction

@Stability(value=Stable)
public static final class JenkinsAction.Builder
extends Object
implements software.amazon.jsii.Builder<JenkinsAction>

A fluent builder for JenkinsAction.

Method Summary

Modifier and Type	Method and Description
JenkinsAction.Builder	actionName(String actionName) The physical, human-readable name of the Action.
JenkinsAction	build()
static JenkinsAction.Builder	create()
JenkinsAction.Builder	inputs(List<? extends Artifact> inputs) The source to use as input for this build.
JenkinsAction.Builder	jenkinsProvider(IJenkinsProvider jenkinsProvider) The Jenkins Provider for this Action.
JenkinsAction.Builder	outputs(List<? extends Artifact> outputs)
JenkinsAction.Builder	projectName(String projectName) The name of the project (sometimes also called job, or task) on your Jenkins installation that will be invoked by this Action.
JenkinsAction.Builder	runOrder(Number runOrder) The runOrder property for this Action.
JenkinsAction.Builder	type(JenkinsActionType type) The type of the Action - Build, or Test.
JenkinsAction.Builder	variablesNamespace(String variablesNamespace) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static JenkinsAction.Builder create()

Returns:

a new instance of JenkinsAction.Builder.

actionName

@Stability(value=Stable)
public JenkinsAction.Builder actionName(String actionName)

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public JenkinsAction.Builder runOrder(Number runOrder)

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

variablesNamespace

@Stability(value=Stable)
public JenkinsAction.Builder variablesNamespace(String variablesNamespace)

The name of the namespace to use for variables emitted by this action.

Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

jenkinsProvider

@Stability(value=Stable)
public JenkinsAction.Builder jenkinsProvider(IJenkinsProvider jenkinsProvider)

The Jenkins Provider for this Action.

Parameters:

jenkinsProvider - The Jenkins Provider for this Action. This parameter is required.

Returns:

this

projectName

@Stability(value=Stable)
public JenkinsAction.Builder projectName(String projectName)

The name of the project (sometimes also called job, or task) on your Jenkins installation that will be invoked by this Action.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "MyJob";
 

Parameters:

projectName - The name of the project (sometimes also called job, or task) on your Jenkins installation that will be invoked by this Action. This parameter is required.

Returns:

this

type

@Stability(value=Stable)
public JenkinsAction.Builder type(JenkinsActionType type)

The type of the Action - Build, or Test.

Parameters:

type - The type of the Action - Build, or Test. This parameter is required.

Returns:

this

inputs

@Stability(value=Stable)
public JenkinsAction.Builder inputs(List<? extends Artifact> inputs)

The source to use as input for this build.

Parameters:

inputs - The source to use as input for this build. This parameter is required.

Returns:

this

outputs

@Stability(value=Stable)
public JenkinsAction.Builder outputs(List<? extends Artifact> outputs)

Parameters:

outputs - This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public JenkinsAction build()

Specified by:

build in interface software.amazon.jsii.Builder<JenkinsAction>