CheckoutWith (io.github.cdklabs:projen 0.80.15 API)

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CheckoutWithPatchOptions, PullRequestPatchSource

All Known Implementing Classes:

CheckoutWith.Jsii$Proxy, CheckoutWithPatchOptions.Jsii$Proxy, PullRequestPatchSource.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.065Z")
@Stability(Experimental)
public interface CheckoutWith
extends software.amazon.jsii.JsiiSerializable
```
(experimental) Options for checkout.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`CheckoutWith.Builder`	A builder for `CheckoutWith`
`static class`	`CheckoutWith.Jsii$Proxy`	An implementation for `CheckoutWith`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static CheckoutWith.Builder`	`builder()`
`default Number`	`getFetchDepth()`	(experimental) Number of commits to fetch.
`default Boolean`	`getLfs()`	(experimental) Whether LFS is enabled for the GitHub repository.
`default String`	`getRef()`	(experimental) Branch or tag name.
`default String`	`getRepository()`	(experimental) The repository (owner/repo) to use.
`default String`	`getToken()`	(experimental) A GitHub token to use when checking out the repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getFetchDepth
```
@Stability(Experimental)
@Nullable
default Number getFetchDepth()
```
    (experimental) Number of commits to fetch.
    0 indicates all history for all branches and tags.
    Default: 1
  - getLfs
```
@Stability(Experimental)
@Nullable
default Boolean getLfs()
```
    (experimental) Whether LFS is enabled for the GitHub repository.
    Default: false
  - getRef
```
@Stability(Experimental)
@Nullable
default String getRef()
```
    (experimental) Branch or tag name.
    Default: - the default branch is implicitly used
  - getRepository
```
@Stability(Experimental)
@Nullable
default String getRepository()
```
    (experimental) The repository (owner/repo) to use.
    Default: - the default repository is implicitly used
  - getToken
```
@Stability(Experimental)
@Nullable
default String getToken()
```
    (experimental) 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.
    Default: - the default GITHUB_TOKEN is implicitly used
  - builder
```
@Stability(Experimental)
static CheckoutWith.Builder builder()
```
    Returns:
    
    a CheckoutWith.Builder of CheckoutWith