io.jenkins.plugins.gating

Class ResourceRequirementProperty

java.lang.Object

hudson.model.JobProperty<Job<?,?>>

io.jenkins.plugins.gating.ResourceRequirementProperty

All Implemented Interfaces:

ExtensionPoint, Describable<JobProperty<?>>, ReconfigurableDescribable<JobProperty<?>>, BuildStep, Serializable

public final class ResourceRequirementProperty
extends JobProperty<Job<?,?>>
implements Serializable

Job property to declare the build require certain resources to be operational before the build can start.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceRequirementProperty.Desc

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.JobProperty

owner

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ResourceRequirementProperty(List<String> resources)

Method Summary

Modifier and Type	Method and Description
ResourceBlockage	evaluate(GatingMetrics availability) Evaluate availability and return run/no-run decision.
List<String>	getResources()

Methods inherited from class hudson.model.JobProperty

getDescriptor, getJobAction, getJobActions, getJobOverrides, getProjectAction, getProjectActions, getRequiredMonitorService, getSubTasks, perform, prebuild, reconfigure, setOwner

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceRequirementProperty

@DataBoundConstructor
public ResourceRequirementProperty(@Nonnull
                                                         List<String> resources)

Method Detail

getResources

@Nonnull
public List<String> getResources()

evaluate

@CheckForNull
public ResourceBlockage evaluate(GatingMetrics availability)

Evaluate availability and return run/no-run decision.

Parameters:

availability - Real world state of resources

Returns:

null when satisfied, reasoning otherwise