JobDetails Class
A job to be run in the workspace.
Constructor
JobDetails(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
name
|
The name of the item. It is not required for the name to be unique and it's only used for display purposes. Required. |
|
provider_id
|
The unique identifier for the provider. Required. |
|
target
|
The target identifier to run the job. Required. |
|
creation_time
|
The creation time of the item. |
|
created_by
|
The identity that created the item. |
|
created_by_type
|
str or
<xref:azure.quantum.models.CreatedByType>
The type of identity that created the item. Known values are: "User", "Application", "ManagedIdentity", and "Key". |
|
last_modified_time
|
The timestamp of the item last modification initiated by the customer. |
|
last_modified_by
|
The identity that last modified the item. |
|
last_modified_by_type
|
str or
<xref:azure.quantum.models.CreatedByType>
The type of identity that last modified the item. Known values are: "User", "Application", "ManagedIdentity", and "Key". |
|
last_updated_time
|
The last time the item was updated by the system. |
|
begin_execution_time
|
The time when the item began execution. |
|
end_execution_time
|
The time when the item finished execution. |
|
cost_estimate
|
<xref:azure.quantum.models.CostEstimate>
Cost estimate. |
|
error_data
|
<xref:azure.quantum.models.WorkspaceItemError>
Error information. |
|
priority
|
str or
<xref:azure.quantum.models.Priority>
Priority of job or session. Known values are: "Standard" and "High". |
|
tags
|
List of user-supplied tags associated with the job. |
|
usage
|
<xref:azure.quantum.models.Usage>
Resource consumption metrics containing provider-specific usage data such as execution time, quantum shots consumed etc. |
|
id
|
Id of the job. Required. |
|
item_type
|
str or
<xref:azure.quantum.models.JOB>
Type of the Quantum Workspace item is Job. Required. A program, problem, or application submitted for processing. |
|
job_type
|
str or
<xref:azure.quantum.models.JobType>
The type of job. Known values are: "Unknown", "QuantumComputing", and "Optimization". |
|
session_id
|
The ID of the session that the job is part of. |
|
container_uri
|
The blob container SAS uri, the container is used to host job data. Required. |
|
input_data_uri
|
The input blob URI, if specified, it will override the default input blob in the container. |
|
input_data_format
|
The format of the input data. |
|
status
|
str or
<xref:azure.quantum.models.JobStatus>
The status of the job. Known values are: "Queued", "Waiting", "Executing", "CancellationRequested", "Cancelling", "Finishing", "Completed", "Succeeded", "Failed", and "Cancelled". |
|
metadata
|
The job metadata. Metadata provides client the ability to store client-specific information. |
|
cancellation_time
|
The time when a job was successfully cancelled. |
|
quantum_computing_data
|
<xref:azure.quantum.models.QuantumComputingData>
Quantum computing data. |
|
input_params
|
The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data. |
|
output_data_uri
|
The output blob uri. When a job finishes successfully, results will be uploaded to this blob. |
|
output_data_format
|
The format of the output data. |
Attributes
cancellation_time
The time when a job was successfully cancelled.
cancellation_time: datetime | None
container_uri
The blob container SAS uri, the container is used to host job data. Required.
container_uri: str
input_data_format
The format of the input data.
input_data_format: str | None
input_data_uri
The input blob URI, if specified, it will override the default input blob in the container.
input_data_uri: str | None
input_params
The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data.
input_params: Any | None
item_type
Type of the Quantum Workspace item is Job. Required. A program, problem, or application submitted for processing.
item_type: JOB: 'Job'>]
job_type
"Unknown", "QuantumComputing", and "Optimization".
job_type: str | _models.JobType | None
metadata
The job metadata. Metadata provides client the ability to store client-specific information.
metadata: Any | None
output_data_format
The format of the output data.
output_data_format: str | None
output_data_uri
The output blob uri. When a job finishes successfully, results will be uploaded to this blob.
output_data_uri: str | None
quantum_computing_data
Quantum computing data.
quantum_computing_data: _models.QuantumComputingData | None
session_id
The ID of the session that the job is part of.
session_id: str | None
status
"Queued", "Waiting", "Executing", "CancellationRequested", "Cancelling", "Finishing", "Completed", "Succeeded", "Failed", and "Cancelled".
status: str | _models.JobStatus | None