Package org.jenkinsci.plugins.vsphere

Class VSphereCloudRetentionStrategy

java.lang.Object

hudson.slaves.RetentionStrategy<AbstractCloudComputer>

hudson.slaves.CloudRetentionStrategy

org.jenkinsci.plugins.vsphere.VSphereCloudRetentionStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<RetentionStrategy<?>>

public class VSphereCloudRetentionStrategy
extends CloudRetentionStrategy

Retains a cloud computer until it has been idle for getIdleMinutes() minutes (that part is delegated straight to CloudRetentionStrategy), OR -- optionally -- until it has existed for getLifespanMinutes() minutes in total, whichever happens first. For example, "keep a computer around until it's been idle for an hour, or two days have passed, whichever comes first".

lifespanMinutes defaults to 0, which disables the age-based cap entirely and reproduces this plugin's original keep-until-idle-only behaviour exactly, so existing configurations are unaffected unless they opt in.

This subsumes what used to be a separate "fixed lifespan" retention strategy evaluated originally in pull request https://github.com/jenkinsci/vsphere-cloud-plugin/pull/96/ : rather than make the user choose one or the other, both conditions are available together on this one strategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VSphereCloudRetentionStrategy.CloudComputerCreatedOnInvisibleAction
static final class	VSphereCloudRetentionStrategy.DescriptorImpl
static class	VSphereCloudRetentionStrategy.DescriptorVisibilityFilterImpl

Nested classes/interfaces inherited from class hudson.slaves.RetentionStrategy

RetentionStrategy.Always, RetentionStrategy.Demand

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final VSphereCloudRetentionStrategy.DescriptorImpl	DESCRIPTOR

Fields inherited from class hudson.slaves.CloudRetentionStrategy

disabled

Fields inherited from class hudson.slaves.RetentionStrategy

INSTANCE, LIST, NOOP

Constructor Summary

Constructors

Constructor	Description
VSphereCloudRetentionStrategy(int idleMinutes)

Method Summary

Modifier and Type	Method	Description
long	check(AbstractCloudComputer c)
VSphereCloudRetentionStrategy.DescriptorImpl	getDescriptor()
int	getIdleMinutes()
int	getLifespanMinutes()
boolean	isAcceptingTasks(AbstractCloudComputer c)
void	setLifespanMinutes(int lifespanMinutes)
void	start(AbstractCloudComputer c)

Methods inherited from class hudson.slaves.RetentionStrategy

all, isManualLaunchAllowed

Methods inherited from class java.lang.Object

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

Field Details

DESCRIPTOR

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Extension
public static final VSphereCloudRetentionStrategy.DescriptorImpl DESCRIPTOR

Constructor Details

VSphereCloudRetentionStrategy

@DataBoundConstructor
public VSphereCloudRetentionStrategy(int idleMinutes)

Method Details

getIdleMinutes

public int getIdleMinutes()

See Also:

• idleMinutes

setLifespanMinutes

@DataBoundSetter
public void setLifespanMinutes(int lifespanMinutes)

getLifespanMinutes

public int getLifespanMinutes()

Returns:

the maximum age, in minutes, before a computer is retired regardless of idleness; 0 means unlimited.

check

public long check(AbstractCloudComputer c)

Overrides:

check in class CloudRetentionStrategy

isAcceptingTasks

public boolean isAcceptingTasks(AbstractCloudComputer c)

Overrides:

isAcceptingTasks in class RetentionStrategy<AbstractCloudComputer>

start

public void start(AbstractCloudComputer c)

Overrides:

start in class CloudRetentionStrategy

getDescriptor

public VSphereCloudRetentionStrategy.DescriptorImpl getDescriptor()