Package io.github.cdklabs.projen.github.workflows

Class PullRequestOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.workflows.PullRequestOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PullRequestOptions>

Enclosing interface:

PullRequestOptions

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

A builder for PullRequestOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PullRequestOptions.Builder	branches(List<String> branches)	Sets the value of PushOptions.getBranches()
PullRequestOptions	build()	Builds the configured instance.
PullRequestOptions.Builder	paths(List<String> paths)	Sets the value of PushOptions.getPaths()
PullRequestOptions.Builder	tags(List<String> tags)	Sets the value of PushOptions.getTags()
PullRequestOptions.Builder	types(List<String> types)	Sets the value of PullRequestOptions.getTypes()

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

types

@Stability(Experimental)
public PullRequestOptions.Builder types(List<String> types)

Sets the value of PullRequestOptions.getTypes()

Parameters:

types - Which activity types to trigger on.

Returns:

this

branches

@Stability(Experimental)
public PullRequestOptions.Builder branches(List<String> branches)

Sets the value of PushOptions.getBranches()

Parameters:

branches - When using the push, pull_request and pull_request_target events, you can configure a workflow to run on specific branches or tags. For a pull_request event, only branches and tags on the base are evaluated. If you define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.

Returns:

this

paths

@Stability(Experimental)
public PullRequestOptions.Builder paths(List<String> paths)

Sets the value of PushOptions.getPaths()

Parameters:

paths - When using the push, pull_request and pull_request_target events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags.

Returns:

this

tags

@Stability(Experimental)
public PullRequestOptions.Builder tags(List<String> tags)

Sets the value of PushOptions.getTags()

Parameters:

tags - When using the push, pull_request and pull_request_target events, you can configure a workflow to run on specific branches or tags. For a pull_request event, only branches and tags on the base are evaluated. If you define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.

Returns:

this

build

@Stability(Experimental)
public PullRequestOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PullRequestOptions

Throws:

NullPointerException - if any required attribute was not provided