software.amazon.awscdk.services.codepipeline.actions.JenkinsAction Maven / Gradle / Ivy
Show all versions of codepipeline-actions Show documentation
package software.amazon.awscdk.services.codepipeline.actions;
/**
* Jenkins build CodePipeline Action.
*
* Example:
*
*
* JenkinsProvider jenkinsProvider;
* JenkinsAction buildAction = JenkinsAction.Builder.create()
* .actionName("JenkinsBuild")
* .jenkinsProvider(jenkinsProvider)
* .projectName("MyProject")
* .type(JenkinsActionType.BUILD)
* .build();
*
*
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/tutorials-four-stage-pipeline.html
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.74.0 (build 6d08790)", date = "2023-05-19T23:09:34.888Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.codepipeline.actions.$Module.class, fqn = "@aws-cdk/aws-codepipeline-actions.JenkinsAction")
public class JenkinsAction extends software.amazon.awscdk.services.codepipeline.actions.Action {
protected JenkinsAction(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected JenkinsAction(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public JenkinsAction(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.actions.JenkinsActionProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* This is a renamed version of the {@link IAction.bind} method.
*
* @param _scope This parameter is required.
* @param _stage This parameter is required.
* @param _options This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
protected @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.ActionConfig bound(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.Construct _scope, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.IStage _stage, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.ActionBindOptions _options) {
return software.amazon.jsii.Kernel.call(this, "bound", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.codepipeline.ActionConfig.class), new Object[] { java.util.Objects.requireNonNull(_scope, "_scope is required"), java.util.Objects.requireNonNull(_stage, "_stage is required"), java.util.Objects.requireNonNull(_options, "_options is required") });
}
/**
* A fluent builder for {@link software.amazon.awscdk.services.codepipeline.actions.JenkinsAction}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static Builder create() {
return new Builder();
}
private final software.amazon.awscdk.services.codepipeline.actions.JenkinsActionProps.Builder props;
private Builder() {
this.props = new software.amazon.awscdk.services.codepipeline.actions.JenkinsActionProps.Builder();
}
/**
* The physical, human-readable name of the Action.
*
* Note that Action names must be unique within a single Stage.
*
* @return {@code this}
* @param actionName The physical, human-readable name of the Action. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder actionName(final java.lang.String actionName) {
this.props.actionName(actionName);
return this;
}
/**
* The runOrder property for this Action.
*
* RunOrder determines the relative order in which multiple Actions in the same Stage execute.
*
* Default: 1
*
* @return {@code this}
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
* @param runOrder The runOrder property for this Action. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder runOrder(final java.lang.Number runOrder) {
this.props.runOrder(runOrder);
return this;
}
/**
* 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
*
* @return {@code this}
* @param variablesNamespace The name of the namespace to use for variables emitted by this action. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder variablesNamespace(final java.lang.String variablesNamespace) {
this.props.variablesNamespace(variablesNamespace);
return this;
}
/**
* The Jenkins Provider for this Action.
*
* @return {@code this}
* @param jenkinsProvider The Jenkins Provider for this Action. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder jenkinsProvider(final software.amazon.awscdk.services.codepipeline.actions.IJenkinsProvider jenkinsProvider) {
this.props.jenkinsProvider(jenkinsProvider);
return this;
}
/**
* The name of the project (sometimes also called job, or task) on your Jenkins installation that will be invoked by this Action.
*
* Example:
*
*
* "MyJob";
*
*
* @return {@code this}
* @param 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder projectName(final java.lang.String projectName) {
this.props.projectName(projectName);
return this;
}
/**
* The type of the Action - Build, or Test.
*
* @return {@code this}
* @param type The type of the Action - Build, or Test. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder type(final software.amazon.awscdk.services.codepipeline.actions.JenkinsActionType type) {
this.props.type(type);
return this;
}
/**
* The source to use as input for this build.
*
* @return {@code this}
* @param inputs The source to use as input for this build. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder inputs(final java.util.List inputs) {
this.props.inputs(inputs);
return this;
}
/**
* @return {@code this}
* @param outputs This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder outputs(final java.util.List outputs) {
this.props.outputs(outputs);
return this;
}
/**
* @returns a newly built instance of {@link software.amazon.awscdk.services.codepipeline.actions.JenkinsAction}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public software.amazon.awscdk.services.codepipeline.actions.JenkinsAction build() {
return new software.amazon.awscdk.services.codepipeline.actions.JenkinsAction(
this.props.build()
);
}
}
}