Class API

Quantum as a Service API.

This API allows you to manage Scaleway Quantum as a Service.

Hierarchy

API
- API

Constructors

constructor

new API(client): Qaas.v1alpha1.API
Parameters
- client: Client
Returns Qaas.v1alpha1.API
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

cancelJob

cancelJob(request): Promise<Job>
Cancel a job. Cancel the job corresponding to the provided job ID.
Parameters
- request: Readonly<CancelJobRequest>
  The request CancelJobRequest
Returns Promise<Job>
A Promise of Job
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:237

cancelProcess

cancelProcess(request): Promise<Process>
Cancel a running process. Cancel a process by its unique ID. Intermediate results are still available.
Parameters
- request: Readonly<CancelProcessRequest>
  The request CancelProcessRequest
Returns Promise<Process>
A Promise of Process
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:601

createJob

createJob(request): Promise<Job>
Create a job. Create a job to be executed inside a session.
Parameters
- request: Readonly<Qaas.v1alpha1.CreateJobRequest>
  The request CreateJobRequest
Returns Promise<Job>
A Promise of Job
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:198

createProcess

createProcess(request): Promise<Process>
Create a process. Create a new process for the specified application on a specified platform.
Parameters
- request: Readonly<Qaas.v1alpha1.CreateProcessRequest>
  The request CreateProcessRequest
Returns Promise<Process>
A Promise of Process
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:491

createSession

createSession(request): Promise<Qaas.v1alpha1.Session>
Create a session. Create a dedicated session for the specified platform.
Parameters
- request: Readonly<Qaas.v1alpha1.CreateSessionRequest>
  The request CreateSessionRequest
Returns Promise<Qaas.v1alpha1.Session>
A Promise of Session
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:399

deleteJob

deleteJob(request): Promise<void>
Delete a job. Delete the job corresponding to the provided job ID.
Parameters
- request: Readonly<DeleteJobRequest>
  The request DeleteJobRequest
Returns Promise<void>
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:253

deleteProcess

deleteProcess(request): Promise<void>
Delete an existing process. Delete a process by its unique ID and delete all its data.
Parameters
- request: Readonly<DeleteProcessRequest>
  The request DeleteProcessRequest
Returns Promise<void>
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:618

deleteSession

deleteSession(request): Promise<void>
Delete an existing session. Delete a session by its unique ID and delete all its attached jobs.
Parameters
- request: Readonly<DeleteSessionRequest>
  The request DeleteSessionRequest
Returns Promise<void>
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:456

getApplication

getApplication(request): Promise<Qaas.v1alpha1.Application>
Get application information. Retrieve information about the provided applcation ID, such as name, type and compatible platforms.
Parameters
- request: Readonly<Qaas.v1alpha1.GetApplicationRequest>
  The request GetApplicationRequest
Returns Promise<Qaas.v1alpha1.Application>
A Promise of Application
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:664

getJob

getJob(request): Promise<Job>
Get job information. Retrieve information about the provided job ID, such as status, payload, and result.
Parameters
- request: Readonly<GetJobRequest>
  The request GetJobRequest
Returns Promise<Job>
A Promise of Job
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:99

getJobCircuit

getJobCircuit(request): Promise<JobCircuit>
Get a job circuit. Retrieve the circuit of the provided job ID.
Parameters
- request: Readonly<GetJobCircuitRequest>
  The request GetJobCircuitRequest
Returns Promise<JobCircuit>
A Promise of JobCircuit
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:265

getPlatform

getPlatform(request): Promise<Platform>
Get platform information. Retrieve information about the provided platform ID, such as provider name, technology, and type.
Parameters
- request: Readonly<GetPlatformRequest>
  The request GetPlatformRequest
Returns Promise<Platform>
A Promise of Platform
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:281

getProcess

getProcess(request): Promise<Process>
Get process infrormation. Retrieve information about the provided process ID, such as name, status and progress.
Parameters
- request: Readonly<GetProcessRequest>
  The request GetProcessRequest
Returns Promise<Process>
A Promise of Process
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:511

getSession

getSession(request): Promise<Qaas.v1alpha1.Session>
Get session infrormation. Retrieve information about the provided session ID, such as name, status, and number of executed jobs.
Parameters
- request: Readonly<GetSessionRequest>
  The request GetSessionRequest
Returns Promise<Qaas.v1alpha1.Session>
A Promise of Session
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:330

listApplications

listApplications(request?): Promise<Qaas.v1alpha1.ListApplicationsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Application[], void, void>);
all: (() => Promise<Qaas.v1alpha1.Application[]>);
}
List all available applications. Retrieve information about all applications.
Parameters
- request: Readonly<Qaas.v1alpha1.ListApplicationsRequest> = {}
  The request ListApplicationsRequest
Returns Promise<Qaas.v1alpha1.ListApplicationsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Application[], void, void>);
all: (() => Promise<Qaas.v1alpha1.Application[]>);
}
A Promise of ListApplicationsResponse
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:701

listJobResults

listJobResults(request): Promise<ListJobResultsResponse> & {
[asyncIterator]: (() => AsyncGenerator<JobResult[], void, void>);
all: (() => Promise<JobResult[]>);
}
List all results of a job. Retrieve all intermediate and final results of a job.
Parameters
- request: Readonly<ListJobResultsRequest>
  The request ListJobResultsRequest
Returns Promise<ListJobResultsResponse> & {
[asyncIterator]: (() => AsyncGenerator<JobResult[], void, void>);
all: (() => Promise<JobResult[]>);
}
A Promise of ListJobResultsResponse
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:189

listJobs

listJobs(request?): Promise<ListJobsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Job[], void, void>);
all: (() => Promise<Job[]>);
}
List all jobs within a project or session. Retrieve information about all jobs within a given project or session.
Parameters
- request: Readonly<ListJobsRequest> = {}
  The request ListJobsRequest
Returns Promise<ListJobsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Job[], void, void>);
all: (() => Promise<Job[]>);
}
A Promise of ListJobsResponse
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:162

listPlatforms

listPlatforms(request?): Promise<ListPlatformsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Platform[], void, void>);
all: (() => Promise<Platform[]>);
}
List all available platforms. Retrieve information about all platforms.
Parameters
- request: Readonly<ListPlatformsRequest> = {}
  The request ListPlatformsRequest
Returns Promise<ListPlatformsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Platform[], void, void>);
all: (() => Promise<Platform[]>);
}
A Promise of ListPlatformsResponse
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:320

listProcessResults

listProcessResults(request): Promise<ListProcessResultsResponse> & {
[asyncIterator]: (() => AsyncGenerator<ProcessResult[], void, void>);
all: (() => Promise<ProcessResult[]>);
}
List all results of a process. Retrieve all intermediate and final result of a process.
Parameters
- request: Readonly<ListProcessResultsRequest>
  The request ListProcessResultsRequest
Returns Promise<ListProcessResultsResponse> & {
[asyncIterator]: (() => AsyncGenerator<ProcessResult[], void, void>);
all: (() => Promise<ProcessResult[]>);
}
A Promise of ListProcessResultsResponse
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:650

listProcesses

listProcesses(request?): Promise<ListProcessesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Process[], void, void>);
all: (() => Promise<Process[]>);
}
List all processes. Retrieve information about all processes.
Parameters
- request: Readonly<ListProcessesRequest> = {}
  The request ListProcessesRequest
Returns Promise<ListProcessesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Process[], void, void>);
all: (() => Promise<Process[]>);
}
A Promise of ListProcessesResponse
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:571

listSessionACLs

listSessionACLs(request): Promise<ListSessionACLsResponse> & {
[asyncIterator]: (() => AsyncGenerator<SessionAccess[], void, void>);
all: (() => Promise<SessionAccess[]>);
}
Parameters
- request: Readonly<ListSessionACLsRequest>
Returns Promise<ListSessionACLsResponse> & {
[asyncIterator]: (() => AsyncGenerator<SessionAccess[], void, void>);
all: (() => Promise<SessionAccess[]>);
}
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:481

listSessions

listSessions(request?): Promise<ListSessionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Session[], void, void>);
all: (() => Promise<Qaas.v1alpha1.Session[]>);
}
List all sessions. Retrieve information about all sessions.
Parameters
- request: Readonly<ListSessionsRequest> = {}
  The request ListSessionsRequest
Returns Promise<ListSessionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Session[], void, void>);
all: (() => Promise<Qaas.v1alpha1.Session[]>);
}
A Promise of ListSessionsResponse
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:390

terminateSession

terminateSession(request): Promise<Qaas.v1alpha1.Session>
Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs.
Parameters
- request: Readonly<TerminateSessionRequest>
  The request TerminateSessionRequest
Returns Promise<Qaas.v1alpha1.Session>
A Promise of Session
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:439

updateJob

updateJob(request): Promise<Job>
Update job information. Update job information about the provided job ID.
Parameters
- request: Readonly<UpdateJobRequest>
  The request UpdateJobRequest
Returns Promise<Job>
A Promise of Job
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:218

updateProcess

updateProcess(request): Promise<Process>
Update process information. Update process information of the provided process ID.
Parameters
- request: Readonly<UpdateProcessRequest>
  The request UpdateProcessRequest
Returns Promise<Process>
A Promise of Process
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:581

updateSession

updateSession(request): Promise<Qaas.v1alpha1.Session>
Update session information. Update session information of the provided session ID.
Parameters
- request: Readonly<UpdateSessionRequest>
  The request UpdateSessionRequest
Returns Promise<Qaas.v1alpha1.Session>
A Promise of Session
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:419

waitForJob

waitForJob(request, options?): Promise<Job>
Waits for Job to be in a final state.
Parameters
- request: Readonly<GetJobRequest>
  The request GetJobRequest
- Optionaloptions: Readonly<WaitForOptions<Job>>
  The waiting options
Returns Promise<Job>
A Promise of Job
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:115

waitForProcess

waitForProcess(request, options?): Promise<Process>
Waits for Process to be in a final state.
Parameters
- request: Readonly<GetProcessRequest>
  The request GetProcessRequest
- Optionaloptions: Readonly<WaitForOptions<Process>>
  The waiting options
Returns Promise<Process>
A Promise of Process
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:527

waitForSession

waitForSession(request, options?): Promise<Qaas.v1alpha1.Session>
Waits for Session to be in a final state.
Parameters
- request: Readonly<GetSessionRequest>
  The request GetSessionRequest
- Optionaloptions: Readonly<WaitForOptions<Qaas.v1alpha1.Session>>
  The waiting options
Returns Promise<Qaas.v1alpha1.Session>
A Promise of Session
- Defined in packages/clients/src/api/qaas/v1alpha1/api.gen.ts:346

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Qaas.v1alpha1.API

Methods

cancelJob

Parameters

Returns Promise<Job>

cancelProcess

Parameters

Returns Promise<Process>

createJob

Parameters

Returns Promise<Job>

createProcess

Parameters

Returns Promise<Process>

createSession

Parameters

Returns Promise<Qaas.v1alpha1.Session>

deleteJob

Parameters

Returns Promise<void>

deleteProcess

Parameters

Returns Promise<void>

deleteSession

Parameters

Returns Promise<void>

getApplication

Parameters

Returns Promise<Qaas.v1alpha1.Application>

getJob

Parameters

Returns Promise<Job>

getJobCircuit

Parameters

Returns Promise<JobCircuit>

getPlatform

Parameters

Returns Promise<Platform>

getProcess

Parameters

Returns Promise<Process>

getSession

Parameters

Returns Promise<Qaas.v1alpha1.Session>

listApplications

Parameters

Returns Promise<Qaas.v1alpha1.ListApplicationsResponse> & { [asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Application[], void, void>); all: (() => Promise<Qaas.v1alpha1.Application[]>); }

listJobResults

Parameters

Returns Promise<ListJobResultsResponse> & { [asyncIterator]: (() => AsyncGenerator<JobResult[], void, void>); all: (() => Promise<JobResult[]>); }

listJobs

Parameters

Returns Promise<ListJobsResponse> & { [asyncIterator]: (() => AsyncGenerator<Job[], void, void>); all: (() => Promise<Job[]>); }

listPlatforms

Parameters

Returns Promise<ListPlatformsResponse> & { [asyncIterator]: (() => AsyncGenerator<Platform[], void, void>); all: (() => Promise<Platform[]>); }

listProcessResults

Parameters

Returns Promise<ListProcessResultsResponse> & { [asyncIterator]: (() => AsyncGenerator<ProcessResult[], void, void>); all: (() => Promise<ProcessResult[]>); }

listProcesses

Parameters

Returns Promise<ListProcessesResponse> & { [asyncIterator]: (() => AsyncGenerator<Process[], void, void>); all: (() => Promise<Process[]>); }

listSessionACLs

Parameters

Returns Promise<ListSessionACLsResponse> & { [asyncIterator]: (() => AsyncGenerator<SessionAccess[], void, void>); all: (() => Promise<SessionAccess[]>); }

listSessions

Parameters

Returns Promise<ListSessionsResponse> & { [asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Session[], void, void>); all: (() => Promise<Qaas.v1alpha1.Session[]>); }

terminateSession

Parameters

Returns Promise<Qaas.v1alpha1.Session>

updateJob

Returns Promise<Qaas.v1alpha1.ListApplicationsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Application[], void, void>);
all: (() => Promise<Qaas.v1alpha1.Application[]>);
}

Returns Promise<ListJobResultsResponse> & {
[asyncIterator]: (() => AsyncGenerator<JobResult[], void, void>);
all: (() => Promise<JobResult[]>);
}

Returns Promise<ListJobsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Job[], void, void>);
all: (() => Promise<Job[]>);
}

Returns Promise<ListPlatformsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Platform[], void, void>);
all: (() => Promise<Platform[]>);
}

Returns Promise<ListProcessResultsResponse> & {
[asyncIterator]: (() => AsyncGenerator<ProcessResult[], void, void>);
all: (() => Promise<ProcessResult[]>);
}

Returns Promise<ListProcessesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Process[], void, void>);
all: (() => Promise<Process[]>);
}

Returns Promise<ListSessionACLsResponse> & {
[asyncIterator]: (() => AsyncGenerator<SessionAccess[], void, void>);
all: (() => Promise<SessionAccess[]>);
}

Returns Promise<ListSessionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Qaas.v1alpha1.Session[], void, void>);
all: (() => Promise<Qaas.v1alpha1.Session[]>);
}