pywebui.queues¶
Module Contents¶
Classes¶
Queue object. |
|
QueueDetails object. |
|
Job object. |
|
Encapsulates methods for manage queues. |
- class pywebui.queues.Queue¶
Queue object.
- description¶
The text that describes the specified queue.
- Type
str
- executingJobCount¶
The number of jobs in the queue that are currently executing.
- Type
int
- holdingJobCount¶
The number of jobs in the queue being held until explicitly released.
- Type
int
- jobCount¶
The total amount of jobs (jobCount = executingJobCount + holdingJobCount + pendingJobCount + retainedJobCount + timedReleaseJobCount).
- Type
int
- jobLimit¶
The maximum number of jobs that can execute simultaneously on a queue.
- Type
int
- mountedForm¶
The name of the specified form or the mounted form associated with the specified job or queue. Contains also the name of the paper stock on which the specified form is to be printed (using for printer queues).
- Type
str
- nodeName¶
The name of the node.
- Type
str
- pendingJobCount¶
The number of jobs in the queue in a pending state.
- Type
int
- retain¶
The circumstances under which you want your jobs to be retained in a queue.
- Type
str
- retainedJobCount¶
The number of jobs in the queue retained after successful completion plus those retained on error.
- Type
int
- status¶
The queue’s status.
- Type
dict
- timedReleaseJobCount¶
The number of jobs in the queue on hold until a specified time.
- Type
int
- queueName¶
The name of queue.
- Type
str
- queueType¶
The type of queue.
- Type
str
- class pywebui.queues.QueueDetails¶
QueueDetails object.
- autostartOn¶
The names of the nodes on which the specified autostart queue can be run.
- Type
str
- basePriority¶
The priority at which batch jobs are initiated from a batch execution queue or the priority of symbiont process that controls output execution queues.
- Type
int
- default¶
The text that describes the specified queue.
- Type
str
- description¶
The text that describes the specified queue.
- Type
str
- enableGeneric¶
Is the queue an execution queue that can accept work from a generic queue.
- Type
str
- jobLimit¶
The maximum number of jobs that can execute simultaneously on a queue.
- Type
int
- jobs¶
The array of jobs, contains list of jobs with details information.
- Type
list(str)
- library¶
The name of the device control library for the queue.
- Type
str
- mountedForm¶
The name of the specified form or the mounted form associated with the specified job or queue. Contains also the name of the paper stock on which the specified form is to be printed (using for printer queues).
- Type
str
- nodeName¶
The name of the node on which the execution queue is located.
- Type
str
- options¶
The queue’s option array, which contains option information.
- Type
list(str)
- owner¶
The owner name of the queue.
- Type
str
- processor¶
The name of the symbiont image that executes print jobs initiated from the queue.
- Type
str
- protection¶
The string with queue protection information.
- Type
str
- queueName¶
The name of queue.
- Type
str
- schedule¶
The information if jobs initiated from the queue are scheduled according to size, with the smallest job of a given priority processed first.
- Type
str
- separate¶
The string with queue settings.
- Type
str
- status¶
The queue’s status object, which contains details of status.
- Type
dict
- class pywebui.queues.Job¶
Job object.
- description¶
The text that describes the specified job.
- Type
str
- entry¶
The queue entry number of the job.
- Type
int
- files list
The array of names which are contained in the job.
- Type
(str)
- jobName¶
The name of the job.
- Type
str
- jobSize¶
The total number of disk blocks in the print job.
- Type
int
- note¶
The note that is to be printed on the job flag and file flag pages of the job.
- Type
str
- status¶
The job’s status object, which contains details of status.
- Type
dict
- userName¶
The user name of the owner of the job.
- Type
str
- class pywebui.queues.QueuesMethods¶
Encapsulates methods for manage queues.
- get_queue(self, queue: str) QueueDetails¶
Returns the details of selected queue.
- start_queue(self, queue: str) bool¶
Starts selected queue.
- pause_queue(self, queue: str) bool¶
Pauses selected queue.
- stop_queue(self, queue: str) bool¶
Stops selected queue.
- edit_queue_description(self, queue: str, description: str) bool¶
Edits description of selected queue.
- start_job(self, job: str, queue: str) bool¶
Starts selected job in queue.
- pause_job(self, job: str, queue: str) bool¶
Pauses selected job in queue.
Job gets status “Holding” and retain in queue until release.
- delete_job(self, job: str, queue: str) bool¶
Deletes selected job from queue.