Package org.kohsuke.github

Class GHArtifact

java.lang.Object
org.kohsuke.github.GHObject
org.kohsuke.github.GHArtifact
public class GHArtifact extends GHObject
An artifact from a workflow run.
Author:
Guillaume Smet

  • Constructor Details

    • GHArtifact

      public GHArtifact()

  • Method Details

    • getName

      public String getName()
      Gets the name.
      Returns:
      the name

    • getSizeInBytes

      public long getSizeInBytes()
      Gets the size of the artifact in bytes.
      Returns:
      the size

    • getArchiveDownloadUrl

      public URL getArchiveDownloadUrl()
      Gets the archive download URL.
      Returns:
      the archive download URL

    • isExpired

      public boolean isExpired()
      If this artifact has expired.
      Returns:
      if the artifact has expired

    • getExpiresAt

      public Date getExpiresAt()
      Gets the date at which this artifact will expire.
      Returns:
      the date of expiration

    • getRepository

      public GHRepository getRepository()
      Repository to which the artifact belongs.
      Returns:
      the repository

    • getHtmlUrl

      public URL getHtmlUrl() throws IOException
      Deprecated.
      This object has no HTML URL.
      Gets the html url.
      Specified by:
      getHtmlUrl in class GHObject
      Returns:
      the html url
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • delete

      public void delete() throws IOException
      Deletes the artifact.
      Throws:
      IOException - the io exception

    • download

      public <T> T download(InputStreamFunction<T> streamFunction) throws IOException
      Downloads the artifact.
      Type Parameters:
      T - the type of result
      Parameters:
      streamFunction - The InputStreamFunction that will process the stream
      Returns:
      the result of reading the stream.
      Throws:
      IOException - The IO exception.

    • getRoot

      @Deprecated public GitHub getRoot()
      Deprecated.
      For access to the GitHub instance, use a local copy instead of pulling it out of objects.
      Get the root GitHub instance for this object.
      Returns:
      the root GitHub instance