jenkins.plugins.purgejobhistory

Class PurgeJobHistory

java.lang.Object

hudson.cli.CLICommand

jenkins.plugins.purgejobhistory.PurgeJobHistory

All Implemented Interfaces:

hudson.ExtensionPoint, Cloneable

@Extension
public class PurgeJobHistory
extends hudson.cli.CLICommand

Author:

Stephen Connolly

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
hudson.model.Job<?,?>	job The source item.
boolean	reset Follows the progress of the operation

Fields inherited from class hudson.cli.CLICommand

channel, locale, stderr, stdin, stdout, TRANSPORT_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
PurgeJobHistory()

Method Summary

Methods

Modifier and Type	Method and Description
String	getShortDescription()
static void	purge(hudson.model.Job<?,?> job, boolean resetNextBuildNumber) Purges the build history of the specified job.
protected int	run()

Methods inherited from class hudson.cli.CLICommand

all, checkChannel, clone, createClone, getClientCharset, getClientEnvironmentVariable, getClientSystemProperty, getCmdLineParser, getCurrent, getLongDescription, getName, getSingleLineSummary, getTransportAuthentication, getUsage, loadStoredAuthentication, main, printUsage, printUsageSummary, registerOptionHandlers, setTransportAuth, shouldPerformAuthentication

Methods inherited from class java.lang.Object

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

Field Detail

reset

public boolean reset

Follows the progress of the operation

job

public hudson.model.Job<?,?> job

The source item.

Constructor Detail

PurgeJobHistory

public PurgeJobHistory()

Method Detail

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in class hudson.cli.CLICommand

run

protected int run()
           throws Exception

Specified by:

run in class hudson.cli.CLICommand

Throws:

Exception

purge

public static void purge(hudson.model.Job<?,?> job,
         boolean resetNextBuildNumber)
                  throws IOException

Purges the build history of the specified job.

Parameters:

job - the job to purge

resetNextBuildNumber - true if the next build number should be reset to 1 after the purge

Throws:

IOException - if something went wrong.