Package io.github.cdklabs.projen.github

Class DownloadArtifactWith.Jsii$Proxy

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Jsii$Proxy​(DownloadArtifactWith.Builder builder)
      Constructor that initializes the object based on literal property values passed by the DownloadArtifactWith.Builder.
      protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.fasterxml.jackson.databind.JsonNode $jsii$toJson()  
      boolean equals​(Object o)  
      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.
      String getName()
      (experimental) Name of the artifact to download.
      String getPath()
      (experimental) A file, directory or wildcard pattern that describes what to download.
      String getPattern()
      (experimental) A glob pattern to the artifacts that should be downloaded This is ignored if name is specified.
      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.
      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.
      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.
      int hashCode()  

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.

    • Method Detail

      • getMergeMultiple

        public final Boolean getMergeMultiple()
        Description copied from interface: DownloadArtifactWith
        (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

        Specified by:
        getMergeMultiple in interface DownloadArtifactWith

      • getName

        public final String getName()
        Description copied from interface: DownloadArtifactWith
        (experimental) Name of the artifact to download.

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

        Specified by:
        getName in interface DownloadArtifactWith

      • getPath

        public final String getPath()
        Description copied from interface: DownloadArtifactWith
        (experimental) A file, directory or wildcard pattern that describes what to download.

        Supports basic tilde expansion.

        Default: - $GITHUB_WORKSPACE

        Specified by:
        getPath in interface DownloadArtifactWith

      • getRepository

        public final String getRepository()
        Description copied from interface: DownloadArtifactWith
        (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 }}

        Specified by:
        getRepository in interface DownloadArtifactWith

      • getRunId

        public final String getRunId()
        Description copied from interface: DownloadArtifactWith
        (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 }}

        Specified by:
        getRunId in interface DownloadArtifactWith

      • getToken

        public final String getToken()
        Description copied from interface: DownloadArtifactWith
        (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

        Specified by:
        getToken in interface DownloadArtifactWith

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object