69 lines
2.1 KiB
Plaintext
69 lines
2.1 KiB
Plaintext
---
|
||
title: QueueInfo
|
||
description: API reference for qiskit.providers.ibmq.job.QueueInfo
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.ibmq.job.QueueInfo
|
||
---
|
||
|
||
# QueueInfo
|
||
|
||
<Class id="qiskit.providers.ibmq.job.QueueInfo" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.19/qiskit/providers/ibmq/job/queueinfo.py" signature="QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)" modifiers="class">
|
||
Bases: `object`
|
||
|
||
Queue information for a job.
|
||
|
||
QueueInfo constructor.
|
||
|
||
**Parameters**
|
||
|
||
* **position** (`Optional`\[`int`]) – Position in the queue.
|
||
* **status** (`Optional`\[`str`]) – Job status.
|
||
* **estimated\_start\_time** (`Union`\[`str`, `datetime`, `None`]) – Estimated start time for the job, in UTC.
|
||
* **estimated\_complete\_time** (`Union`\[`str`, `datetime`, `None`]) – Estimated complete time for the job, in UTC.
|
||
* **hub\_priority** (`Optional`\[`float`]) – Dynamic priority for the hub.
|
||
* **group\_priority** (`Optional`\[`float`]) – Dynamic priority for the group.
|
||
* **project\_priority** (`Optional`\[`float`]) – Dynamic priority for the project.
|
||
* **job\_id** (`Optional`\[`str`]) – Job ID.
|
||
* **kwargs** (`Any`) – Additional attributes.
|
||
|
||
## Methods
|
||
|
||
### format
|
||
|
||
<Function id="qiskit.providers.ibmq.job.QueueInfo.format" signature="QueueInfo.format()">
|
||
Build a user-friendly report for the job queue information.
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
|
||
**Returns**
|
||
|
||
The job queue information report.
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### estimated\_complete\_time
|
||
|
||
<Attribute id="qiskit.providers.ibmq.job.QueueInfo.estimated_complete_time">
|
||
Return estimated complete time in local time.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`datetime`]
|
||
</Attribute>
|
||
|
||
### estimated\_start\_time
|
||
|
||
<Attribute id="qiskit.providers.ibmq.job.QueueInfo.estimated_start_time">
|
||
Return estimated start time in local time.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`datetime`]
|
||
</Attribute>
|
||
</Class>
|
||
|