com.google.jenkins.plugins.health

Class ExecutorCheck

java.lang.Object

hudson.model.AbstractDescribableImpl<HealthCheck>

com.google.jenkins.plugins.health.HealthCheck

com.google.jenkins.plugins.health.ExecutorCheck

All Implemented Interfaces:

DerivedPageComponent<HealthCheckReport>, hudson.ExtensionPoint, hudson.model.Describable<HealthCheck>

public class ExecutorCheck
extends HealthCheck

An extension of HealthCheck that verifies that Jenkins has more than a given minimum number of executors of some given labels.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutorCheck.DescriptorImpl Descriptor class for this extension.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ExecutorCheck(int minExecutors, String labelsSsv)

Method Summary

Methods

Modifier and Type	Method and Description
ExecutorCheck.DescriptorImpl	getDescriptor()
Set<? extends hudson.model.Label>	getLabels()
String	getLabelsSsv()
int	getMinExecutors()
hudson.model.Result	perform(hudson.model.TaskListener taskListener) Subclass needs to implement its own health check logic here.
String	toString()

Methods inherited from class com.google.jenkins.plugins.health.HealthCheck

all, performDerivation

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutorCheck

@DataBoundConstructor
public ExecutorCheck(int minExecutors,
                                  String labelsSsv)

Parameters:

minExecutors - the required minimum number of executors.

labelsSsv - the labels to be checked, space separated.

Method Detail

getMinExecutors

public int getMinExecutors()

Returns:

the required minimum number of executors.

getLabels

public Set<? extends hudson.model.Label> getLabels()

Returns:

the labels to check.

getLabelsSsv

public String getLabelsSsv()

Returns:

the labels

perform

public hudson.model.Result perform(hudson.model.TaskListener taskListener)

Subclass needs to implement its own health check logic here.

Specified by:

perform in class HealthCheck

Parameters:

taskListener - the logger to capture logs from performing the checks.

Returns:

generally, this should return Result.SUCCESS in case of a successful health-check and Result.FAILURE otherwise.

getDescriptor

public ExecutorCheck.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<HealthCheck>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<HealthCheck>

toString

public String toString()

Overrides:

toString in class Object