com.cdancy.jenkins.rest.features

Interface QueueApi

@Consumes(value="application/json")
 @Path(value="/queue")
public interface QueueApi

Method Summary

Modifier and Type	Method and Description
RequestStatus	cancel(int id) Cancel a queue item before it gets built.
java.util.List<QueueItem>	queue()
QueueItem	queueItem(int queueId) Get a specific queue item.

Method Detail

queue

@Named(value="queue:queue")
 @Path(value="/api/json")
 @GET
java.util.List<QueueItem> queue()

queueItem

@Named(value="queue:item")
 @Path(value="/item/{queueId}/api/json")
 @GET
QueueItem queueItem(@PathParam(value="queueId")
                                                                                              int queueId)

Get a specific queue item. Queue items are builds that have been scheduled to run, but are waiting for a slot. You can poll the queueItem that corresponds to a build to detect whether the build is still pending or is executing.

Parameters:

queueId - The queue id value as returned by the JobsApi build or buildWithParameters methods.

Returns:

The queue item corresponding to the queue id.

cancel

@Named(value="queue:cancel")
 @Path(value="/cancelItem")
 @POST
RequestStatus cancel(@FormParam(value="id")
                                                                                     int id)

Cancel a queue item before it gets built.

Parameters:

id - The queue id value of the queue item to cancel. This is the value is returned by the JobsApi build or buildWithParameters methods.

Returns:

Always returns true due to JENKINS-21311.