Class QuantumJobsClientV1

Base qBraid client for interacting with qBraid Cloud Services (V1 API). This client requires a QbraidSessionV1 to be provided.

Hierarchy (View Summary)

QbraidClientV1
- QuantumJobsClientV1

Index

Constructors

Properties

Methods

cancelGroup cancelJob deleteGroup deleteJob deleteMultipleJobs getGroupJobs getGroups getJobProgram getJobResult getJobs getJobsStatuses

Constructors

constructor

new QuantumJobsClientV1(session: QbraidSessionV1): QuantumJobsClientV1
Parameters
- session: QbraidSessionV1
Returns QuantumJobsClientV1
Overrides QbraidClientV1.constructor
- Defined in jobs/src/client.ts:84

Properties

`Protected`session

session: QbraidSessionV1

The QbraidSessionV1 instance used by this client.

Methods

cancelGroup

cancelGroup(groupQrn: string): Promise<GroupOperationResponse>
Cancel a job group.
Parameters
- groupQrn: string
  The group QRN to cancel
Returns Promise<GroupOperationResponse>
Updated group job
- Defined in jobs/src/client.ts:206

cancelJob

cancelJob(jobQrn: string): Promise<CancelJobResponseV1>
Cancel a job by its QRN.
Parameters
- jobQrn: string
  The job QRN to cancel
Returns Promise<CancelJobResponseV1>
Cancel response
- Defined in jobs/src/client.ts:125

deleteGroup

deleteGroup(groupQrn: string): Promise<DeleteGroupResponseV1>
Delete a job group.
Parameters
- groupQrn: string
  The group QRN to delete
Returns Promise<DeleteGroupResponseV1>
Delete response
- Defined in jobs/src/client.ts:194

deleteJob

deleteJob(jobQrn: string): Promise<DeleteJobResponseV1>
Delete a single job by its QRN.
Parameters
- jobQrn: string
  The job QRN to delete
Returns Promise<DeleteJobResponseV1>
Delete response
- Defined in jobs/src/client.ts:103

deleteMultipleJobs

deleteMultipleJobs(jobQrns: string[]): Promise<DeleteMultipleJobsResponseV1>
Delete multiple jobs by their QRNs.
Parameters
- jobQrns: string[]
  Array of job QRNs to delete
Returns Promise<DeleteMultipleJobsResponseV1>
Delete response with lists of deleted and failed jobs
- Defined in jobs/src/client.ts:113

getGroupJobs

getGroupJobs(groupQrn: string): Promise<GroupJobsResponse>
Get all jobs within a group.
Parameters
- groupQrn: string
  The group QRN to get jobs for
Returns Promise<GroupJobsResponse>
List of platform jobs in the group
- Defined in jobs/src/client.ts:182

getGroups

getGroups(params?: GroupListParams): Promise<GroupListResponse>
Get all job groups.
Parameters
- Optionalparams: GroupListParams
  Optional query parameters to filter groups
Returns Promise<GroupListResponse>
List of group jobs
- Defined in jobs/src/client.ts:172

getJobProgram

getJobProgram(jobQrn: string): Promise<ProgramData>
Get the program/circuit data for a job.
Parameters
- jobQrn: string
  The job QRN to get program for
Returns Promise<ProgramData>
Program data with format and circuit string
- Defined in jobs/src/client.ts:148

getJobResult

getJobResult(jobQrn: string): Promise<JobResult>
Get the result of a completed job.
Parameters
- jobQrn: string
  The job QRN to get results for
Returns Promise<JobResult>
Job result with status, cost, timestamps, and result data
- Defined in jobs/src/client.ts:138

getJobs

getJobs(params?: JobQueryParamsV1): Promise<QuantumJobsResponseV1>
Get jobs from the V1 API.
Parameters
- Optionalparams: JobQueryParamsV1
  Optional query parameters to filter jobs
Returns Promise<QuantumJobsResponseV1>
Array of PlatformJob objects
- Defined in jobs/src/client.ts:93

getJobsStatuses

getJobsStatuses(): Promise<JobsStatusesResponse>
Get the status list of all jobs.

Returns Promise<JobsStatusesResponse>
Job status response with counts of jobs in various statuses
- Defined in jobs/src/client.ts:159