Package io.github.cdklabs.projen.github

Class PullRequestPatchSource.Builder

java.lang.Object

io.github.cdklabs.projen.github.PullRequestPatchSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PullRequestPatchSource>

Enclosing interface:

PullRequestPatchSource

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

A builder for PullRequestPatchSource

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PullRequestPatchSource	build()	Builds the configured instance.
PullRequestPatchSource.Builder	fetchDepth(Number fetchDepth)	Sets the value of CheckoutWith.getFetchDepth()
PullRequestPatchSource.Builder	jobId(String jobId)	Sets the value of PullRequestPatchSource.getJobId()
PullRequestPatchSource.Builder	lfs(Boolean lfs)	Sets the value of CheckoutWith.getLfs()
PullRequestPatchSource.Builder	outputName(String outputName)	Sets the value of PullRequestPatchSource.getOutputName()
PullRequestPatchSource.Builder	patchFile(String patchFile)	Sets the value of CheckoutWithPatchOptions.getPatchFile()
PullRequestPatchSource.Builder	ref(String ref)	Sets the value of CheckoutWith.getRef()
PullRequestPatchSource.Builder	repository(String repository)	Sets the value of CheckoutWith.getRepository()
PullRequestPatchSource.Builder	token(String token)	Sets the value of CheckoutWith.getToken()

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

jobId

@Stability(Experimental)
public PullRequestPatchSource.Builder jobId(String jobId)

Sets the value of PullRequestPatchSource.getJobId()

Parameters:

jobId - The id of the job that created the patch file. This parameter is required.

Returns:

this

outputName

@Stability(Experimental)
public PullRequestPatchSource.Builder outputName(String outputName)

Sets the value of PullRequestPatchSource.getOutputName()

Parameters:

outputName - The name of the output that indicates if a patch has been created. This parameter is required.

Returns:

this

patchFile

@Stability(Experimental)
public PullRequestPatchSource.Builder patchFile(String patchFile)

Sets the value of CheckoutWithPatchOptions.getPatchFile()

Parameters:

patchFile - The name of the artifact the patch is stored as.

Returns:

this

fetchDepth

@Stability(Experimental)
public PullRequestPatchSource.Builder fetchDepth(Number fetchDepth)

Sets the value of CheckoutWith.getFetchDepth()

Parameters:

fetchDepth - Number of commits to fetch. 0 indicates all history for all branches and tags.

Returns:

this

lfs

@Stability(Experimental)
public PullRequestPatchSource.Builder lfs(Boolean lfs)

Sets the value of CheckoutWith.getLfs()

Parameters:

lfs - Whether LFS is enabled for the GitHub repository.

Returns:

this

ref

@Stability(Experimental)
public PullRequestPatchSource.Builder ref(String ref)

Sets the value of CheckoutWith.getRef()

Parameters:

ref - Branch or tag name.

Returns:

this

repository

@Stability(Experimental)
public PullRequestPatchSource.Builder repository(String repository)

Sets the value of CheckoutWith.getRepository()

Parameters:

repository - The repository (owner/repo) to use.

Returns:

this

token

@Stability(Experimental)
public PullRequestPatchSource.Builder token(String token)

Sets the value of CheckoutWith.getToken()

Parameters:

token - A GitHub token to use when checking out the repository. If the intent is to push changes back to the branch, then you must use a PAT with repo (and possibly workflows) permissions.

Returns:

this

build

@Stability(Experimental)
public PullRequestPatchSource build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PullRequestPatchSource

Throws:

NullPointerException - if any required attribute was not provided