io.jenkins.plugins.gating

Enum ResourceStatus.Category

java.lang.Object

java.lang.Enum<ResourceStatus.Category>

io.jenkins.plugins.gating.ResourceStatus.Category

All Implemented Interfaces:

ResourceStatus, Serializable, Comparable<ResourceStatus.Category>

Enclosing interface:

ResourceStatus

public static enum ResourceStatus.Category
extends Enum<ResourceStatus.Category>
implements ResourceStatus

Category of the resource status. Different monitoring services have a different resource states, this provides a reusable abstraction needed by Jenkins gating.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jenkins.plugins.gating.ResourceStatus

ResourceStatus.Category

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEGRADED The resource is partially operational.
DOWN The resource is not operational.
UNKNOWN The resource status is unknown.
UP The resource is fully operational.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UP

public static final ResourceStatus.Category UP

The resource is fully operational.

DEGRADED

public static final ResourceStatus.Category DEGRADED

The resource is partially operational.

UNKNOWN

public static final ResourceStatus.Category UNKNOWN

The resource status is unknown.

DOWN

public static final ResourceStatus.Category DOWN

The resource is not operational.

Method Detail

values

public static ResourceStatus.Category[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResourceStatus.Category c : ResourceStatus.Category.values())
    System.out.println(c);

Returns:

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

valueOf

public static ResourceStatus.Category valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getCategory

@Nonnull
public ResourceStatus.Category getCategory()

Description copied from interface: ResourceStatus

Get Category of the resource.

Specified by:

getCategory in interface ResourceStatus