Package io.github.cdklabs.projen.github

Class PullRequestTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

io.github.cdklabs.projen.TextFile

io.github.cdklabs.projen.github.PullRequestTemplate

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.087Z")
@Stability(Experimental)
public class PullRequestTemplate
extends TextFile

(experimental) Template for GitHub pull requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PullRequestTemplate.Builder	(experimental) A fluent builder for PullRequestTemplate.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
	PullRequestTemplate(GitHub github)
	PullRequestTemplate(GitHub github, PullRequestTemplateOptions options)
protected	PullRequestTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PullRequestTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static PullRequestTemplate	of(Project project)	(experimental) Returns the PullRequestTemplate instance associated with a project or undefined if there is no PullRequestTemplate.

Methods inherited from class io.github.cdklabs.projen.TextFile

addLine, synthesizeContent

Methods inherited from class io.github.cdklabs.projen.FileBase

getAbsolutePath, getChanged, getExecutable, getMarker, getPath, getReadonly, setExecutable, setReadonly, synthesize

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

PullRequestTemplate

protected PullRequestTemplate(software.amazon.jsii.JsiiObjectRef objRef)

PullRequestTemplate

protected PullRequestTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

PullRequestTemplate

@Stability(Experimental)
public PullRequestTemplate(@NotNull
                           GitHub github,
                           @Nullable
                           PullRequestTemplateOptions options)

Parameters:

github - This parameter is required.

options -

PullRequestTemplate

@Stability(Experimental)
public PullRequestTemplate(@NotNull
                           GitHub github)

Parameters:

github - This parameter is required.

Method Detail

of

@Stability(Experimental)
@Nullable
public static PullRequestTemplate of(@NotNull
                                     Project project)

(experimental) Returns the PullRequestTemplate instance associated with a project or undefined if there is no PullRequestTemplate.

Parameters:

project - The project. This parameter is required.

Returns:

A PullRequestTemplate