SessionDetails Class

Session 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

SessionDetails

Constructor

SessionDetails(*, id: str, name: str, provider_id: str, target: str, cost_estimate: _models.CostEstimate | None = None, error_data: _models.ErrorData | None = None, job_failure_policy: str | _models.SessionJobFailurePolicy = 'Abort', **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.
job_failure_policy	str or <xref:azure.quantum._client.models.SessionJobFailurePolicy> Policy controlling the behavior of the Session when a job in the session fails. Known values are: "Abort" and "Continue". default value: Abort

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_failure_policy	str or <xref:azure.quantum._client.models.SessionJobFailurePolicy> Policy controlling the behavior of the Session when a job in the session fails. Known values are: "Abort" and "Continue".
status	str or <xref:azure.quantum._client.models.SessionStatus> The status of the session. Known values are: "Waiting", "Executing", "Succeeded", "Failed", "Failure(s)", and "TimedOut".