Package io.github.cdklabs.projen.github

Class CreatePullRequestOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.CreatePullRequestOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CreatePullRequestOptions>

Enclosing interface:

CreatePullRequestOptions

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

A builder for CreatePullRequestOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreatePullRequestOptions.Builder	assignees(List<String> assignees)	Sets the value of CreatePullRequestOptions.getAssignees()
CreatePullRequestOptions.Builder	baseBranch(String baseBranch)	Sets the value of CreatePullRequestOptions.getBaseBranch()
CreatePullRequestOptions.Builder	branchName(String branchName)	Sets the value of CreatePullRequestOptions.getBranchName()
CreatePullRequestOptions	build()	Builds the configured instance.
CreatePullRequestOptions.Builder	credentials(GithubCredentials credentials)	Sets the value of CreatePullRequestOptions.getCredentials()
CreatePullRequestOptions.Builder	gitIdentity(GitIdentity gitIdentity)	Sets the value of CreatePullRequestOptions.getGitIdentity()
CreatePullRequestOptions.Builder	labels(List<String> labels)	Sets the value of CreatePullRequestOptions.getLabels()
CreatePullRequestOptions.Builder	pullRequestDescription(String pullRequestDescription)	Sets the value of CreatePullRequestOptions.getPullRequestDescription()
CreatePullRequestOptions.Builder	pullRequestTitle(String pullRequestTitle)	Sets the value of CreatePullRequestOptions.getPullRequestTitle()
CreatePullRequestOptions.Builder	signoff(Boolean signoff)	Sets the value of CreatePullRequestOptions.getSignoff()
CreatePullRequestOptions.Builder	stepId(String stepId)	Sets the value of CreatePullRequestOptions.getStepId()
CreatePullRequestOptions.Builder	stepName(String stepName)	Sets the value of CreatePullRequestOptions.getStepName()
CreatePullRequestOptions.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

pullRequestDescription

@Stability(Experimental)
public CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions.Builder baseBranch(String baseBranch)

Sets the value of CreatePullRequestOptions.getBaseBranch()

Parameters:

baseBranch - Sets the pull request base branch.

Returns:

this

branchName

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

Sets the value of CreatePullRequestOptions.getBranchName()

Parameters:

branchName - The pull request branch name.

Returns:

this

credentials

@Stability(Experimental)
public CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions.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 CreatePullRequestOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CreatePullRequestOptions

Throws:

NullPointerException - if any required attribute was not provided