Package io.github.cdklabs.projen.github

Class PullRequestFromPatchOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.PullRequestFromPatchOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PullRequestFromPatchOptions>

Enclosing interface:

PullRequestFromPatchOptions

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

A builder for PullRequestFromPatchOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PullRequestFromPatchOptions.Builder	assignees(List<String> assignees)	Sets the value of CreatePullRequestOptions.getAssignees()
PullRequestFromPatchOptions.Builder	baseBranch(String baseBranch)	Sets the value of CreatePullRequestOptions.getBaseBranch()
PullRequestFromPatchOptions.Builder	branchName(String branchName)	Sets the value of CreatePullRequestOptions.getBranchName()
PullRequestFromPatchOptions	build()	Builds the configured instance.
PullRequestFromPatchOptions.Builder	credentials(GithubCredentials credentials)	Sets the value of CreatePullRequestOptions.getCredentials()
PullRequestFromPatchOptions.Builder	gitIdentity(GitIdentity gitIdentity)	Sets the value of CreatePullRequestOptions.getGitIdentity()
PullRequestFromPatchOptions.Builder	jobName(String jobName)	Sets the value of PullRequestFromPatchOptions.getJobName()
PullRequestFromPatchOptions.Builder	labels(List<String> labels)	Sets the value of CreatePullRequestOptions.getLabels()
PullRequestFromPatchOptions.Builder	patch(PullRequestPatchSource patch)	Sets the value of PullRequestFromPatchOptions.getPatch()
PullRequestFromPatchOptions.Builder	pullRequestDescription(String pullRequestDescription)	Sets the value of CreatePullRequestOptions.getPullRequestDescription()
PullRequestFromPatchOptions.Builder	pullRequestTitle(String pullRequestTitle)	Sets the value of CreatePullRequestOptions.getPullRequestTitle()
PullRequestFromPatchOptions.Builder	runsOn(List<String> runsOn)	Sets the value of PullRequestFromPatchOptions.getRunsOn()
PullRequestFromPatchOptions.Builder	runsOnGroup(GroupRunnerOptions runsOnGroup)	Sets the value of PullRequestFromPatchOptions.getRunsOnGroup()
PullRequestFromPatchOptions.Builder	signoff(Boolean signoff)	Sets the value of CreatePullRequestOptions.getSignoff()
PullRequestFromPatchOptions.Builder	stepId(String stepId)	Sets the value of CreatePullRequestOptions.getStepId()
PullRequestFromPatchOptions.Builder	stepName(String stepName)	Sets the value of CreatePullRequestOptions.getStepName()
PullRequestFromPatchOptions.Builder	workflowName(String workflowName)	Sets the value of CreatePullRequestOptions.getWorkflowName()

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

patch

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder patch(PullRequestPatchSource patch)

Sets the value of PullRequestFromPatchOptions.getPatch()

Parameters:

patch - Information about the patch that is used to create the pull request. This parameter is required.

Returns:

this

jobName

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder jobName(String jobName)

Sets the value of PullRequestFromPatchOptions.getJobName()

Parameters:

jobName - The name of the job displayed on GitHub.

Returns:

this

runsOn

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

Sets the value of PullRequestFromPatchOptions.getRunsOn()

Parameters:

runsOn - Github Runner selection labels.

Returns:

this

runsOnGroup

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

Sets the value of PullRequestFromPatchOptions.getRunsOnGroup()

Parameters:

runsOnGroup - Github Runner Group selection options.

Returns:

this

pullRequestDescription

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder pullRequestDescription(String pullRequestDescription)

Sets the value of CreatePullRequestOptions.getPullRequestDescription()

Parameters:

pullRequestDescription - Description added to the pull request. This parameter is required. Providence information are automatically added.

Returns:

this

pullRequestTitle

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder pullRequestTitle(String pullRequestTitle)

Sets the value of CreatePullRequestOptions.getPullRequestTitle()

Parameters:

pullRequestTitle - The full title used to create the pull request. This parameter is required. If PR titles are validated in this repo, the title should comply with the respective rules.

Returns:

this

workflowName

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder workflowName(String workflowName)

Sets the value of CreatePullRequestOptions.getWorkflowName()

Parameters:

workflowName - The name of the workflow that will create the PR. This parameter is required.

Returns:

this

assignees

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder assignees(List<String> assignees)

Sets the value of CreatePullRequestOptions.getAssignees()

Parameters:

assignees - Assignees to add on the PR.

Returns:

this

baseBranch

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder baseBranch(String baseBranch)

Sets the value of CreatePullRequestOptions.getBaseBranch()

Parameters:

baseBranch - Sets the pull request base branch.

Returns:

this

branchName

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder branchName(String branchName)

Sets the value of CreatePullRequestOptions.getBranchName()

Parameters:

branchName - The pull request branch name.

Returns:

this

credentials

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder credentials(GithubCredentials credentials)

Sets the value of CreatePullRequestOptions.getCredentials()

Parameters:

credentials - The job credentials used to create the pull request. Provided credentials must have permissions to create a pull request on the repository.

Returns:

this

gitIdentity

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

Sets the value of CreatePullRequestOptions.getGitIdentity()

Parameters:

gitIdentity - The git identity used to create the commit.

Returns:

this

labels

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder labels(List<String> labels)

Sets the value of CreatePullRequestOptions.getLabels()

Parameters:

labels - Labels to apply on the PR.

Returns:

this

signoff

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder signoff(Boolean signoff)

Sets the value of CreatePullRequestOptions.getSignoff()

Parameters:

signoff - Add Signed-off-by line by the committer at the end of the commit log message.

Returns:

this

stepId

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder stepId(String stepId)

Sets the value of CreatePullRequestOptions.getStepId()

Parameters:

stepId - The step ID which produces the output which indicates if a patch was created.

Returns:

this

stepName

@Stability(Experimental)
public PullRequestFromPatchOptions.Builder stepName(String stepName)

Sets the value of CreatePullRequestOptions.getStepName()

Parameters:

stepName - The name of the step displayed on GitHub.

Returns:

this

build

@Stability(Experimental)
public PullRequestFromPatchOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PullRequestFromPatchOptions

Throws:

NullPointerException - if any required attribute was not provided