Class StdoutUploadStep

All Implemented Interfaces:
ExtensionPoint, Describable<Publisher>, BuildStep, Serializable, SimpleBuildStep

@RequiresDomain(StorageScopeRequirement.class) public class StdoutUploadStep extends Recorder implements SimpleBuildStep, Serializable
Build Step wrapper for StdoutUpload to be run in pipelines. Run only in post step.
See Also:
  • Constructor Details

    • StdoutUploadStep

      @DataBoundConstructor public StdoutUploadStep(String credentialsId, String bucket, String logName)
      Constructs a new StdoutUploadStep.
      Parameters:
      credentialsId - The credentials to utilize for authenticating with GCS.
      bucket - GCS bucket to upload build artifacts to.
      logName - Name of log file to store to GCS bucket.
    • StdoutUploadStep

      public StdoutUploadStep(String credentialsId, String bucket, Optional<UploadModule> module, String logName)
      Construct the StdoutUpload uploader to use the provided credentials to upload build artifacts.
      Parameters:
      credentialsId - The credentials to utilize for authenticating with GCS.
      bucket - GCS bucket to upload build artifacts to.
      module - Helper class for connecting to the GCS API.
      logName - Name of log file to store to GCS bucket.
  • Method Details

    • setSharedPublicly

      @DataBoundSetter public void setSharedPublicly(boolean sharedPublicly)
      Parameters:
      sharedPublicly - Whether to surface the file being uploaded to anyone with the link.
    • isSharedPublicly

      public boolean isSharedPublicly()
      Returns:
      Whether to surface the file being uploaded to anyone with the link.
    • setShowInline

      @DataBoundSetter public void setShowInline(boolean showInline)
      Parameters:
      showInline - Whether to indicate in metadata that the file should be viewable inline in web browsers, rather than requiring it to be downloaded first.
    • isShowInline

      public boolean isShowInline()
      Returns:
      Whether to indicate in metadata that the file should be viewable inline in web browsers, rather than requiring it to be downloaded first.
    • setPathPrefix

      @DataBoundSetter public void setPathPrefix(@Nullable String pathPrefix)
      Parameters:
      pathPrefix - The path prefix that will be stripped from uploaded files. May be null if no path prefix needs to be stripped. Filenames that do not start with this prefix will not be modified. Trailing slash is automatically added if it is missing.
    • getPathPrefix

      @Nullable public String getPathPrefix()
    • getLogName

      public String getLogName()
    • getBucket

      public String getBucket()
    • getCredentialsId

      public String getCredentialsId()
    • getRequiredMonitorService

      public BuildStepMonitor getRequiredMonitorService()
      *
      Specified by:
      getRequiredMonitorService in interface BuildStep
    • perform

      public void perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener) throws IOException
      *
      Specified by:
      perform in interface SimpleBuildStep
      Throws:
      IOException