com.google.jenkins.plugins.storage

Class StdoutUpload

java.lang.Object

com.google.jenkins.plugins.storage.AbstractUpload

com.google.jenkins.plugins.storage.StdoutUpload

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<AbstractUpload>, Serializable

public class StdoutUpload
extends AbstractUpload

This upload extension allow the user to upload the build log for the Jenkins build to a given bucket, with a specified file name. By default, the file is named "build-log.txt". NOTE: Unlike other Uploads, we use a BuildEventListener to continuously upload the build log at build waypoints.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StdoutUpload.DescriptorImpl Denotes this is an AbstractUpload plugin

Nested classes/interfaces inherited from class com.google.jenkins.plugins.storage.AbstractUpload

AbstractUpload.UploadSpec

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.google.jenkins.plugins.storage.AbstractUpload

module

Constructor Summary

Constructors

Constructor and Description
StdoutUpload(String bucketNameWithVars, boolean sharedPublicly, boolean forFailedJobs, UploadModule module, String logName) Construct the Upload with the stock properties, and the additional information about how to name the build log file.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	forResult(hudson.model.Result result) Determine whether we should upload the pattern for the given build result.
String	getDetails() Provide detail information summarizing this download for the GCS upload report.
protected AbstractUpload.UploadSpec	getInclusions(hudson.model.AbstractBuild<?,?> build, hudson.FilePath workspace, hudson.model.TaskListener listener) Implementations override this interface in order to surface the set of FilePaths the core logic should upload.
String	getLogName() The name to give the file we upload for the build log.

Methods inherited from class com.google.jenkins.plugins.storage.AbstractUpload

all, annotateObject, getBucketNameWithVars, getDescriptor, getMetadata, getOrCreateBucket, getRelative, isForFailedJobs, isSharedPublicly, perform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StdoutUpload

@DataBoundConstructor
public StdoutUpload(String bucketNameWithVars,
                                 boolean sharedPublicly,
                                 boolean forFailedJobs,
                                 @Nullable
                                 UploadModule module,
                                 String logName)

Construct the Upload with the stock properties, and the additional information about how to name the build log file.

Method Detail

getLogName

public String getLogName()

The name to give the file we upload for the build log.

getDetails

public String getDetails()

Provide detail information summarizing this download for the GCS upload report.

Specified by:

getDetails in class AbstractUpload

forResult

public boolean forResult(hudson.model.Result result)

Determine whether we should upload the pattern for the given build result.

Overrides:

forResult in class AbstractUpload

getInclusions

@Nullable
protected AbstractUpload.UploadSpec getInclusions(hudson.model.AbstractBuild<?,?> build,
                                               hudson.FilePath workspace,
                                               hudson.model.TaskListener listener)
                                           throws UploadException

Implementations override this interface in order to surface the set of FilePaths the core logic should upload.

Specified by:

getInclusions in class AbstractUpload

Throws:

UploadException

See Also:

for further details.