Package org.jenkins.plugins.lockableresources.remote

Class RemoteLockRequest

java.lang.Object

org.jenkins.plugins.lockableresources.remote.RemoteLockRequest

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class RemoteLockRequest
extends Object

Lock-semantics payload for the remote lock API. Corresponds to the lockRequest field in POST /acquire.

Routing fields (serverId, forcedServerId) are intentionally excluded - they are transport/configuration concerns, not lock semantics.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RemoteLockRequest.ExtraResource	Represents an additional resource in a multi-resource lock request.

Constructor Summary

Constructors

Constructor	Description
RemoteLockRequest(String resource, String label, int quantity, String variable, boolean inversePrecedence, String resourceSelectStrategy, boolean skipIfLocked, List<RemoteLockRequest.ExtraResource> extra, int priority, long timeoutForAllocateResource, String timeoutUnit, String reason)

Method Summary

Modifier and Type	Method	Description
static RemoteLockRequest	from(LockStep step)	Builds a RemoteLockRequest from the DSL lock step.
List<RemoteLockRequest.ExtraResource>	getExtra()
String	getLabel()
int	getPriority()
int	getQuantity()
String	getReason()
String	getResource()
String	getResourceSelectStrategy()
long	getTimeoutForAllocateResource()
String	getTimeoutUnit()
String	getVariable()
boolean	isInversePrecedence()
boolean	isSkipIfLocked()

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteLockRequest

public RemoteLockRequest(@CheckForNull
 String resource,
 @CheckForNull
 String label,
 int quantity,
 @CheckForNull
 String variable,
 boolean inversePrecedence,
 @NonNull
 String resourceSelectStrategy,
 boolean skipIfLocked,
 @CheckForNull
 List<RemoteLockRequest.ExtraResource> extra,
 int priority,
 long timeoutForAllocateResource,
 @NonNull
 String timeoutUnit,
 @CheckForNull
 String reason)

Method Details

getResource

@CheckForNull
public String getResource()

getLabel

@CheckForNull
public String getLabel()

getQuantity

public int getQuantity()

getVariable

@CheckForNull
public String getVariable()

isInversePrecedence

public boolean isInversePrecedence()

getResourceSelectStrategy

@NonNull
public String getResourceSelectStrategy()

isSkipIfLocked

public boolean isSkipIfLocked()

getExtra

@CheckForNull
public List<RemoteLockRequest.ExtraResource> getExtra()

getPriority

public int getPriority()

getTimeoutForAllocateResource

public long getTimeoutForAllocateResource()

getTimeoutUnit

@NonNull
public String getTimeoutUnit()

getReason

@CheckForNull
public String getReason()

from

@NonNull
public static RemoteLockRequest from(@NonNull
 LockStep step)

Builds a RemoteLockRequest from the DSL lock step. serverId is excluded - it is a routing concern, not part of lock semantics.