JobDetails Class

Job details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance

azure.quantum._client.models._models.ItemDetails

JobDetails

Constructor

JobDetails(*, id: str, name: str, provider_id: str, target: str, container_uri: str, input_data_format: str, cost_estimate: _models.CostEstimate | None = None, error_data: _models.ErrorData | None = None, session_id: str | None = None, input_data_uri: str | None = None, input_params: MutableMapping[str, Any] | None = None, metadata: Dict[str, str] | None = None, output_data_uri: str | None = None, output_data_format: str | None = None, tags: List[str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str The id of the item. Required.
name	str 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	str The unique identifier for the provider. Required.
target	str The target identifier to run the job. Required.
cost_estimate	<xref:azure.quantum._client.models.CostEstimate> The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates.
error_data	<xref:azure.quantum._client.models.ErrorData> An error response from Azure.
session_id	str The ID of the session that the job is part of.
container_uri	str The blob container SAS uri, the container is used to host job data. Required.
input_data_uri	str The input blob SAS uri, if specified, it will override the default input blob in the container.
input_data_format	str The format of the input data. Required.
input_params	<xref:JSON> 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.
metadata	dict[str, str] The job metadata. Metadata provides client the ability to store client-specific information.
output_data_uri	str The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob.
output_data_format	str The format of the output data.
tags	list[str] List of user-supplied tags associated with the job.

Variables

Name	Description
id	str The id of the item. Required.
name	str 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	str The unique identifier for the provider. Required.
target	str The target identifier to run the job. Required.
item_type	str or <xref:azure.quantum._client.models.ItemType> The type of item. Required. Known values are: "Job" and "Session".
creation_time	datetime The creation time of the item.
begin_execution_time	datetime The time when the item began execution.
end_execution_time	datetime The time when the item finished execution.
cost_estimate	<xref:azure.quantum._client.models.CostEstimate> The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates.
error_data	<xref:azure.quantum._client.models.ErrorData> An error response from Azure.
job_type	str or <xref:azure.quantum._client.models.JobType> The type of job. Known values are: "Unknown", "QuantumComputing", and "Optimization".
session_id	str The ID of the session that the job is part of.
container_uri	str The blob container SAS uri, the container is used to host job data. Required.
input_data_uri	str The input blob SAS uri, if specified, it will override the default input blob in the container.
input_data_format	str The format of the input data. Required.
input_params	<xref:JSON> 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.
status	str or <xref:azure.quantum._client.models.JobStatus> The status of the job. Known values are: "Waiting", "Executing", "Succeeded", "Failed", and "Cancelled".
metadata	dict[str, str] The job metadata. Metadata provides client the ability to store client-specific information.
output_data_uri	str The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob.
output_data_format	str The format of the output data.
cancellation_time	datetime The time when a job was successfully cancelled.
quantum_computing_data	<xref:azure.quantum._client.models.QuantumComputingData> Quantum computing data.
tags	list[str] List of user-supplied tags associated with the job.