Package io.github.cdklabs.projen.github

Class CreatePullRequestOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.github.CreatePullRequestOptions.Jsii$Proxy

All Implemented Interfaces:

CreatePullRequestOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CreatePullRequestOptions

@Stability(Experimental)
@Internal
public static final class CreatePullRequestOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CreatePullRequestOptions

An implementation for CreatePullRequestOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.github.CreatePullRequestOptions

CreatePullRequestOptions.Builder, CreatePullRequestOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CreatePullRequestOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the CreatePullRequestOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
List<String>	getAssignees()	(experimental) Assignees to add on the PR.
String	getBaseBranch()	(experimental) Sets the pull request base branch.
String	getBranchName()	(experimental) The pull request branch name.
GithubCredentials	getCredentials()	(experimental) The job credentials used to create the pull request.
GitIdentity	getGitIdentity()	(experimental) The git identity used to create the commit.
List<String>	getLabels()	(experimental) Labels to apply on the PR.
String	getPullRequestDescription()	(experimental) Description added to the pull request.
String	getPullRequestTitle()	(experimental) The full title used to create the pull request.
Boolean	getSignoff()	(experimental) Add Signed-off-by line by the committer at the end of the commit log message.
String	getStepId()	(experimental) The step ID which produces the output which indicates if a patch was created.
String	getStepName()	(experimental) The name of the step displayed on GitHub.
String	getWorkflowName()	(experimental) The name of the workflow that will create the PR.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CreatePullRequestOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the CreatePullRequestOptions.Builder.

Method Detail

getPullRequestDescription

public final String getPullRequestDescription()

Description copied from interface: CreatePullRequestOptions

(experimental) Description added to the pull request.

Providence information are automatically added.

Specified by:

getPullRequestDescription in interface CreatePullRequestOptions

getPullRequestTitle

public final String getPullRequestTitle()

Description copied from interface: CreatePullRequestOptions

(experimental) The full title used to create the pull request.

If PR titles are validated in this repo, the title should comply with the respective rules.

Specified by:

getPullRequestTitle in interface CreatePullRequestOptions

getWorkflowName

public final String getWorkflowName()

Description copied from interface: CreatePullRequestOptions

(experimental) The name of the workflow that will create the PR.

Specified by:

getWorkflowName in interface CreatePullRequestOptions

getAssignees

public final List<String> getAssignees()

Description copied from interface: CreatePullRequestOptions

(experimental) Assignees to add on the PR.

Default: - no assignees

Specified by:

getAssignees in interface CreatePullRequestOptions

getBaseBranch

public final String getBaseBranch()

Description copied from interface: CreatePullRequestOptions

(experimental) Sets the pull request base branch.

Default: - The branch checked out in the workflow.

Specified by:

getBaseBranch in interface CreatePullRequestOptions

getBranchName

public final String getBranchName()

Description copied from interface: CreatePullRequestOptions

(experimental) The pull request branch name.

Default: `github-actions/${options.workflowName}`

Specified by:

getBranchName in interface CreatePullRequestOptions

getCredentials

public final GithubCredentials getCredentials()

Description copied from interface: CreatePullRequestOptions

(experimental) The job credentials used to create the pull request.

Provided credentials must have permissions to create a pull request on the repository.

Specified by:

getCredentials in interface CreatePullRequestOptions

getGitIdentity

public final GitIdentity getGitIdentity()

Description copied from interface: CreatePullRequestOptions

(experimental) The git identity used to create the commit.

Default: - the default github-actions user

Specified by:

getGitIdentity in interface CreatePullRequestOptions

getLabels

public final List<String> getLabels()

Description copied from interface: CreatePullRequestOptions

(experimental) Labels to apply on the PR.

Default: - no labels.

Specified by:

getLabels in interface CreatePullRequestOptions

getSignoff

public final Boolean getSignoff()

Description copied from interface: CreatePullRequestOptions

(experimental) Add Signed-off-by line by the committer at the end of the commit log message.

Default: true

Specified by:

getSignoff in interface CreatePullRequestOptions

getStepId

public final String getStepId()

Description copied from interface: CreatePullRequestOptions

(experimental) The step ID which produces the output which indicates if a patch was created.

Default: "create_pr"

Specified by:

getStepId in interface CreatePullRequestOptions

getStepName

public final String getStepName()

Description copied from interface: CreatePullRequestOptions

(experimental) The name of the step displayed on GitHub.

Default: "Create Pull Request"

Specified by:

getStepName in interface CreatePullRequestOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object