Package com.atlassian.bamboo.configuration

Enum Class OfflineRemoteAgentRemovalPolicy

java.lang.Object

java.lang.Enum<OfflineRemoteAgentRemovalPolicy>

com.atlassian.bamboo.configuration.OfflineRemoteAgentRemovalPolicy

All Implemented Interfaces:

Serializable, Comparable<OfflineRemoteAgentRemovalPolicy>, Constable

public enum OfflineRemoteAgentRemovalPolicy
extends Enum<OfflineRemoteAgentRemovalPolicy>

Enum representing the policy for removing offline remote agents.

Since:

11.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Policy is disabled.
IMMEDIATE	Offline remote agents will be removed immediately once they go into the offline state.
TIMEOUT	Offline remote agents will be removed within the declared time period during the next removal background job run.

Method Summary

Modifier and Type	Method	Description
static OfflineRemoteAgentRemovalPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OfflineRemoteAgentRemovalPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final OfflineRemoteAgentRemovalPolicy DISABLED

Policy is disabled. Offline remote agents will not be removed.

IMMEDIATE

public static final OfflineRemoteAgentRemovalPolicy IMMEDIATE

Offline remote agents will be removed immediately once they go into the offline state.

TIMEOUT

public static final OfflineRemoteAgentRemovalPolicy TIMEOUT

Offline remote agents will be removed within the declared time period during the next removal background job run.

Method Details

values

public static OfflineRemoteAgentRemovalPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OfflineRemoteAgentRemovalPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null