@scaleway/sdk-qaas 2.6.4 → 2.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/.vite/license.md +3 -0
- package/dist/_virtual/_rolldown/runtime.js +13 -0
- package/dist/index.gen.d.ts +5 -0
- package/dist/index.gen.js +2 -0
- package/dist/metadata.gen.d.ts +12 -0
- package/dist/metadata.gen.js +13 -0
- package/dist/v1alpha1/api.gen.d.ts +297 -0
- package/dist/v1alpha1/api.gen.js +198 -0
- package/dist/v1alpha1/content.gen.d.ts +9 -0
- package/dist/v1alpha1/content.gen.js +23 -0
- package/dist/v1alpha1/index.gen.d.ts +5 -0
- package/dist/v1alpha1/index.gen.js +42 -0
- package/dist/v1alpha1/marshalling.gen.d.ts +28 -0
- package/dist/v1alpha1/marshalling.gen.js +304 -0
- package/dist/v1alpha1/metadata.gen.d.ts +196 -0
- package/dist/v1alpha1/metadata.gen.js +217 -0
- package/dist/v1alpha1/types.gen.d.ts +1057 -0
- package/dist/v1alpha1/types.gen.js +0 -0
- package/dist/v1alpha1/validation-rules.gen.d.ts +10 -0
- package/dist/v1alpha1/validation-rules.gen.js +10 -0
- package/package.json +5 -5
- package/LICENSE +0 -191
|
@@ -0,0 +1,1057 @@
|
|
|
1
|
+
import type { Money } from '@scaleway/sdk-client';
|
|
2
|
+
export type ApplicationType = 'unknown_type' | 'vqe';
|
|
3
|
+
export type BookingStatus = 'unknown_status' | 'waiting' | 'validating' | 'validated' | 'cancelling' | 'cancelled' | 'error';
|
|
4
|
+
export type JobStatus = 'unknown_status' | 'waiting' | 'error' | 'running' | 'completed' | 'cancelling' | 'cancelled';
|
|
5
|
+
export type ListApplicationsRequestOrderBy = 'name_asc' | 'name_desc' | 'type_asc' | 'type_desc';
|
|
6
|
+
export type ListBookingsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'started_at_desc' | 'started_at_asc';
|
|
7
|
+
export type ListJobResultsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
|
|
8
|
+
export type ListJobsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'status_asc' | 'status_desc' | 'platform_name_asc' | 'platform_name_desc' | 'name_asc' | 'name_desc' | 'session_name_asc' | 'session_name_desc';
|
|
9
|
+
export type ListModelsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
|
|
10
|
+
export type ListPlatformsRequestOrderBy = 'name_asc' | 'name_desc' | 'provider_name_asc' | 'provider_name_desc' | 'type_asc' | 'type_desc' | 'technology_asc' | 'technology_desc' | 'backend_name_asc' | 'backend_name_desc';
|
|
11
|
+
export type ListProcessResultsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
|
|
12
|
+
export type ListProcessesRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'name_asc' | 'name_desc' | 'started_at_asc' | 'started_at_desc' | 'status_asc' | 'status_desc';
|
|
13
|
+
export type ListSessionACLsRequestOrderBy = 'access_asc' | 'access_desc';
|
|
14
|
+
export type ListSessionsRequestOrderBy = 'name_asc' | 'name_desc' | 'started_at_asc' | 'started_at_desc' | 'status_asc' | 'status_desc' | 'created_at_desc' | 'created_at_asc';
|
|
15
|
+
export type PlatformAvailability = 'unknown_availability' | 'available' | 'shortage' | 'scarce' | 'maintenance';
|
|
16
|
+
export type PlatformTechnology = 'unknown_technology' | 'photonic' | 'general_purpose' | 'trapped_ion' | 'superconducting' | 'neutral_atom';
|
|
17
|
+
export type PlatformType = 'unknown_type' | 'simulator' | 'qpu';
|
|
18
|
+
export type ProcessStatus = 'unknown_status' | 'error' | 'starting' | 'running' | 'completed' | 'cancelling' | 'cancelled';
|
|
19
|
+
export type SessionAccess = 'unknown_access' | 'full' | 'read_session' | 'read_write_session' | 'read_job_result' | 'read_job_circuit' | 'read_job' | 'read_write_job';
|
|
20
|
+
export type SessionOriginType = 'unknown_origin_type' | 'customer' | 'process';
|
|
21
|
+
export type SessionStatus = 'unknown_status' | 'running' | 'stopped' | 'starting' | 'stopping';
|
|
22
|
+
export interface PlatformBookingRequirement {
|
|
23
|
+
/**
|
|
24
|
+
* Minimal duration of any booking based on this platform.
|
|
25
|
+
*/
|
|
26
|
+
minDuration?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Maximal duration of any bookings based on this platform.
|
|
29
|
+
*/
|
|
30
|
+
maxDuration?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Allowed time to cancel a booking attached to this platform before the beginning of the session.
|
|
33
|
+
*/
|
|
34
|
+
maxCancellationDuration?: string;
|
|
35
|
+
/**
|
|
36
|
+
* Allowed planification time from now where the platform can be booked in the future.
|
|
37
|
+
*/
|
|
38
|
+
maxPlanificationDuration?: string;
|
|
39
|
+
/**
|
|
40
|
+
* Minimum planification time before a platform can be booked.
|
|
41
|
+
*/
|
|
42
|
+
minPlanificationDuration?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Maximum amount of booking allowed for one organization per week.
|
|
45
|
+
*/
|
|
46
|
+
maxBookingPerWeek: number;
|
|
47
|
+
/**
|
|
48
|
+
* Maximum amount of booking allowed for one organization per day.
|
|
49
|
+
*/
|
|
50
|
+
maxBookingPerDay: number;
|
|
51
|
+
}
|
|
52
|
+
export interface PlatformHardware {
|
|
53
|
+
/**
|
|
54
|
+
* Product name of the hardware.
|
|
55
|
+
*/
|
|
56
|
+
name: string;
|
|
57
|
+
/**
|
|
58
|
+
* Number of vCPUs available.
|
|
59
|
+
*/
|
|
60
|
+
vcpus: number;
|
|
61
|
+
/**
|
|
62
|
+
* Number of GPUs available (0 if no GPU).
|
|
63
|
+
*/
|
|
64
|
+
gpus: number;
|
|
65
|
+
/**
|
|
66
|
+
* Network topology of GPUs (PCIe, NVLink...).
|
|
67
|
+
*/
|
|
68
|
+
gpusNetwork: string;
|
|
69
|
+
/**
|
|
70
|
+
* Amount of RAM available in byte.
|
|
71
|
+
*/
|
|
72
|
+
ram: number;
|
|
73
|
+
/**
|
|
74
|
+
* Amount of VRAM available in byte (0 if no GPU).
|
|
75
|
+
*/
|
|
76
|
+
vram: number;
|
|
77
|
+
}
|
|
78
|
+
export interface JobCircuit {
|
|
79
|
+
/**
|
|
80
|
+
* Circuit generated by Perceval that should be executed.
|
|
81
|
+
*
|
|
82
|
+
* One-of ('circuitSerialization'): at most one of 'percevalCircuit', 'qiskitCircuit' could be set.
|
|
83
|
+
*/
|
|
84
|
+
percevalCircuit?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Circuit generated by Qiskit that should be executed.
|
|
87
|
+
*
|
|
88
|
+
* One-of ('circuitSerialization'): at most one of 'percevalCircuit', 'qiskitCircuit' could be set.
|
|
89
|
+
*/
|
|
90
|
+
qiskitCircuit?: string;
|
|
91
|
+
}
|
|
92
|
+
export interface CreateSessionRequestBookingDemand {
|
|
93
|
+
startedAt?: Date;
|
|
94
|
+
finishedAt?: Date;
|
|
95
|
+
description?: string;
|
|
96
|
+
timeZone?: string;
|
|
97
|
+
}
|
|
98
|
+
export interface Application {
|
|
99
|
+
/**
|
|
100
|
+
* Unique ID of the application.
|
|
101
|
+
*/
|
|
102
|
+
id: string;
|
|
103
|
+
/**
|
|
104
|
+
* Name of the application.
|
|
105
|
+
*/
|
|
106
|
+
name: string;
|
|
107
|
+
/**
|
|
108
|
+
* Type of the application.
|
|
109
|
+
*/
|
|
110
|
+
type: ApplicationType;
|
|
111
|
+
/**
|
|
112
|
+
* List of compatible platform (by IDs) able to run this application.
|
|
113
|
+
*/
|
|
114
|
+
compatiblePlatformIds: string[];
|
|
115
|
+
/**
|
|
116
|
+
* JSON format describing the expected input.
|
|
117
|
+
*/
|
|
118
|
+
inputTemplate: string;
|
|
119
|
+
}
|
|
120
|
+
export interface Booking {
|
|
121
|
+
/**
|
|
122
|
+
* Unique ID of the booking.
|
|
123
|
+
*/
|
|
124
|
+
id: string;
|
|
125
|
+
/**
|
|
126
|
+
* Time at which the booking was created.
|
|
127
|
+
*/
|
|
128
|
+
createdAt?: Date;
|
|
129
|
+
/**
|
|
130
|
+
* Time at which the booking starts.
|
|
131
|
+
*/
|
|
132
|
+
startedAt?: Date;
|
|
133
|
+
/**
|
|
134
|
+
* Time at which the booking was updated.
|
|
135
|
+
*/
|
|
136
|
+
updatedAt?: Date;
|
|
137
|
+
/**
|
|
138
|
+
* Time at which the booking finishes.
|
|
139
|
+
*/
|
|
140
|
+
finishedAt?: Date;
|
|
141
|
+
/**
|
|
142
|
+
* Status of the booking.
|
|
143
|
+
*/
|
|
144
|
+
status: BookingStatus;
|
|
145
|
+
/**
|
|
146
|
+
* Description of the booking slot.
|
|
147
|
+
*/
|
|
148
|
+
description: string;
|
|
149
|
+
/**
|
|
150
|
+
* Any progress message of the booking.
|
|
151
|
+
*/
|
|
152
|
+
progressMessage: string;
|
|
153
|
+
/**
|
|
154
|
+
* Time zone for the booking schedule, in tz database format (e.g. 'Europe/Paris').
|
|
155
|
+
*/
|
|
156
|
+
timeZone?: string;
|
|
157
|
+
}
|
|
158
|
+
export interface JobResult {
|
|
159
|
+
/**
|
|
160
|
+
* ID of the parent job.
|
|
161
|
+
*/
|
|
162
|
+
jobId: string;
|
|
163
|
+
/**
|
|
164
|
+
* Result in JSON format.
|
|
165
|
+
*/
|
|
166
|
+
result?: string;
|
|
167
|
+
/**
|
|
168
|
+
* URL to download a large result (optional).
|
|
169
|
+
*/
|
|
170
|
+
url?: string;
|
|
171
|
+
/**
|
|
172
|
+
* Creation time of the result.
|
|
173
|
+
*/
|
|
174
|
+
createdAt?: Date;
|
|
175
|
+
}
|
|
176
|
+
export interface Job {
|
|
177
|
+
/**
|
|
178
|
+
* Unique ID of the job.
|
|
179
|
+
*/
|
|
180
|
+
id: string;
|
|
181
|
+
/**
|
|
182
|
+
* Job name.
|
|
183
|
+
*/
|
|
184
|
+
name: string;
|
|
185
|
+
/**
|
|
186
|
+
* Tags of the job.
|
|
187
|
+
*/
|
|
188
|
+
tags?: string[];
|
|
189
|
+
/**
|
|
190
|
+
* Session ID in which the job is executed.
|
|
191
|
+
*/
|
|
192
|
+
sessionId: string;
|
|
193
|
+
/**
|
|
194
|
+
* Time at which the job was created.
|
|
195
|
+
*/
|
|
196
|
+
createdAt?: Date;
|
|
197
|
+
/**
|
|
198
|
+
* Time at which the job was started.
|
|
199
|
+
*/
|
|
200
|
+
startedAt?: Date;
|
|
201
|
+
/**
|
|
202
|
+
* Time at which the job was updated.
|
|
203
|
+
*/
|
|
204
|
+
updatedAt?: Date;
|
|
205
|
+
/**
|
|
206
|
+
* Job status.
|
|
207
|
+
*/
|
|
208
|
+
status: JobStatus;
|
|
209
|
+
/**
|
|
210
|
+
* Last progress message, if the job has started.
|
|
211
|
+
*/
|
|
212
|
+
progressMessage?: string;
|
|
213
|
+
/**
|
|
214
|
+
* Duration of the job, if the job is finished.
|
|
215
|
+
*/
|
|
216
|
+
jobDuration?: string;
|
|
217
|
+
/**
|
|
218
|
+
* Result of the job, if the job is finished.
|
|
219
|
+
*/
|
|
220
|
+
resultDistribution?: string;
|
|
221
|
+
/**
|
|
222
|
+
* Computation model ID executed by the job.
|
|
223
|
+
*/
|
|
224
|
+
modelId?: string;
|
|
225
|
+
/**
|
|
226
|
+
* Execution parameters for this job.
|
|
227
|
+
*/
|
|
228
|
+
parameters?: string;
|
|
229
|
+
}
|
|
230
|
+
export interface Model {
|
|
231
|
+
/**
|
|
232
|
+
* Unique ID of the model.
|
|
233
|
+
*/
|
|
234
|
+
id: string;
|
|
235
|
+
/**
|
|
236
|
+
* Time at which the model was created.
|
|
237
|
+
*/
|
|
238
|
+
createdAt?: Date;
|
|
239
|
+
/**
|
|
240
|
+
* Storage URL of the model.
|
|
241
|
+
*/
|
|
242
|
+
url?: string;
|
|
243
|
+
/**
|
|
244
|
+
* Project ID in which the model has been created.
|
|
245
|
+
*/
|
|
246
|
+
projectId: string;
|
|
247
|
+
}
|
|
248
|
+
export interface Platform {
|
|
249
|
+
/**
|
|
250
|
+
* Unique ID of the platform.
|
|
251
|
+
*/
|
|
252
|
+
id: string;
|
|
253
|
+
/**
|
|
254
|
+
* Version of the platform.
|
|
255
|
+
*/
|
|
256
|
+
version: string;
|
|
257
|
+
/**
|
|
258
|
+
* Name of the platform.
|
|
259
|
+
*/
|
|
260
|
+
name: string;
|
|
261
|
+
/**
|
|
262
|
+
* Name of the technological provider of the platform in lowercase (quandela, pasqal...).
|
|
263
|
+
*/
|
|
264
|
+
providerName: string;
|
|
265
|
+
/**
|
|
266
|
+
* Name of the running emulation backend or QPU model of the platform in lowercase (mosaiq, qsim, aer...).
|
|
267
|
+
*/
|
|
268
|
+
backendName: string;
|
|
269
|
+
/**
|
|
270
|
+
* Type of the platform (emulator or qpu).
|
|
271
|
+
*/
|
|
272
|
+
type: PlatformType;
|
|
273
|
+
/**
|
|
274
|
+
* Quantum technology used by the platform (trapped-ion, photonic, superconducting qubits...).
|
|
275
|
+
*/
|
|
276
|
+
technology: PlatformTechnology;
|
|
277
|
+
/**
|
|
278
|
+
* Maximum number of qubits supported by the platform (estimated for emulator).
|
|
279
|
+
*/
|
|
280
|
+
maxQubitCount: number;
|
|
281
|
+
/**
|
|
282
|
+
* Maximum number of shots during a circuit execution.
|
|
283
|
+
*/
|
|
284
|
+
maxShotCount: number;
|
|
285
|
+
/**
|
|
286
|
+
* Maximum number of circuit that can be executed in one call.
|
|
287
|
+
*/
|
|
288
|
+
maxCircuitCount: number;
|
|
289
|
+
/**
|
|
290
|
+
* Availability of the platform.
|
|
291
|
+
*/
|
|
292
|
+
availability: PlatformAvailability;
|
|
293
|
+
/**
|
|
294
|
+
* Metadata provided by the platform.
|
|
295
|
+
*/
|
|
296
|
+
metadata: string;
|
|
297
|
+
/**
|
|
298
|
+
* Price to be paid per hour (excluding free tiers).
|
|
299
|
+
*/
|
|
300
|
+
pricePerHour?: Money;
|
|
301
|
+
/**
|
|
302
|
+
* Price to be paid per shot (excluding free tiers).
|
|
303
|
+
*/
|
|
304
|
+
pricePerShot?: Money;
|
|
305
|
+
/**
|
|
306
|
+
* Price to be paid per circuit setup before its execution (excluding free tiers).
|
|
307
|
+
*/
|
|
308
|
+
pricePerCircuit?: Money;
|
|
309
|
+
/**
|
|
310
|
+
* Specifications of the underlying hardware.
|
|
311
|
+
*/
|
|
312
|
+
hardware?: PlatformHardware;
|
|
313
|
+
/**
|
|
314
|
+
* Booking constraints to fit if the platform is bookable.
|
|
315
|
+
*/
|
|
316
|
+
bookingRequirement?: PlatformBookingRequirement;
|
|
317
|
+
/**
|
|
318
|
+
* English description of the platform.
|
|
319
|
+
*/
|
|
320
|
+
description: string;
|
|
321
|
+
/**
|
|
322
|
+
* Documentation link to external documentation to learn more on this platform.
|
|
323
|
+
*/
|
|
324
|
+
documentationUrl: string;
|
|
325
|
+
/**
|
|
326
|
+
* Specify if the platform is bookable.
|
|
327
|
+
*/
|
|
328
|
+
isBookable: boolean;
|
|
329
|
+
}
|
|
330
|
+
export interface ProcessResult {
|
|
331
|
+
/**
|
|
332
|
+
* ID of the parent process.
|
|
333
|
+
*/
|
|
334
|
+
processId: string;
|
|
335
|
+
/**
|
|
336
|
+
* Result in JSON format.
|
|
337
|
+
*/
|
|
338
|
+
result: string;
|
|
339
|
+
/**
|
|
340
|
+
* Creation time of the result.
|
|
341
|
+
*/
|
|
342
|
+
createdAt?: Date;
|
|
343
|
+
}
|
|
344
|
+
export interface Process {
|
|
345
|
+
/**
|
|
346
|
+
* Unique ID of the process.
|
|
347
|
+
*/
|
|
348
|
+
id: string;
|
|
349
|
+
/**
|
|
350
|
+
* Name of the process.
|
|
351
|
+
*/
|
|
352
|
+
name: string;
|
|
353
|
+
/**
|
|
354
|
+
* Application ID for which the process has been created.
|
|
355
|
+
*/
|
|
356
|
+
applicationId?: string;
|
|
357
|
+
/**
|
|
358
|
+
* Platform ID for which the process has been created.
|
|
359
|
+
*/
|
|
360
|
+
platformId?: string;
|
|
361
|
+
/**
|
|
362
|
+
* List of sessions generated by the process.
|
|
363
|
+
*/
|
|
364
|
+
attachedSessionIds: string[];
|
|
365
|
+
/**
|
|
366
|
+
* Time at which the process was created.
|
|
367
|
+
*/
|
|
368
|
+
createdAt?: Date;
|
|
369
|
+
/**
|
|
370
|
+
* Time at which the process started.
|
|
371
|
+
*/
|
|
372
|
+
startedAt?: Date;
|
|
373
|
+
/**
|
|
374
|
+
* Time at which the process was updated.
|
|
375
|
+
*/
|
|
376
|
+
updatedAt?: Date;
|
|
377
|
+
/**
|
|
378
|
+
* Time at which the process was finished.
|
|
379
|
+
*/
|
|
380
|
+
finishedAt?: Date;
|
|
381
|
+
/**
|
|
382
|
+
* Status of the process.
|
|
383
|
+
*/
|
|
384
|
+
status: ProcessStatus;
|
|
385
|
+
/**
|
|
386
|
+
* Project ID in which the process has been created.
|
|
387
|
+
*/
|
|
388
|
+
projectId: string;
|
|
389
|
+
/**
|
|
390
|
+
* Tags of the process.
|
|
391
|
+
*/
|
|
392
|
+
tags: string[];
|
|
393
|
+
/**
|
|
394
|
+
* Progress of the process, from 0 to 1.
|
|
395
|
+
*/
|
|
396
|
+
progress?: number;
|
|
397
|
+
/**
|
|
398
|
+
* Any progress of the process.
|
|
399
|
+
*/
|
|
400
|
+
progressMessage?: string;
|
|
401
|
+
/**
|
|
402
|
+
* Input payload of the process as JSON string.
|
|
403
|
+
*/
|
|
404
|
+
input?: string;
|
|
405
|
+
}
|
|
406
|
+
export interface Session {
|
|
407
|
+
/**
|
|
408
|
+
* Unique ID of the session.
|
|
409
|
+
*/
|
|
410
|
+
id: string;
|
|
411
|
+
/**
|
|
412
|
+
* Name of the session.
|
|
413
|
+
*/
|
|
414
|
+
name: string;
|
|
415
|
+
/**
|
|
416
|
+
* Platform ID for which the session has been created.
|
|
417
|
+
*/
|
|
418
|
+
platformId: string;
|
|
419
|
+
/**
|
|
420
|
+
* The time at which the session was created.
|
|
421
|
+
*/
|
|
422
|
+
createdAt?: Date;
|
|
423
|
+
/**
|
|
424
|
+
* The time at which the session started.
|
|
425
|
+
*/
|
|
426
|
+
startedAt?: Date;
|
|
427
|
+
/**
|
|
428
|
+
* The time at which the session was updated.
|
|
429
|
+
*/
|
|
430
|
+
updatedAt?: Date;
|
|
431
|
+
/**
|
|
432
|
+
* The time at which the session was terminated.
|
|
433
|
+
*/
|
|
434
|
+
terminatedAt?: Date;
|
|
435
|
+
/**
|
|
436
|
+
* Maximum idle time before the session ends.
|
|
437
|
+
*/
|
|
438
|
+
maxIdleDuration?: string;
|
|
439
|
+
/**
|
|
440
|
+
* Maximum duration before the session ends.
|
|
441
|
+
*/
|
|
442
|
+
maxDuration?: string;
|
|
443
|
+
/**
|
|
444
|
+
* Number of waiting jobs linked to the session.
|
|
445
|
+
*/
|
|
446
|
+
waitingJobCount: number;
|
|
447
|
+
/**
|
|
448
|
+
* Number of finished jobs linked to the session.
|
|
449
|
+
*/
|
|
450
|
+
finishedJobCount: number;
|
|
451
|
+
/**
|
|
452
|
+
* Status of the session.
|
|
453
|
+
*/
|
|
454
|
+
status: SessionStatus;
|
|
455
|
+
/**
|
|
456
|
+
* Project ID in which the session has been created.
|
|
457
|
+
*/
|
|
458
|
+
projectId: string;
|
|
459
|
+
/**
|
|
460
|
+
* Tags of the session.
|
|
461
|
+
*/
|
|
462
|
+
tags?: string[];
|
|
463
|
+
/**
|
|
464
|
+
* Deduplication ID of the session.
|
|
465
|
+
*/
|
|
466
|
+
deduplicationId: string;
|
|
467
|
+
/**
|
|
468
|
+
* Resource type that creates the session.
|
|
469
|
+
*/
|
|
470
|
+
originType: SessionOriginType;
|
|
471
|
+
/**
|
|
472
|
+
* Unique ID of the session's origin resource (if exists).
|
|
473
|
+
*/
|
|
474
|
+
originId?: string;
|
|
475
|
+
/**
|
|
476
|
+
* Any progress of the session.
|
|
477
|
+
*/
|
|
478
|
+
progressMessage?: string;
|
|
479
|
+
/**
|
|
480
|
+
* An optional booking unique ID of an attached booking.
|
|
481
|
+
*/
|
|
482
|
+
bookingId?: string;
|
|
483
|
+
/**
|
|
484
|
+
* Default computation model ID to be executed by job assigned to this session.
|
|
485
|
+
*/
|
|
486
|
+
modelId?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Platform configuration parameters applied to this session.
|
|
489
|
+
*/
|
|
490
|
+
parameters?: string;
|
|
491
|
+
}
|
|
492
|
+
export type CancelJobRequest = {
|
|
493
|
+
/**
|
|
494
|
+
* Unique ID of the job.
|
|
495
|
+
*/
|
|
496
|
+
jobId: string;
|
|
497
|
+
};
|
|
498
|
+
export type CancelProcessRequest = {
|
|
499
|
+
/**
|
|
500
|
+
* Unique ID of the process.
|
|
501
|
+
*/
|
|
502
|
+
processId: string;
|
|
503
|
+
};
|
|
504
|
+
export type CreateJobRequest = {
|
|
505
|
+
/**
|
|
506
|
+
* Name of the job.
|
|
507
|
+
*/
|
|
508
|
+
name: string;
|
|
509
|
+
/**
|
|
510
|
+
* Tags of the job.
|
|
511
|
+
*/
|
|
512
|
+
tags?: string[];
|
|
513
|
+
/**
|
|
514
|
+
* Session in which the job is executed.
|
|
515
|
+
*/
|
|
516
|
+
sessionId: string;
|
|
517
|
+
/**
|
|
518
|
+
* Quantum circuit that should be executed.
|
|
519
|
+
*/
|
|
520
|
+
circuit: JobCircuit;
|
|
521
|
+
/**
|
|
522
|
+
* Maximum duration of the job.
|
|
523
|
+
*/
|
|
524
|
+
maxDuration?: string;
|
|
525
|
+
/**
|
|
526
|
+
* Computation model ID to be executed by the job.
|
|
527
|
+
*/
|
|
528
|
+
modelId?: string;
|
|
529
|
+
/**
|
|
530
|
+
* Execution parameters for this job.
|
|
531
|
+
*/
|
|
532
|
+
parameters?: string;
|
|
533
|
+
};
|
|
534
|
+
export type CreateModelRequest = {
|
|
535
|
+
/**
|
|
536
|
+
* Project ID to attach this model.
|
|
537
|
+
*/
|
|
538
|
+
projectId?: string;
|
|
539
|
+
/**
|
|
540
|
+
* The serialized model data.
|
|
541
|
+
*/
|
|
542
|
+
payload?: string;
|
|
543
|
+
};
|
|
544
|
+
export type CreateProcessRequest = {
|
|
545
|
+
/**
|
|
546
|
+
* ID of the project in which the process was created.
|
|
547
|
+
*/
|
|
548
|
+
projectId?: string;
|
|
549
|
+
/**
|
|
550
|
+
* ID of the platform for which the process was created.
|
|
551
|
+
*/
|
|
552
|
+
platformId?: string;
|
|
553
|
+
/**
|
|
554
|
+
* ID of the application for which the process was created.
|
|
555
|
+
*/
|
|
556
|
+
applicationId?: string;
|
|
557
|
+
/**
|
|
558
|
+
* Name of the process.
|
|
559
|
+
*/
|
|
560
|
+
name: string;
|
|
561
|
+
/**
|
|
562
|
+
* Process parameters in JSON format.
|
|
563
|
+
*/
|
|
564
|
+
input?: string;
|
|
565
|
+
/**
|
|
566
|
+
* Tags of the process.
|
|
567
|
+
*/
|
|
568
|
+
tags?: string[];
|
|
569
|
+
};
|
|
570
|
+
export type CreateSessionRequest = {
|
|
571
|
+
/**
|
|
572
|
+
* ID of the Project in which the session was created.
|
|
573
|
+
*/
|
|
574
|
+
projectId?: string;
|
|
575
|
+
/**
|
|
576
|
+
* ID of the Platform for which the session was created.
|
|
577
|
+
*/
|
|
578
|
+
platformId: string;
|
|
579
|
+
/**
|
|
580
|
+
* Name of the session.
|
|
581
|
+
*/
|
|
582
|
+
name?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Maximum idle duration before the session ends.
|
|
585
|
+
*/
|
|
586
|
+
maxIdleDuration?: string;
|
|
587
|
+
/**
|
|
588
|
+
* Maximum duration before the session ends.
|
|
589
|
+
*/
|
|
590
|
+
maxDuration?: string;
|
|
591
|
+
/**
|
|
592
|
+
* Tags of the session.
|
|
593
|
+
*/
|
|
594
|
+
tags?: string[];
|
|
595
|
+
/**
|
|
596
|
+
* Deduplication ID of the session.
|
|
597
|
+
*/
|
|
598
|
+
deduplicationId?: string;
|
|
599
|
+
/**
|
|
600
|
+
* A booking demand to schedule the session, only applicable if the platform is bookable.
|
|
601
|
+
*/
|
|
602
|
+
bookingDemand?: CreateSessionRequestBookingDemand;
|
|
603
|
+
/**
|
|
604
|
+
* Default computation model ID to be executed by job assigned to this session.
|
|
605
|
+
*/
|
|
606
|
+
modelId?: string;
|
|
607
|
+
/**
|
|
608
|
+
* Optional platform configuration parameters applied to this session.
|
|
609
|
+
*/
|
|
610
|
+
parameters?: string;
|
|
611
|
+
};
|
|
612
|
+
export type DeleteJobRequest = {
|
|
613
|
+
/**
|
|
614
|
+
* Unique ID of the job.
|
|
615
|
+
*/
|
|
616
|
+
jobId: string;
|
|
617
|
+
};
|
|
618
|
+
export type DeleteProcessRequest = {
|
|
619
|
+
/**
|
|
620
|
+
* Unique ID of the process.
|
|
621
|
+
*/
|
|
622
|
+
processId: string;
|
|
623
|
+
};
|
|
624
|
+
export type DeleteSessionRequest = {
|
|
625
|
+
/**
|
|
626
|
+
* Unique ID of the session.
|
|
627
|
+
*/
|
|
628
|
+
sessionId: string;
|
|
629
|
+
};
|
|
630
|
+
export type GetApplicationRequest = {
|
|
631
|
+
/**
|
|
632
|
+
* Unique ID of the application.
|
|
633
|
+
*/
|
|
634
|
+
applicationId: string;
|
|
635
|
+
};
|
|
636
|
+
export type GetBookingRequest = {
|
|
637
|
+
/**
|
|
638
|
+
* Unique ID of the booking.
|
|
639
|
+
*/
|
|
640
|
+
bookingId: string;
|
|
641
|
+
};
|
|
642
|
+
export type GetJobCircuitRequest = {
|
|
643
|
+
/**
|
|
644
|
+
* Unique ID of the job.
|
|
645
|
+
*/
|
|
646
|
+
jobId: string;
|
|
647
|
+
};
|
|
648
|
+
export type GetJobRequest = {
|
|
649
|
+
/**
|
|
650
|
+
* Unique ID of the job you want to get.
|
|
651
|
+
*/
|
|
652
|
+
jobId: string;
|
|
653
|
+
};
|
|
654
|
+
export type GetModelRequest = {
|
|
655
|
+
/**
|
|
656
|
+
* Unique ID of the model.
|
|
657
|
+
*/
|
|
658
|
+
modelId: string;
|
|
659
|
+
};
|
|
660
|
+
export type GetPlatformRequest = {
|
|
661
|
+
/**
|
|
662
|
+
* Unique ID of the platform.
|
|
663
|
+
*/
|
|
664
|
+
platformId: string;
|
|
665
|
+
};
|
|
666
|
+
export type GetProcessRequest = {
|
|
667
|
+
/**
|
|
668
|
+
* Unique ID of the process.
|
|
669
|
+
*/
|
|
670
|
+
processId: string;
|
|
671
|
+
};
|
|
672
|
+
export type GetSessionRequest = {
|
|
673
|
+
/**
|
|
674
|
+
* Unique ID of the session.
|
|
675
|
+
*/
|
|
676
|
+
sessionId: string;
|
|
677
|
+
};
|
|
678
|
+
export type ListApplicationsRequest = {
|
|
679
|
+
/**
|
|
680
|
+
* List applications with this name.
|
|
681
|
+
*/
|
|
682
|
+
name?: string;
|
|
683
|
+
/**
|
|
684
|
+
* List applications with this type.
|
|
685
|
+
*/
|
|
686
|
+
applicationType?: ApplicationType;
|
|
687
|
+
/**
|
|
688
|
+
* Page number.
|
|
689
|
+
*/
|
|
690
|
+
page?: number;
|
|
691
|
+
/**
|
|
692
|
+
* Maximum number of applications a to return per page.
|
|
693
|
+
*/
|
|
694
|
+
pageSize?: number;
|
|
695
|
+
/**
|
|
696
|
+
* Sort order of the returned applications.
|
|
697
|
+
*/
|
|
698
|
+
orderBy?: ListApplicationsRequestOrderBy;
|
|
699
|
+
};
|
|
700
|
+
export interface ListApplicationsResponse {
|
|
701
|
+
/**
|
|
702
|
+
* Total number of applications.
|
|
703
|
+
*/
|
|
704
|
+
totalCount: number;
|
|
705
|
+
/**
|
|
706
|
+
* List of applications.
|
|
707
|
+
*/
|
|
708
|
+
applications: Application[];
|
|
709
|
+
}
|
|
710
|
+
export type ListBookingsRequest = {
|
|
711
|
+
/**
|
|
712
|
+
* List bookings belonging to this project ID.
|
|
713
|
+
*/
|
|
714
|
+
projectId?: string;
|
|
715
|
+
/**
|
|
716
|
+
* List bookings attached to this platform ID.
|
|
717
|
+
*/
|
|
718
|
+
platformId?: string;
|
|
719
|
+
/**
|
|
720
|
+
* Page number.
|
|
721
|
+
*/
|
|
722
|
+
page?: number;
|
|
723
|
+
/**
|
|
724
|
+
* Maximum number of results to return per page.
|
|
725
|
+
*/
|
|
726
|
+
pageSize?: number;
|
|
727
|
+
/**
|
|
728
|
+
* Sort order of the returned results.
|
|
729
|
+
*/
|
|
730
|
+
orderBy?: ListBookingsRequestOrderBy;
|
|
731
|
+
};
|
|
732
|
+
export interface ListBookingsResponse {
|
|
733
|
+
/**
|
|
734
|
+
* Total number of bookings.
|
|
735
|
+
*/
|
|
736
|
+
totalCount: number;
|
|
737
|
+
/**
|
|
738
|
+
* List of bookings.
|
|
739
|
+
*/
|
|
740
|
+
bookings: Booking[];
|
|
741
|
+
}
|
|
742
|
+
export type ListJobResultsRequest = {
|
|
743
|
+
/**
|
|
744
|
+
* ID of the job.
|
|
745
|
+
*/
|
|
746
|
+
jobId: string;
|
|
747
|
+
/**
|
|
748
|
+
* Page number.
|
|
749
|
+
*/
|
|
750
|
+
page?: number;
|
|
751
|
+
/**
|
|
752
|
+
* Maximum number of results to return per page.
|
|
753
|
+
*/
|
|
754
|
+
pageSize?: number;
|
|
755
|
+
/**
|
|
756
|
+
* Sort order of the returned results.
|
|
757
|
+
*/
|
|
758
|
+
orderBy?: ListJobResultsRequestOrderBy;
|
|
759
|
+
};
|
|
760
|
+
export interface ListJobResultsResponse {
|
|
761
|
+
/**
|
|
762
|
+
* Total number of results.
|
|
763
|
+
*/
|
|
764
|
+
totalCount: number;
|
|
765
|
+
/**
|
|
766
|
+
* List of results.
|
|
767
|
+
*/
|
|
768
|
+
jobResults: JobResult[];
|
|
769
|
+
}
|
|
770
|
+
export type ListJobsRequest = {
|
|
771
|
+
/**
|
|
772
|
+
* List jobs with this session ID.
|
|
773
|
+
*
|
|
774
|
+
* One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be set.
|
|
775
|
+
*/
|
|
776
|
+
sessionId?: string;
|
|
777
|
+
/**
|
|
778
|
+
* List jobs with this project ID.
|
|
779
|
+
*
|
|
780
|
+
* One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be set.
|
|
781
|
+
*/
|
|
782
|
+
projectId?: string;
|
|
783
|
+
/**
|
|
784
|
+
* List jobs with these tags.
|
|
785
|
+
*/
|
|
786
|
+
tags?: string[];
|
|
787
|
+
/**
|
|
788
|
+
* Page number.
|
|
789
|
+
*/
|
|
790
|
+
page?: number;
|
|
791
|
+
/**
|
|
792
|
+
* Maximum number of jobs to return per page.
|
|
793
|
+
*/
|
|
794
|
+
pageSize?: number;
|
|
795
|
+
/**
|
|
796
|
+
* Sort order of the returned jobs.
|
|
797
|
+
*/
|
|
798
|
+
orderBy?: ListJobsRequestOrderBy;
|
|
799
|
+
};
|
|
800
|
+
export interface ListJobsResponse {
|
|
801
|
+
/**
|
|
802
|
+
* Total number of jobs.
|
|
803
|
+
*/
|
|
804
|
+
totalCount: number;
|
|
805
|
+
/**
|
|
806
|
+
* List of jobs.
|
|
807
|
+
*/
|
|
808
|
+
jobs: Job[];
|
|
809
|
+
}
|
|
810
|
+
export type ListModelsRequest = {
|
|
811
|
+
/**
|
|
812
|
+
* List models belonging to this project ID.
|
|
813
|
+
*/
|
|
814
|
+
projectId?: string;
|
|
815
|
+
/**
|
|
816
|
+
* Page number.
|
|
817
|
+
*/
|
|
818
|
+
page?: number;
|
|
819
|
+
/**
|
|
820
|
+
* Maximum number of results to return per page.
|
|
821
|
+
*/
|
|
822
|
+
pageSize?: number;
|
|
823
|
+
/**
|
|
824
|
+
* Sort order of the returned results.
|
|
825
|
+
*/
|
|
826
|
+
orderBy?: ListModelsRequestOrderBy;
|
|
827
|
+
};
|
|
828
|
+
export interface ListModelsResponse {
|
|
829
|
+
/**
|
|
830
|
+
* Total number of models.
|
|
831
|
+
*/
|
|
832
|
+
totalCount: number;
|
|
833
|
+
/**
|
|
834
|
+
* List of models.
|
|
835
|
+
*/
|
|
836
|
+
models: Model[];
|
|
837
|
+
}
|
|
838
|
+
export type ListPlatformsRequest = {
|
|
839
|
+
/**
|
|
840
|
+
* List platforms with this provider name.
|
|
841
|
+
*/
|
|
842
|
+
providerName?: string;
|
|
843
|
+
/**
|
|
844
|
+
* List platforms with this backend name.
|
|
845
|
+
*/
|
|
846
|
+
backendName?: string;
|
|
847
|
+
/**
|
|
848
|
+
* List platforms with this name.
|
|
849
|
+
*/
|
|
850
|
+
name?: string;
|
|
851
|
+
/**
|
|
852
|
+
* List platforms with this type.
|
|
853
|
+
*/
|
|
854
|
+
platformType?: PlatformType;
|
|
855
|
+
/**
|
|
856
|
+
* List platforms with this technology.
|
|
857
|
+
*/
|
|
858
|
+
platformTechnology?: PlatformTechnology;
|
|
859
|
+
/**
|
|
860
|
+
* Page number.
|
|
861
|
+
*/
|
|
862
|
+
page?: number;
|
|
863
|
+
/**
|
|
864
|
+
* Maximum number of platforms to return per page.
|
|
865
|
+
*/
|
|
866
|
+
pageSize?: number;
|
|
867
|
+
/**
|
|
868
|
+
* Sort order of the returned platforms.
|
|
869
|
+
*/
|
|
870
|
+
orderBy?: ListPlatformsRequestOrderBy;
|
|
871
|
+
};
|
|
872
|
+
export interface ListPlatformsResponse {
|
|
873
|
+
/**
|
|
874
|
+
* Total number of platforms.
|
|
875
|
+
*/
|
|
876
|
+
totalCount: number;
|
|
877
|
+
/**
|
|
878
|
+
* List of platforms.
|
|
879
|
+
*/
|
|
880
|
+
platforms: Platform[];
|
|
881
|
+
}
|
|
882
|
+
export type ListProcessResultsRequest = {
|
|
883
|
+
/**
|
|
884
|
+
* ID of the process.
|
|
885
|
+
*/
|
|
886
|
+
processId: string;
|
|
887
|
+
/**
|
|
888
|
+
* Page number.
|
|
889
|
+
*/
|
|
890
|
+
page?: number;
|
|
891
|
+
/**
|
|
892
|
+
* Maximum number of results to return per page.
|
|
893
|
+
*/
|
|
894
|
+
pageSize?: number;
|
|
895
|
+
/**
|
|
896
|
+
* Sort order of the returned results.
|
|
897
|
+
*/
|
|
898
|
+
orderBy?: ListProcessResultsRequestOrderBy;
|
|
899
|
+
};
|
|
900
|
+
export interface ListProcessResultsResponse {
|
|
901
|
+
/**
|
|
902
|
+
* Total number of results.
|
|
903
|
+
*/
|
|
904
|
+
totalCount: number;
|
|
905
|
+
/**
|
|
906
|
+
* List of results.
|
|
907
|
+
*/
|
|
908
|
+
processResults: ProcessResult[];
|
|
909
|
+
}
|
|
910
|
+
export type ListProcessesRequest = {
|
|
911
|
+
/**
|
|
912
|
+
* List processes that have been created for this application.
|
|
913
|
+
*/
|
|
914
|
+
applicationId?: string;
|
|
915
|
+
/**
|
|
916
|
+
* List processes with these tags.
|
|
917
|
+
*/
|
|
918
|
+
tags?: string[];
|
|
919
|
+
/**
|
|
920
|
+
* Page number.
|
|
921
|
+
*/
|
|
922
|
+
page?: number;
|
|
923
|
+
/**
|
|
924
|
+
* Maximum number of processes to return per page.
|
|
925
|
+
*/
|
|
926
|
+
pageSize?: number;
|
|
927
|
+
/**
|
|
928
|
+
* Sort order of the returned processes.
|
|
929
|
+
*/
|
|
930
|
+
orderBy?: ListProcessesRequestOrderBy;
|
|
931
|
+
/**
|
|
932
|
+
* List processes belonging to this project ID.
|
|
933
|
+
*/
|
|
934
|
+
projectId?: string;
|
|
935
|
+
};
|
|
936
|
+
export interface ListProcessesResponse {
|
|
937
|
+
/**
|
|
938
|
+
* Total number of processes.
|
|
939
|
+
*/
|
|
940
|
+
totalCount: number;
|
|
941
|
+
/**
|
|
942
|
+
* List of processes.
|
|
943
|
+
*/
|
|
944
|
+
processes: Process[];
|
|
945
|
+
}
|
|
946
|
+
export type ListSessionACLsRequest = {
|
|
947
|
+
sessionId: string;
|
|
948
|
+
page?: number;
|
|
949
|
+
pageSize?: number;
|
|
950
|
+
orderBy?: ListSessionACLsRequestOrderBy;
|
|
951
|
+
};
|
|
952
|
+
export interface ListSessionACLsResponse {
|
|
953
|
+
totalCount: number;
|
|
954
|
+
acls: SessionAccess[];
|
|
955
|
+
}
|
|
956
|
+
export type ListSessionsRequest = {
|
|
957
|
+
/**
|
|
958
|
+
* List sessions that have been created for this platform.
|
|
959
|
+
*/
|
|
960
|
+
platformId?: string;
|
|
961
|
+
/**
|
|
962
|
+
* List sessions with these tags.
|
|
963
|
+
*/
|
|
964
|
+
tags?: string[];
|
|
965
|
+
/**
|
|
966
|
+
* Page number.
|
|
967
|
+
*/
|
|
968
|
+
page?: number;
|
|
969
|
+
/**
|
|
970
|
+
* Maximum number of sessions to return per page.
|
|
971
|
+
*/
|
|
972
|
+
pageSize?: number;
|
|
973
|
+
/**
|
|
974
|
+
* Sort order of the returned sessions.
|
|
975
|
+
*/
|
|
976
|
+
orderBy?: ListSessionsRequestOrderBy;
|
|
977
|
+
/**
|
|
978
|
+
* List sessions belonging to this project ID.
|
|
979
|
+
*/
|
|
980
|
+
projectId?: string;
|
|
981
|
+
};
|
|
982
|
+
export interface ListSessionsResponse {
|
|
983
|
+
/**
|
|
984
|
+
* Total number of sessions.
|
|
985
|
+
*/
|
|
986
|
+
totalCount: number;
|
|
987
|
+
/**
|
|
988
|
+
* List of sessions.
|
|
989
|
+
*/
|
|
990
|
+
sessions: Session[];
|
|
991
|
+
}
|
|
992
|
+
export type TerminateSessionRequest = {
|
|
993
|
+
/**
|
|
994
|
+
* Unique ID of the session.
|
|
995
|
+
*/
|
|
996
|
+
sessionId: string;
|
|
997
|
+
};
|
|
998
|
+
export type UpdateBookingRequest = {
|
|
999
|
+
/**
|
|
1000
|
+
* Unique ID of the booking.
|
|
1001
|
+
*/
|
|
1002
|
+
bookingId: string;
|
|
1003
|
+
/**
|
|
1004
|
+
* Description of the booking slot.
|
|
1005
|
+
*/
|
|
1006
|
+
description?: string;
|
|
1007
|
+
};
|
|
1008
|
+
export type UpdateJobRequest = {
|
|
1009
|
+
/**
|
|
1010
|
+
* Unique ID of the job.
|
|
1011
|
+
*/
|
|
1012
|
+
jobId: string;
|
|
1013
|
+
/**
|
|
1014
|
+
* Name of the job.
|
|
1015
|
+
*/
|
|
1016
|
+
name?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* Tags of the job.
|
|
1019
|
+
*/
|
|
1020
|
+
tags?: string[];
|
|
1021
|
+
};
|
|
1022
|
+
export type UpdateProcessRequest = {
|
|
1023
|
+
/**
|
|
1024
|
+
* Unique ID of the process.
|
|
1025
|
+
*/
|
|
1026
|
+
processId: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* Name of the process.
|
|
1029
|
+
*/
|
|
1030
|
+
name?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* Tags of the process.
|
|
1033
|
+
*/
|
|
1034
|
+
tags?: string[];
|
|
1035
|
+
};
|
|
1036
|
+
export type UpdateSessionRequest = {
|
|
1037
|
+
/**
|
|
1038
|
+
* Unique ID of the session.
|
|
1039
|
+
*/
|
|
1040
|
+
sessionId: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Name of the session.
|
|
1043
|
+
*/
|
|
1044
|
+
name?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* Maximum idle duration before the session ends.
|
|
1047
|
+
*/
|
|
1048
|
+
maxIdleDuration?: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* Maximum time before the session ends.
|
|
1051
|
+
*/
|
|
1052
|
+
maxDuration?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Tags of the session.
|
|
1055
|
+
*/
|
|
1056
|
+
tags?: string[];
|
|
1057
|
+
};
|