Package io.github.cdklabs.projen.github
Class UploadArtifactOptions.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.github.UploadArtifactOptions.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<UploadArtifactOptions>
- Enclosing interface:
- UploadArtifactOptions
@Stability(Experimental) public static final class UploadArtifactOptions.Builder extends Object implements software.amazon.jsii.Builder<UploadArtifactOptions>
A builder forUploadArtifactOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
with
@Stability(Experimental) public UploadArtifactOptions.Builder with(UploadArtifactWith with)
Sets the value ofUploadArtifactOptions.getWith()- Parameters:
with- Options forupload-artifact. This parameter is required.- Returns:
this
-
continueOnError
@Stability(Experimental) public UploadArtifactOptions.Builder continueOnError(Boolean continueOnError)
Sets the value ofJobStepConfiguration.getContinueOnError()- Parameters:
continueOnError- Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.- Returns:
this
-
timeoutMinutes
@Stability(Experimental) public UploadArtifactOptions.Builder timeoutMinutes(Number timeoutMinutes)
Sets the value ofJobStepConfiguration.getTimeoutMinutes()- Parameters:
timeoutMinutes- The maximum number of minutes to run the step before killing the process.- Returns:
this
-
env
@Stability(Experimental) public UploadArtifactOptions.Builder env(Map<String,String> env)
Sets the value ofStepConfiguration.getEnv()- Parameters:
env- Sets environment variables for steps to use in the runner environment. You can also set environment variables for the entire workflow or a job.- Returns:
this
-
id
@Stability(Experimental) public UploadArtifactOptions.Builder id(String id)
Sets the value ofStepConfiguration.getId()- Parameters:
id- A unique identifier for the step. You can use the id to reference the step in contexts.- Returns:
this
-
ifValue
@Stability(Experimental) public UploadArtifactOptions.Builder ifValue(String ifValue)
Sets the value ofStepConfiguration.getIfValue()- Parameters:
ifValue- You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.- Returns:
this
-
name
@Stability(Experimental) public UploadArtifactOptions.Builder name(String name)
Sets the value ofStepConfiguration.getName()- Parameters:
name- A name for your step to display on GitHub.- Returns:
this
-
workingDirectory
@Stability(Experimental) public UploadArtifactOptions.Builder workingDirectory(String workingDirectory)
Sets the value ofStepConfiguration.getWorkingDirectory()- Parameters:
workingDirectory- Specifies a working directory for a step. Overrides a job's working directory.- Returns:
this
-
build
@Stability(Experimental) public UploadArtifactOptions build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<UploadArtifactOptions>- Returns:
- a new instance of
UploadArtifactOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-