Package hudson.plugins.build_timeout

Class BuildTimeOutOperation

java.lang.Object

hudson.plugins.build_timeout.BuildTimeOutOperation

All Implemented Interfaces:

ExtensionPoint, Describable<BuildTimeOutOperation>

Direct Known Subclasses:

AbortAndRestartOperation, AbortOperation, BuildStepOperation, FailOperation, WriteDescriptionOperation

public abstract class BuildTimeOutOperation
extends Object
implements ExtensionPoint, Describable<BuildTimeOutOperation>

Defines an operation performed when timeout occurs. They are called "Timeout Actions", but the class is BuildTimeOutOperation not to be confused with Action

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BuildTimeOutOperation()

Method Summary

Modifier and Type	Method	Description
BuildTimeOutOperationDescriptor	getDescriptor()
abstract boolean	perform(AbstractBuild<?,?> build, BuildListener listener, long effectiveTimeout)	Perform operation.

Methods inherited from class java.lang.Object

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

Constructor Details

BuildTimeOutOperation

public BuildTimeOutOperation()

Method Details

perform

public abstract boolean perform(@NonNull
 AbstractBuild<?,?> build,
 @NonNull
 BuildListener listener,
 long effectiveTimeout)

Perform operation.

Parameters:

build - build timed out

listener - build listener. can be used to print log.

effectiveTimeout - timeout (milliseconds)

Returns:

false not to run subsequent operations. It also mark the build as failure.

getDescriptor

public BuildTimeOutOperationDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<BuildTimeOutOperation>

See Also:

• Describable.getDescriptor()