Package io.github.cdklabs.projen.github

Interface DownloadArtifactWith

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    DownloadArtifactWith.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.069Z")
@Stability(Experimental)
public interface DownloadArtifactWith
extends software.amazon.jsii.JsiiSerializable

    • Method Summary

      All Methods Static Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      static DownloadArtifactWith.Builder builder()  
      default Boolean getMergeMultiple()
      (experimental) 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.
      default String getName()
      (experimental) Name of the artifact to download.
      default String getPath()
      (experimental) A file, directory or wildcard pattern that describes what to download.
      default String getPattern()
      (experimental) A glob pattern to the artifacts that should be downloaded This is ignored if name is specified.
      default String getRepository()
      (experimental) 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.
      default String getRunId()
      (experimental) 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.
      default String getToken()
      (experimental) The GitHub token used to authenticate with the GitHub API to download artifacts from a different repository or from a different workflow run.

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Method Detail

      • getMergeMultiple

        @Stability(Experimental)
@Nullable
default Boolean getMergeMultiple()
        (experimental) 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.

        Default: false

      • getName

        @Stability(Experimental)
@Nullable
default String getName()
        (experimental) Name of the artifact to download.

        Default: - If unspecified, all artifacts for the run are downloaded

      • getPath

        @Stability(Experimental)
@Nullable
default String getPath()
        (experimental) A file, directory or wildcard pattern that describes what to download.

        Supports basic tilde expansion.

        Default: - $GITHUB_WORKSPACE

      • getPattern

        @Stability(Experimental)
@Nullable
default String getPattern()
        (experimental) A glob pattern to the artifacts that should be downloaded This is ignored if name is specified.

      • getRepository

        @Stability(Experimental)
@Nullable
default String getRepository()
        (experimental) 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.

        Default: - ${{ github.repository }}

      • getRunId

        @Stability(Experimental)
@Nullable
default String getRunId()
        (experimental) 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.

        Default: - ${{ github.run_id }}

      • getToken

        @Stability(Experimental)
@Nullable
default String getToken()
        (experimental) The GitHub token used to authenticate with the GitHub API to download artifacts from a different repository or from a different workflow run.

        Default: - If unspecified, the action will download artifacts from the current repo and the current workflow run