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

cancelJob deleteJob deleteMultipleJobs getJobs

Constructors

constructor

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

Properties

`Protected`session

session: QbraidSessionV1

The QbraidSessionV1 instance used by this client.

Methods

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:117

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:95

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:105

getJobs

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