-
-
- serialVersionUID:
- 1L
-
Serialization Methods
-
readResolve
protected Object readResolve()
-
Serialized Fields
-
buildExternalizableId
String buildExternalizableId
-
description
String description
-
ephemeral
boolean ephemeral
We can use arbitrary identifier in a temporary lock (e.g. a commit hash of built/tested
sources), and not overwhelm Jenkins with lots of "garbage" locks. Such locks will be
automatically removed when freed, if they were not explicitly declared in the Jenkins Configure
System page. If an originally ephemeral lock is later defined in configuration, it becomes a
usual persistent lock. If a "usual" lock definition is deleted while it is being held, it
becomes ephemeral and will disappear when freed.
-
labelsAsList
List<String> labelsAsList
-
lockReason
String lockReason
The reason why this resource is currently locked. Set via the lock() step's reason parameter.
Cleared when the resource is unlocked.
-
name
String name
-
note
String note
-
properties
List<LockableResourceProperty> properties
-
queuedContexts
List<org.jenkinsci.plugins.workflow.steps.StepContext> queuedContexts
Deprecated.
Was used within the initial implementation of Pipeline functionality using
LockStep,
but became deprecated once several resources could be locked at once. See queuedContexts in
LockableResourcesManager.
-
queueItemId
long queueItemId
-
queueItemProject
String queueItemProject
-
queuingStarted
long queuingStarted
-
reservedBy
String reservedBy
-
reservedTimestamp
Date reservedTimestamp
-
stolen
boolean stolen
Track that a currently reserved resource was originally reserved for someone else, or locked
for some other job, and explicitly taken away - e.g. for SUT post-mortem while a test job runs.
Currently this does not track "who" it was taken from nor intend to give it back - just for
bookkeeping and UI button naming. Cleared when the resource is unReserve'd.
-
-
class LockStep extends org.jenkinsci.plugins.workflow.steps.Step implements
Serializable
- serialVersionUID:
- -953609907239674360L
-
Serialized Fields
-
extra
List<LockStepResource> extra
-
inversePrecedence
boolean inversePrecedence
-
label
String label
-
priority
int priority
-
quantity
int quantity
-
reason
String reason
The reason why this resource is being locked, displayed in the UI while locked.
-
resource
String resource
-
resourceSelectStrategy
String resourceSelectStrategy
-
skipIfLocked
boolean skipIfLocked
-
timeoutForAllocateResource
long timeoutForAllocateResource
Timeout in the specified
LockStep.timeoutUnit for waiting to acquire the resource.
0 means no timeout (wait indefinitely). When the timeout expires, the step fails
with an exception instead of waiting forever.
-
timeoutUnit
String timeoutUnit
-
variable
String variable
name of environment variable to store locked resources in
-
class LockStepExecution extends org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl implements
Serializable
- serialVersionUID:
- 1391734561272059623L
-
-
class UpdateLockStep extends org.jenkinsci.plugins.workflow.steps.Step implements
Serializable
- serialVersionUID:
- -7955849755535282258L
-
Serialized Fields
-
addLabels
String addLabels
-
createResource
boolean createResource
-
deleteResource
boolean deleteResource
-
removeLabels
String removeLabels
-
resource
String resource
-
setLabels
String setLabels
-
setNote
String setNote
-
class UpdateLockStepExecution extends org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl implements
Serializable
- serialVersionUID:
- 1583205294263267002L
-
-
-
-
- serialVersionUID:
- 1L
-
Serialized Fields
-
context
org.jenkinsci.plugins.workflow.steps.StepContext context
-
id
String id
-
lockableResourcesStruct
List<LockableResourcesStruct> lockableResourcesStruct
-
priority
int priority
-
reason
String reason
-
resourceDescription
String resourceDescription
-
timeoutDeadlineMillis
long timeoutDeadlineMillis
-
timeoutForAllocateResource
long timeoutForAllocateResource
-
timeoutUnit
String timeoutUnit
-
variableName
String variableName
-