:py:mod:`pywebui.queues` ======================== .. py:module:: pywebui.queues Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: pywebui.queues.Queue pywebui.queues.QueueDetails pywebui.queues.Job pywebui.queues.QueuesMethods .. py:class:: Queue Queue object. .. attribute:: description The text that describes the specified queue. :type: str .. attribute:: executingJobCount The number of jobs in the queue that are currently executing. :type: int .. attribute:: holdingJobCount The number of jobs in the queue being held until explicitly released. :type: int .. attribute:: jobCount The total amount of jobs (jobCount = executingJobCount + holdingJobCount + pendingJobCount + retainedJobCount + timedReleaseJobCount). :type: int .. attribute:: jobLimit The maximum number of jobs that can execute simultaneously on a queue. :type: int .. attribute:: 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 .. attribute:: nodeName The name of the node. :type: str .. attribute:: pendingJobCount The number of jobs in the queue in a pending state. :type: int .. attribute:: retain The circumstances under which you want your jobs to be retained in a queue. :type: str .. attribute:: retainedJobCount The number of jobs in the queue retained after successful completion plus those retained on error. :type: int .. attribute:: status The queue’s status. :type: dict .. attribute:: timedReleaseJobCount The number of jobs in the queue on hold until a specified time. :type: int .. attribute:: queueName The name of queue. :type: str .. attribute:: queueType The type of queue. :type: str .. py:class:: QueueDetails QueueDetails object. .. attribute:: autostartOn The names of the nodes on which the specified autostart queue can be run. :type: str .. attribute:: 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 .. attribute:: default The text that describes the specified queue. :type: str .. attribute:: description The text that describes the specified queue. :type: str .. attribute:: enableGeneric Is the queue an execution queue that can accept work from a generic queue. :type: str .. attribute:: jobLimit The maximum number of jobs that can execute simultaneously on a queue. :type: int .. attribute:: jobs The array of jobs, contains list of jobs with details information. :type: list(str) .. attribute:: library The name of the device control library for the queue. :type: str .. attribute:: 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 .. attribute:: nodeName The name of the node on which the execution queue is located. :type: str .. attribute:: options The queue’s option array, which contains option information. :type: list(str) .. attribute:: owner The owner name of the queue. :type: str .. attribute:: processor The name of the symbiont image that executes print jobs initiated from the queue. :type: str .. attribute:: protection The string with queue protection information. :type: str .. attribute:: queueName The name of queue. :type: str .. attribute:: 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 .. attribute:: separate The string with queue settings. :type: str .. attribute:: status The queue’s status object, which contains details of status. :type: dict .. py:class:: Job Job object. .. attribute:: description The text that describes the specified job. :type: str .. attribute:: entry The queue entry number of the job. :type: int .. attribute:: files list The array of names which are contained in the job. :type: (str) .. attribute:: jobName The name of the job. :type: str .. attribute:: jobSize The total number of disk blocks in the print job. :type: int .. attribute:: note The note that is to be printed on the job flag and file flag pages of the job. :type: str .. attribute:: status The job’s status object, which contains details of status. :type: dict .. attribute:: userName The user name of the owner of the job. :type: str .. py:class:: QueuesMethods Encapsulates methods for manage queues. .. py:method:: get_batch_queues(self) -> List[Queue] Returns the list of batch queues. .. py:method:: get_printer_queues(self) -> List[Queue] Returns the list of printer queues. .. py:method:: get_queue(self, queue: str) -> QueueDetails Returns the details of selected queue. .. py:method:: start_queue(self, queue: str) -> bool Starts selected queue. .. py:method:: pause_queue(self, queue: str) -> bool Pauses selected queue. .. py:method:: stop_queue(self, queue: str) -> bool Stops selected queue. .. py:method:: edit_queue_description(self, queue: str, description: str) -> bool Edits description of selected queue. .. py:method:: start_job(self, job: str, queue: str) -> bool Starts selected job in queue. .. py:method:: pause_job(self, job: str, queue: str) -> bool Pauses selected job in queue. Job gets status “Holding” and retain in queue until release. .. py:method:: delete_job(self, job: str, queue: str) -> bool Deletes selected job from queue.