Queue

Queue module for jenkinsapi

class jenkinsapi.queue.Queue(baseurl: str, jenkins_obj: Jenkins)

Bases: JenkinsBase

Class that represents the Jenkins queue

delete_item(queue_item: QueueItem)

delete_item_by_id(item_id: str)

get_jenkins_obj() → Jenkins

get_queue_item_url(item: str) → str

get_queue_items_for_job(job_name: str)

iteritems() → Iterator[Tuple[str, QueueItem]]

iterkeys() → Iterator[str]

itervalues() → Iterator[QueueItem]

keys() → list[str]

values() → list[QueueItem]

class jenkinsapi.queue.QueueItem(baseurl: str, jenkins_obj: Jenkins)

Bases: JenkinsBase

An individual item in the queue

block_until_building(delay=5)

block_until_complete(delay=5)

get_age() → float

Return how long (in seconds) this item has been in the queue.

get_build() → Build

get_build_number() → int

get_causes() → list

Return the list of causes for this queue item being queued.

get_eta() → float

Return the estimated time (in seconds) until the build starts. Returns 0 if the item is already buildable or no estimate available.

get_jenkins_obj() → Jenkins

get_job() → Job

Return the job associated with this queue item

get_job_name() → str

get_parameters()

returns parameters of queue item

property is_blocked: bool

True if this queue item is blocked from building.

property is_buildable: bool

True if this queue item is ready to be built.

is_queued() → bool

Return True if this queued item is queued.

is_running() → bool

Return True if this queued item is running.

property is_stuck: bool

True if this queue item is stuck (blocked for a long time).

property name

property queue_id

property why