Package io.github.cdklabs.projen.github

Class TaskWorkflowJobOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.TaskWorkflowJobOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TaskWorkflowJobOptions>

Enclosing interface:

TaskWorkflowJobOptions

@Stability(Experimental)
public static final class TaskWorkflowJobOptions.Builder
extends Object
implements software.amazon.jsii.Builder<TaskWorkflowJobOptions>

A builder for TaskWorkflowJobOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TaskWorkflowJobOptions.Builder	artifactsDirectory(String artifactsDirectory)	Sets the value of TaskWorkflowJobOptions.getArtifactsDirectory()
TaskWorkflowJobOptions	build()	Builds the configured instance.
TaskWorkflowJobOptions.Builder	checkoutWith(CheckoutWith checkoutWith)	Sets the value of TaskWorkflowJobOptions.getCheckoutWith()
TaskWorkflowJobOptions.Builder	condition(String condition)	Sets the value of TaskWorkflowJobOptions.getCondition()
TaskWorkflowJobOptions.Builder	container(ContainerOptions container)	Sets the value of TaskWorkflowJobOptions.getContainer()
TaskWorkflowJobOptions.Builder	downloadLfs(Boolean downloadLfs)	Sets the value of TaskWorkflowJobOptions.getDownloadLfs()
TaskWorkflowJobOptions.Builder	env(Map<String,String> env)	Sets the value of TaskWorkflowJobOptions.getEnv()
TaskWorkflowJobOptions.Builder	gitIdentity(GitIdentity gitIdentity)	Sets the value of TaskWorkflowJobOptions.getGitIdentity()
TaskWorkflowJobOptions.Builder	jobDefaults(JobDefaults jobDefaults)	Sets the value of TaskWorkflowJobOptions.getJobDefaults()
TaskWorkflowJobOptions.Builder	outputs(Map<String,? extends JobStepOutput> outputs)	Sets the value of TaskWorkflowJobOptions.getOutputs()
TaskWorkflowJobOptions.Builder	permissions(JobPermissions permissions)	Sets the value of TaskWorkflowJobOptions.getPermissions()
TaskWorkflowJobOptions.Builder	postBuildSteps(List<? extends JobStep> postBuildSteps)	Sets the value of TaskWorkflowJobOptions.getPostBuildSteps()
TaskWorkflowJobOptions.Builder	preBuildSteps(List<? extends JobStep> preBuildSteps)	Sets the value of TaskWorkflowJobOptions.getPreBuildSteps()
TaskWorkflowJobOptions.Builder	preCheckoutSteps(List<? extends JobStep> preCheckoutSteps)	Sets the value of TaskWorkflowJobOptions.getPreCheckoutSteps()
TaskWorkflowJobOptions.Builder	runsOn(List<String> runsOn)	Sets the value of TaskWorkflowJobOptions.getRunsOn()
TaskWorkflowJobOptions.Builder	runsOnGroup(GroupRunnerOptions runsOnGroup)	Sets the value of TaskWorkflowJobOptions.getRunsOnGroup()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

permissions

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder permissions(JobPermissions permissions)

Sets the value of TaskWorkflowJobOptions.getPermissions()

Parameters:

permissions - Permissions for the build job. This parameter is required.

Returns:

this

artifactsDirectory

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder artifactsDirectory(String artifactsDirectory)

Sets the value of TaskWorkflowJobOptions.getArtifactsDirectory()

Parameters:

artifactsDirectory - A directory name which contains artifacts to be uploaded (e.g. dist). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail.

Returns:

this

checkoutWith

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder checkoutWith(CheckoutWith checkoutWith)

Sets the value of TaskWorkflowJobOptions.getCheckoutWith()

Parameters:

checkoutWith - Override for the with property of the source code checkout step.

Returns:

this

condition

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder condition(String condition)

Sets the value of TaskWorkflowJobOptions.getCondition()

Parameters:

condition - Adds an 'if' condition to the workflow.

Returns:

this

container

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder container(ContainerOptions container)

Sets the value of TaskWorkflowJobOptions.getContainer()

Parameters:

container - the value to be set.

Returns:

this

downloadLfs

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder downloadLfs(Boolean downloadLfs)

Sets the value of TaskWorkflowJobOptions.getDownloadLfs()

Parameters:

downloadLfs - Whether to download files from Git LFS for this workflow.

Returns:

this

env

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder env(Map<String,String> env)

Sets the value of TaskWorkflowJobOptions.getEnv()

Parameters:

env - Workflow environment variables.

Returns:

this

gitIdentity

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder gitIdentity(GitIdentity gitIdentity)

Sets the value of TaskWorkflowJobOptions.getGitIdentity()

Parameters:

gitIdentity - The git identity to use in this workflow.

Returns:

this

jobDefaults

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder jobDefaults(JobDefaults jobDefaults)

Sets the value of TaskWorkflowJobOptions.getJobDefaults()

Parameters:

jobDefaults - Default settings for all steps in the TaskWorkflow Job.

Returns:

this

outputs

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder outputs(Map<String,? extends JobStepOutput> outputs)

Sets the value of TaskWorkflowJobOptions.getOutputs()

Parameters:

outputs - Mapping of job output names to values/expressions.

Returns:

this

postBuildSteps

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)

Sets the value of TaskWorkflowJobOptions.getPostBuildSteps()

Parameters:

postBuildSteps - Actions to run after the main build step.

Returns:

this

preBuildSteps

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder preBuildSteps(List<? extends JobStep> preBuildSteps)

Sets the value of TaskWorkflowJobOptions.getPreBuildSteps()

Parameters:

preBuildSteps - Steps to run before the main build step.

Returns:

this

preCheckoutSteps

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder preCheckoutSteps(List<? extends JobStep> preCheckoutSteps)

Sets the value of TaskWorkflowJobOptions.getPreCheckoutSteps()

Parameters:

preCheckoutSteps - Initial steps to run before the source code checkout.

Returns:

this

runsOn

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder runsOn(List<String> runsOn)

Sets the value of TaskWorkflowJobOptions.getRunsOn()

Parameters:

runsOn - Github Runner selection labels.

Returns:

this

runsOnGroup

@Stability(Experimental)
public TaskWorkflowJobOptions.Builder runsOnGroup(GroupRunnerOptions runsOnGroup)

Sets the value of TaskWorkflowJobOptions.getRunsOnGroup()

Parameters:

runsOnGroup - Github Runner Group selection options.

Returns:

this

build

@Stability(Experimental)
public TaskWorkflowJobOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TaskWorkflowJobOptions

Throws:

NullPointerException - if any required attribute was not provided