The resource name to lock as defined in Global settings.

If the resource does not exist in Global Settings it will be automatically created on build execution. Either a resource or a label need to be specified.

By default waiting builds get the lock in the same order they requested to acquire it.

By checking this option the newest build in the waiting queue will get the lock first.

See also examples .

The label of the resources to be locked as defined in Global settings.

Either a resource or a label need to be specified.

See also examples and Scripted vs declarative pipeline .

The priority of the lock,

which takes an integer number that defines the order in which concurrent jobs waiting for the same resource are served. The job with the highest number would get the resource first. If the priority is equal, the current precedence (first comes first) would be applied.

See also examples .

The quantity of resources with the specified label to be locked as defined in Global settings.

Either a resource or a label need to be specified. Empty value or 0 means lock all matching resources.

The strategy used to chose which available resources get locked. By default, the strategy will be "sequential" and resources are locked following the order in the lockable resources list. Set the strategy to "random" to randomize the order in which resources are locked.

By default waiting builds get the lock.

By checking this option the body will not be executed if there is a queue. It will only take the lock if it can be taken immediately.

See also examples .

Name of an environment variable that will receive the comma separated list of the names of the locked resources while the block executes.

See also examples and Scripted vs declarative pipeline .

Adds labels to the resource without removing existing labels. Multiple labels should be separated by whitespace. Labels that already exist on the resource will not be duplicated.

Cannot be used together with setLabels.

Example: addLabels: 'newlabel1 newlabel2'

When set to true, creates the resource if it does not already exist. The newly created resource will be persistent (not ephemeral).

Cannot be used together with deleteResource.

When set to true, deletes the specified resource. The resource must not be locked, queued, or reserved.

Cannot be used together with createResource or any label/note modification options.

Removes the specified labels from the resource. Multiple labels should be separated by whitespace. Labels that do not exist on the resource will be ignored.

Cannot be used together with setLabels.

Example: removeLabels: 'oldlabel1 oldlabel2'

The name of the resource to update. This parameter is required.

The resource must already exist, unless createResource is set to true.

Sets the labels of the resource, replacing any existing labels. Multiple labels should be separated by whitespace.

Cannot be used together with addLabels or removeLabels.

Example: setLabels: 'label1 label2 label3'

Sets the note field of the resource, replacing any existing note. This can be used to store additional information or comments about the resource.

Example: setNote: 'Updated by build #123'