Package io.github.cdklabs.projen.github
Class DownloadArtifactWith.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.github.DownloadArtifactWith.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<DownloadArtifactWith>
- Enclosing interface:
- DownloadArtifactWith
@Stability(Experimental) public static final class DownloadArtifactWith.Builder extends Object implements software.amazon.jsii.Builder<DownloadArtifactWith>
A builder forDownloadArtifactWith
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DownloadArtifactWithbuild()Builds the configured instance.DownloadArtifactWith.BuildermergeMultiple(Boolean mergeMultiple)Sets the value ofDownloadArtifactWith.getMergeMultiple()DownloadArtifactWith.Buildername(String name)Sets the value ofDownloadArtifactWith.getName()DownloadArtifactWith.Builderpath(String path)Sets the value ofDownloadArtifactWith.getPath()DownloadArtifactWith.Builderpattern(String pattern)Sets the value ofDownloadArtifactWith.getPattern()DownloadArtifactWith.Builderrepository(String repository)Sets the value ofDownloadArtifactWith.getRepository()DownloadArtifactWith.BuilderrunId(String runId)Sets the value ofDownloadArtifactWith.getRunId()DownloadArtifactWith.Buildertoken(String token)Sets the value ofDownloadArtifactWith.getToken()
-
-
-
Method Detail
-
mergeMultiple
@Stability(Experimental) public DownloadArtifactWith.Builder mergeMultiple(Boolean mergeMultiple)
Sets the value ofDownloadArtifactWith.getMergeMultiple()- Parameters:
mergeMultiple- When multiple artifacts are matched, this changes the behavior of the destination directories If true, the downloaded artifacts will be in the same directory specified by path If false, the downloaded artifacts will be extracted into individual named directories within the specified path.- Returns:
this
-
name
@Stability(Experimental) public DownloadArtifactWith.Builder name(String name)
Sets the value ofDownloadArtifactWith.getName()- Parameters:
name- Name of the artifact to download.- Returns:
this
-
path
@Stability(Experimental) public DownloadArtifactWith.Builder path(String path)
Sets the value ofDownloadArtifactWith.getPath()- Parameters:
path- A file, directory or wildcard pattern that describes what to download. Supports basic tilde expansion.- Returns:
this
-
pattern
@Stability(Experimental) public DownloadArtifactWith.Builder pattern(String pattern)
Sets the value ofDownloadArtifactWith.getPattern()- Parameters:
pattern- A glob pattern to the artifacts that should be downloaded This is ignored if name is specified.- Returns:
this
-
repository
@Stability(Experimental) public DownloadArtifactWith.Builder repository(String repository)
Sets the value ofDownloadArtifactWith.getRepository()- Parameters:
repository- The repository owner and the repository name joined together by "/" If github-token is specified, this is the repository that artifacts will be downloaded from.- Returns:
this
-
runId
@Stability(Experimental) public DownloadArtifactWith.Builder runId(String runId)
Sets the value ofDownloadArtifactWith.getRunId()- Parameters:
runId- The id of the workflow run where the desired download artifact was uploaded from If github-token is specified, this is the run that artifacts will be downloaded from.- Returns:
this
-
token
@Stability(Experimental) public DownloadArtifactWith.Builder token(String token)
Sets the value ofDownloadArtifactWith.getToken()- Parameters:
token- The GitHub token used to authenticate with the GitHub API to download artifacts from a different repository or from a different workflow run.- Returns:
this
-
build
@Stability(Experimental) public DownloadArtifactWith build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<DownloadArtifactWith>- Returns:
- a new instance of
DownloadArtifactWith - Throws:
NullPointerException- if any required attribute was not provided
-
-