Package io.github.cdklabs.projen.github

Class CheckoutWith.Builder

java.lang.Object

io.github.cdklabs.projen.github.CheckoutWith.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CheckoutWith>

Enclosing interface:

CheckoutWith

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

A builder for CheckoutWith

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CheckoutWith	build()	Builds the configured instance.
CheckoutWith.Builder	fetchDepth(Number fetchDepth)	Sets the value of CheckoutWith.getFetchDepth()
CheckoutWith.Builder	lfs(Boolean lfs)	Sets the value of CheckoutWith.getLfs()
CheckoutWith.Builder	ref(String ref)	Sets the value of CheckoutWith.getRef()
CheckoutWith.Builder	repository(String repository)	Sets the value of CheckoutWith.getRepository()
CheckoutWith.Builder	token(String token)	Sets the value of CheckoutWith.getToken()

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

fetchDepth

@Stability(Experimental)
public CheckoutWith.Builder fetchDepth(Number fetchDepth)

Sets the value of CheckoutWith.getFetchDepth()

Parameters:

fetchDepth - Number of commits to fetch. 0 indicates all history for all branches and tags.

Returns:

this

lfs

@Stability(Experimental)
public CheckoutWith.Builder lfs(Boolean lfs)

Sets the value of CheckoutWith.getLfs()

Parameters:

lfs - Whether LFS is enabled for the GitHub repository.

Returns:

this

ref

@Stability(Experimental)
public CheckoutWith.Builder ref(String ref)

Sets the value of CheckoutWith.getRef()

Parameters:

ref - Branch or tag name.

Returns:

this

repository

@Stability(Experimental)
public CheckoutWith.Builder repository(String repository)

Sets the value of CheckoutWith.getRepository()

Parameters:

repository - The repository (owner/repo) to use.

Returns:

this

token

@Stability(Experimental)
public CheckoutWith.Builder token(String token)

Sets the value of CheckoutWith.getToken()

Parameters:

token - A GitHub token to use when checking out the repository. If the intent is to push changes back to the branch, then you must use a PAT with repo (and possibly workflows) permissions.

Returns:

this

build

@Stability(Experimental)
public CheckoutWith build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CheckoutWith

Throws:

NullPointerException - if any required attribute was not provided