Class QuantumJobsClient

Hierarchy (View Summary)

QbraidClient
- QuantumJobsClient

Index

Constructors

Properties

Methods

cancelJobs deleteJob deleteMultipleJobs getJobs getUser runningInLab

Constructors

constructor

new QuantumJobsClient(session?: QbraidSession): QuantumJobsClient
Parameters
- Optionalsession: QbraidSession
Returns QuantumJobsClient
Overrides QbraidClient.constructor
- Defined in jobs/src/client.ts:15

Properties

`Protected`session

session: QbraidSession

The QbraidSession instance used by this client.

Methods

cancelJobs

cancelJobs(jobId: string): Promise<CancelResponse>
Parameters
- jobId: string
Returns Promise<CancelResponse>
- Defined in jobs/src/client.ts:60

deleteJob

deleteJob(jobId: string): Promise<DeleteSingleJobResponse>
Parameters
- jobId: string
Returns Promise<DeleteSingleJobResponse>
- Defined in jobs/src/client.ts:42

deleteMultipleJobs

deleteMultipleJobs(jobIdArray: string[]): Promise<DeleteMultipleJobsResponse>
Parameters
- jobIdArray: string[]
Returns Promise<DeleteMultipleJobsResponse>
- Defined in jobs/src/client.ts:49

getJobs

getJobs(params?: JobQueryParams): Promise<QuantumJobResponse>
Parameters
- Optionalparams: JobQueryParams
Returns Promise<QuantumJobResponse>
- Defined in jobs/src/client.ts:19

getUser

getUser(): Promise<QbraidUser>
Returns Promise<QbraidUser>
Inherited from QbraidClient.getUser
- Defined in base/dist/src/client.d.ts:9

runningInLab

runningInLab(): Promise<boolean>
Returns Promise<boolean>
Inherited from QbraidClient.runningInLab
- Defined in base/dist/src/client.d.ts:10