@octelium/apis 1.0.7 → 1.0.8
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/main/authv1/authv1.d.ts +4 -0
- package/main/authv1/authv1.d.ts.map +1 -1
- package/main/authv1/authv1.js +9 -1
- package/main/authv1/authv1.js.map +1 -1
- package/main/authv1/authv1.ts +13 -1
- package/main/cordiumv1/cordiumv1.client.d.ts +336 -34
- package/main/cordiumv1/cordiumv1.client.d.ts.map +1 -1
- package/main/cordiumv1/cordiumv1.client.js +168 -17
- package/main/cordiumv1/cordiumv1.client.js.map +1 -1
- package/main/cordiumv1/cordiumv1.client.ts +336 -34
- package/main/cordiumv1/cordiumv1.d.ts +1849 -6
- package/main/cordiumv1/cordiumv1.d.ts.map +1 -1
- package/main/cordiumv1/cordiumv1.js +206 -0
- package/main/cordiumv1/cordiumv1.js.map +1 -1
- package/main/cordiumv1/cordiumv1.ts +1849 -6
- package/main/corev1/corev1.d.ts +8300 -4335
- package/main/corev1/corev1.d.ts.map +1 -1
- package/main/corev1/corev1.js +12864 -8817
- package/main/corev1/corev1.js.map +1 -1
- package/main/corev1/corev1.ts +16709 -10252
- package/main/userv1/userv1.d.ts +5 -1
- package/main/userv1/userv1.d.ts.map +1 -1
- package/main/userv1/userv1.js +4 -0
- package/main/userv1/userv1.js.map +1 -1
- package/main/userv1/userv1.ts +5 -1
- package/package.json +1 -1
|
@@ -90,113 +90,168 @@ import type { Secret } from "./cordiumv1.js";
|
|
|
90
90
|
import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
|
|
91
91
|
import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
|
|
92
92
|
/**
|
|
93
|
+
* MainService is the primary Cordium API that is used by the Users (i.e. via
|
|
94
|
+
* the `cordium` CLI, the web portal and the SDKs) to manage their Spaces,
|
|
95
|
+
* Templates, Workspaces, Memberships, Secrets, UserSecrets, GitProviders and
|
|
96
|
+
* their UserConfig. Every method is executed on behalf of the authenticated
|
|
97
|
+
* Octelium User and is authorized against that User's ownership of the
|
|
98
|
+
* resource and/or their Membership role in the resource's Space.
|
|
99
|
+
*
|
|
93
100
|
* @generated from protobuf service octelium.api.main.cordium.v1.MainService
|
|
94
101
|
*/
|
|
95
102
|
export interface IMainServiceClient {
|
|
96
103
|
/**
|
|
97
|
-
* CreateSecret creates a Secret
|
|
104
|
+
* CreateSecret creates a Secret inside a Space. The caller must be at least
|
|
105
|
+
* an ADMIN Member of the Space. The Secret data is never returned back by
|
|
106
|
+
* the Cluster once the Secret is created.
|
|
98
107
|
*
|
|
99
108
|
* @generated from protobuf rpc: CreateSecret
|
|
100
109
|
*/
|
|
101
110
|
createSecret(input: Secret, options?: RpcOptions): UnaryCall<Secret, Secret>;
|
|
102
111
|
/**
|
|
103
|
-
* ListSecret lists Secrets
|
|
112
|
+
* ListSecret lists the Secrets of a Space. The Secrets' data is not
|
|
113
|
+
* included in the response.
|
|
104
114
|
*
|
|
105
115
|
* @generated from protobuf rpc: ListSecret
|
|
106
116
|
*/
|
|
107
117
|
listSecret(input: ListSecretOptions, options?: RpcOptions): UnaryCall<ListSecretOptions, SecretList>;
|
|
108
118
|
/**
|
|
109
|
-
*
|
|
119
|
+
* DeleteSecret deletes a Secret. The caller must be at least an ADMIN Member
|
|
120
|
+
* of the Secret's Space.
|
|
110
121
|
*
|
|
111
122
|
* @generated from protobuf rpc: DeleteSecret
|
|
112
123
|
*/
|
|
113
124
|
deleteSecret(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
|
|
114
125
|
/**
|
|
115
|
-
*
|
|
126
|
+
* GetSecret retrieves a specific Secret. The Secret data is not included in
|
|
127
|
+
* the response.
|
|
116
128
|
*
|
|
117
129
|
* @generated from protobuf rpc: GetSecret
|
|
118
130
|
*/
|
|
119
131
|
getSecret(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Secret>;
|
|
120
132
|
/**
|
|
121
|
-
* CreateTemplate creates a Template
|
|
133
|
+
* CreateTemplate creates a Template inside a Space. The caller must be at
|
|
134
|
+
* least an ADMIN Member of the Space.
|
|
122
135
|
*
|
|
123
136
|
* @generated from protobuf rpc: CreateTemplate
|
|
124
137
|
*/
|
|
125
138
|
createTemplate(input: Template, options?: RpcOptions): UnaryCall<Template, Template>;
|
|
126
139
|
/**
|
|
127
|
-
* UpdateTemplate updates a Template
|
|
140
|
+
* UpdateTemplate updates a Template. The caller must be at least an ADMIN
|
|
141
|
+
* Member of the Template's Space.
|
|
128
142
|
*
|
|
129
143
|
* @generated from protobuf rpc: UpdateTemplate
|
|
130
144
|
*/
|
|
131
145
|
updateTemplate(input: Template, options?: RpcOptions): UnaryCall<Template, Template>;
|
|
132
146
|
/**
|
|
133
|
-
* DeleteTemplate deletes a Template
|
|
147
|
+
* DeleteTemplate deletes a Template. The default Template of a Space cannot
|
|
148
|
+
* be deleted.
|
|
134
149
|
*
|
|
135
150
|
* @generated from protobuf rpc: DeleteTemplate
|
|
136
151
|
*/
|
|
137
152
|
deleteTemplate(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
|
|
138
153
|
/**
|
|
154
|
+
* BuildTemplate starts a pre-build for a Template. A pre-build runs a
|
|
155
|
+
* hidden build Workspace whose storage is snapshotted once it successfully
|
|
156
|
+
* completes so that the subsequent Workspaces of the Template can be
|
|
157
|
+
* restored from that snapshot instead of being initialized from scratch. A
|
|
158
|
+
* Template can only have one running pre-build at a time. Starting a new
|
|
159
|
+
* pre-build cancels the currently running one, if any.
|
|
160
|
+
*
|
|
139
161
|
* @generated from protobuf rpc: BuildTemplate
|
|
140
162
|
*/
|
|
141
163
|
buildTemplate(input: BuildTemplateRequest, options?: RpcOptions): UnaryCall<BuildTemplateRequest, Template>;
|
|
142
164
|
/**
|
|
165
|
+
* CancelBuildTemplate cancels the currently running pre-build of a Template,
|
|
166
|
+
* if any, and returns the updated Template.
|
|
167
|
+
*
|
|
143
168
|
* @generated from protobuf rpc: CancelBuildTemplate
|
|
144
169
|
*/
|
|
145
170
|
cancelBuildTemplate(input: CancelBuildTemplateRequest, options?: RpcOptions): UnaryCall<CancelBuildTemplateRequest, Template>;
|
|
146
171
|
/**
|
|
147
|
-
*
|
|
172
|
+
* CreateSpace creates a Space owned by the User. Whether a User is allowed
|
|
173
|
+
* to own a Space is controlled by the Space ownership rules of the
|
|
174
|
+
* ClusterConfig. A default Membership and a default Template are
|
|
175
|
+
* automatically created along with the Space.
|
|
148
176
|
*
|
|
149
177
|
* @generated from protobuf rpc: CreateSpace
|
|
150
178
|
*/
|
|
151
179
|
createSpace(input: Space, options?: RpcOptions): UnaryCall<Space, Space>;
|
|
152
180
|
/**
|
|
153
|
-
*
|
|
181
|
+
* UpdateSpace updates a Space. The caller must be the Space creator or an
|
|
182
|
+
* OWNER Member of the Space.
|
|
154
183
|
*
|
|
155
184
|
* @generated from protobuf rpc: UpdateSpace
|
|
156
185
|
*/
|
|
157
186
|
updateSpace(input: Space, options?: RpcOptions): UnaryCall<Space, Space>;
|
|
158
187
|
/**
|
|
159
|
-
*
|
|
188
|
+
* DeleteSpace deletes a Space as well as all of its Memberships, Templates,
|
|
189
|
+
* Secrets and GitProviders.
|
|
160
190
|
*
|
|
161
191
|
* @generated from protobuf rpc: DeleteSpace
|
|
162
192
|
*/
|
|
163
193
|
deleteSpace(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
|
|
164
194
|
/**
|
|
195
|
+
* CreateMembership adds a User as a Member to a Space. The caller must be at
|
|
196
|
+
* least an ADMIN Member of the Space. Members can currently only be added to
|
|
197
|
+
* ORGANIZATION Spaces.
|
|
198
|
+
*
|
|
165
199
|
* @generated from protobuf rpc: CreateMembership
|
|
166
200
|
*/
|
|
167
201
|
createMembership(input: CreateMembershipRequest, options?: RpcOptions): UnaryCall<CreateMembershipRequest, Membership>;
|
|
168
202
|
/**
|
|
203
|
+
* DeleteMembership removes a Member from a Space. The caller must be at
|
|
204
|
+
* least an ADMIN Member of the Space. Space creators cannot be removed.
|
|
205
|
+
*
|
|
169
206
|
* @generated from protobuf rpc: DeleteMembership
|
|
170
207
|
*/
|
|
171
208
|
deleteMembership(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
|
|
172
209
|
/**
|
|
210
|
+
* GetSpaceMembership retrieves the Membership of the calling User in a
|
|
211
|
+
* specific Space.
|
|
212
|
+
*
|
|
173
213
|
* @generated from protobuf rpc: GetSpaceMembership
|
|
174
214
|
*/
|
|
175
215
|
getSpaceMembership(input: GetSpaceMembershipRequest, options?: RpcOptions): UnaryCall<GetSpaceMembershipRequest, Membership>;
|
|
176
216
|
/**
|
|
217
|
+
* UpdateMembership updates a Membership (i.e. its Role). The caller must be
|
|
218
|
+
* at least an ADMIN Member of the Space. Setting a Role to OWNER
|
|
219
|
+
* additionally requires the caller to be an OWNER.
|
|
220
|
+
*
|
|
177
221
|
* @generated from protobuf rpc: UpdateMembership
|
|
178
222
|
*/
|
|
179
223
|
updateMembership(input: Membership, options?: RpcOptions): UnaryCall<Membership, Membership>;
|
|
180
224
|
/**
|
|
225
|
+
* CreateGitProvider creates a GitProvider inside a Space. The caller must be
|
|
226
|
+
* at least an ADMIN Member of the Space.
|
|
227
|
+
*
|
|
181
228
|
* @generated from protobuf rpc: CreateGitProvider
|
|
182
229
|
*/
|
|
183
230
|
createGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider>;
|
|
184
231
|
/**
|
|
232
|
+
* UpdateGitProvider updates a GitProvider.
|
|
233
|
+
*
|
|
185
234
|
* @generated from protobuf rpc: UpdateGitProvider
|
|
186
235
|
*/
|
|
187
236
|
updateGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider>;
|
|
188
237
|
/**
|
|
238
|
+
* DeleteGitProvider deletes a GitProvider.
|
|
239
|
+
*
|
|
189
240
|
* @generated from protobuf rpc: DeleteGitProvider
|
|
190
241
|
*/
|
|
191
242
|
deleteGitProvider(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
|
|
192
243
|
/**
|
|
193
|
-
* CreateWorkspace creates a Workspace owned by the User.
|
|
244
|
+
* CreateWorkspace creates a Workspace owned by the User. The Workspace is
|
|
245
|
+
* created in the STOPPED state and it is assigned a short randomly generated
|
|
246
|
+
* name by the Cluster. If no Template is set in the request's
|
|
247
|
+
* `status.templateRef`, the User's default Template is used.
|
|
194
248
|
*
|
|
195
249
|
* @generated from protobuf rpc: CreateWorkspace
|
|
196
250
|
*/
|
|
197
251
|
createWorkspace(input: Workspace, options?: RpcOptions): UnaryCall<Workspace, Workspace>;
|
|
198
252
|
/**
|
|
199
|
-
* UpdateWorkspace updates a Workspace owned by the User.
|
|
253
|
+
* UpdateWorkspace updates a Workspace owned by the User. Only the
|
|
254
|
+
* Workspace's displayName and spec can be updated.
|
|
200
255
|
*
|
|
201
256
|
* @generated from protobuf rpc: UpdateWorkspace
|
|
202
257
|
*/
|
|
@@ -214,107 +269,177 @@ export interface IMainServiceClient {
|
|
|
214
269
|
*/
|
|
215
270
|
listWorkspace(input: ListWorkspaceOptions, options?: RpcOptions): UnaryCall<ListWorkspaceOptions, WorkspaceList>;
|
|
216
271
|
/**
|
|
272
|
+
* StartWorkspace starts a stopped Workspace. The Cluster creates a dedicated
|
|
273
|
+
* Octelium Session for the run and moves the Workspace to the INIT_REQUEST
|
|
274
|
+
* state. The actual initialization is asynchronous and can be followed via
|
|
275
|
+
* the WatchWorkspace method.
|
|
276
|
+
*
|
|
217
277
|
* @generated from protobuf rpc: StartWorkspace
|
|
218
278
|
*/
|
|
219
279
|
startWorkspace(input: StartWorkspaceRequest, options?: RpcOptions): UnaryCall<StartWorkspaceRequest, StartWorkspaceResponse>;
|
|
220
280
|
/**
|
|
281
|
+
* StopWorkspace requests a graceful stop of a running Workspace. The
|
|
282
|
+
* Workspace moves to the STOPPING_REQUEST state and the stoppage itself is
|
|
283
|
+
* asynchronous.
|
|
284
|
+
*
|
|
221
285
|
* @generated from protobuf rpc: StopWorkspace
|
|
222
286
|
*/
|
|
223
287
|
stopWorkspace(input: StopWorkspaceRequest, options?: RpcOptions): UnaryCall<StopWorkspaceRequest, StopWorkspaceResponse>;
|
|
224
288
|
/**
|
|
289
|
+
* ShareWorkspacePort shares a named Application of a Workspace with other
|
|
290
|
+
* Users so that they can access it via the Workspace's public hostname.
|
|
291
|
+
*
|
|
225
292
|
* @generated from protobuf rpc: ShareWorkspacePort
|
|
226
293
|
*/
|
|
227
294
|
shareWorkspacePort(input: ShareWorkspacePortRequest, options?: RpcOptions): UnaryCall<ShareWorkspacePortRequest, ShareWorkspacePortResponse>;
|
|
228
295
|
/**
|
|
296
|
+
* UnshareWorkspacePort stops sharing a previously shared named Application
|
|
297
|
+
* of a Workspace.
|
|
298
|
+
*
|
|
229
299
|
* @generated from protobuf rpc: UnshareWorkspacePort
|
|
230
300
|
*/
|
|
231
301
|
unshareWorkspacePort(input: UnshareWorkspacePortRequest, options?: RpcOptions): UnaryCall<UnshareWorkspacePortRequest, UnshareWorkspacePortResponse>;
|
|
232
302
|
/**
|
|
303
|
+
* ListSpace lists the Spaces that are either created by the User or where
|
|
304
|
+
* the User is a Member depending on the requested mode.
|
|
305
|
+
*
|
|
233
306
|
* @generated from protobuf rpc: ListSpace
|
|
234
307
|
*/
|
|
235
308
|
listSpace(input: ListSpaceOptions, options?: RpcOptions): UnaryCall<ListSpaceOptions, SpaceList>;
|
|
236
309
|
/**
|
|
310
|
+
* ListTemplate lists the Templates of a Space that the User is a Member of.
|
|
311
|
+
*
|
|
237
312
|
* @generated from protobuf rpc: ListTemplate
|
|
238
313
|
*/
|
|
239
314
|
listTemplate(input: ListTemplateOptions, options?: RpcOptions): UnaryCall<ListTemplateOptions, TemplateList>;
|
|
240
315
|
/**
|
|
316
|
+
* ListMembership lists the Memberships of a Space that the User is a Member
|
|
317
|
+
* of.
|
|
318
|
+
*
|
|
241
319
|
* @generated from protobuf rpc: ListMembership
|
|
242
320
|
*/
|
|
243
321
|
listMembership(input: ListMembershipOptions, options?: RpcOptions): UnaryCall<ListMembershipOptions, MembershipList>;
|
|
244
322
|
/**
|
|
323
|
+
* ListGitProvider lists the GitProviders of a Space that the User is a
|
|
324
|
+
* Member of.
|
|
325
|
+
*
|
|
245
326
|
* @generated from protobuf rpc: ListGitProvider
|
|
246
327
|
*/
|
|
247
328
|
listGitProvider(input: ListGitProviderOptions, options?: RpcOptions): UnaryCall<ListGitProviderOptions, GitProviderList>;
|
|
248
329
|
/**
|
|
330
|
+
* GetSpace retrieves a specific Space. The caller must be a Member of the
|
|
331
|
+
* Space.
|
|
332
|
+
*
|
|
249
333
|
* @generated from protobuf rpc: GetSpace
|
|
250
334
|
*/
|
|
251
335
|
getSpace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Space>;
|
|
252
336
|
/**
|
|
337
|
+
* GetWorkspace retrieves a specific Workspace owned by the User.
|
|
338
|
+
*
|
|
253
339
|
* @generated from protobuf rpc: GetWorkspace
|
|
254
340
|
*/
|
|
255
341
|
getWorkspace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Workspace>;
|
|
256
342
|
/**
|
|
343
|
+
* GetTemplate retrieves a specific Template. The caller must be a Member of
|
|
344
|
+
* the Template's Space.
|
|
345
|
+
*
|
|
257
346
|
* @generated from protobuf rpc: GetTemplate
|
|
258
347
|
*/
|
|
259
348
|
getTemplate(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Template>;
|
|
260
349
|
/**
|
|
350
|
+
* GetGitProvider retrieves a specific GitProvider. The caller must be a
|
|
351
|
+
* Member of the GitProvider's Space.
|
|
352
|
+
*
|
|
261
353
|
* @generated from protobuf rpc: GetGitProvider
|
|
262
354
|
*/
|
|
263
355
|
getGitProvider(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, GitProvider>;
|
|
264
356
|
/**
|
|
357
|
+
* GetMembership retrieves a specific Membership. The caller must be a Member
|
|
358
|
+
* of the Membership's Space.
|
|
359
|
+
*
|
|
265
360
|
* @generated from protobuf rpc: GetMembership
|
|
266
361
|
*/
|
|
267
362
|
getMembership(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Membership>;
|
|
268
363
|
/**
|
|
364
|
+
* LeaveSpace removes the calling User's own Membership from a Space. Space
|
|
365
|
+
* creators cannot leave their own Spaces, they can only delete them.
|
|
366
|
+
*
|
|
269
367
|
* @generated from protobuf rpc: LeaveSpace
|
|
270
368
|
*/
|
|
271
369
|
leaveSpace(input: LeaveSpaceRequest, options?: RpcOptions): UnaryCall<LeaveSpaceRequest, LeaveSpaceResponse>;
|
|
272
370
|
/**
|
|
273
|
-
*
|
|
371
|
+
* CreateUserSecret creates a UserSecret owned by the User. UserSecrets of
|
|
372
|
+
* the SSH_KEY type have their key pair generated by the Cluster. The
|
|
373
|
+
* UserSecret data is never returned back by the Cluster.
|
|
274
374
|
*
|
|
275
375
|
* @generated from protobuf rpc: CreateUserSecret
|
|
276
376
|
*/
|
|
277
377
|
createUserSecret(input: UserSecret, options?: RpcOptions): UnaryCall<UserSecret, UserSecret>;
|
|
278
378
|
/**
|
|
279
|
-
*
|
|
379
|
+
* UpdateUserSecret updates a UserSecret owned by the User.
|
|
280
380
|
*
|
|
281
381
|
* @generated from protobuf rpc: UpdateUserSecret
|
|
282
382
|
*/
|
|
283
383
|
updateUserSecret(input: UserSecret, options?: RpcOptions): UnaryCall<UserSecret, UserSecret>;
|
|
284
384
|
/**
|
|
285
|
-
*
|
|
385
|
+
* DeleteUserSecret deletes a UserSecret owned by the User.
|
|
286
386
|
*
|
|
287
387
|
* @generated from protobuf rpc: DeleteUserSecret
|
|
288
388
|
*/
|
|
289
389
|
deleteUserSecret(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
|
|
290
390
|
/**
|
|
291
|
-
*
|
|
391
|
+
* ListUserSecret lists the UserSecrets owned by the User. The UserSecrets'
|
|
392
|
+
* data is not included in the response.
|
|
292
393
|
*
|
|
293
394
|
* @generated from protobuf rpc: ListUserSecret
|
|
294
395
|
*/
|
|
295
396
|
listUserSecret(input: ListUserSecretOptions, options?: RpcOptions): UnaryCall<ListUserSecretOptions, UserSecretList>;
|
|
296
397
|
/**
|
|
398
|
+
* GetUserSecret retrieves a specific UserSecret owned by the User. The
|
|
399
|
+
* UserSecret data is not included in the response.
|
|
400
|
+
*
|
|
297
401
|
* @generated from protobuf rpc: GetUserSecret
|
|
298
402
|
*/
|
|
299
403
|
getUserSecret(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, UserSecret>;
|
|
300
404
|
/**
|
|
405
|
+
* GetUserConfig retrieves the calling User's UserConfig. The UserConfig is
|
|
406
|
+
* automatically created by the Cluster upon the first call.
|
|
407
|
+
*
|
|
301
408
|
* @generated from protobuf rpc: GetUserConfig
|
|
302
409
|
*/
|
|
303
410
|
getUserConfig(input: GetUserConfigRequest, options?: RpcOptions): UnaryCall<GetUserConfigRequest, UserConfig>;
|
|
304
411
|
/**
|
|
412
|
+
* UpdateUserConfig updates the calling User's UserConfig.
|
|
413
|
+
*
|
|
305
414
|
* @generated from protobuf rpc: UpdateUserConfig
|
|
306
415
|
*/
|
|
307
416
|
updateUserConfig(input: UserConfig, options?: RpcOptions): UnaryCall<UserConfig, UserConfig>;
|
|
308
417
|
/**
|
|
418
|
+
* ListRegion lists the Regions of the Cluster that are enabled to host
|
|
419
|
+
* Workspaces.
|
|
420
|
+
*
|
|
309
421
|
* @generated from protobuf rpc: ListRegion
|
|
310
422
|
*/
|
|
311
423
|
listRegion(input: ListRegionOptions, options?: RpcOptions): UnaryCall<ListRegionOptions, RegionList>;
|
|
312
424
|
/**
|
|
425
|
+
* WatchWorkspace opens a server-side stream that publishes the create,
|
|
426
|
+
* update and delete events of the User's Workspaces. If a workspaceRef is
|
|
427
|
+
* set in the request, only the events of that specific Workspace are
|
|
428
|
+
* published. It is the recommended way to follow a Workspace's state
|
|
429
|
+
* throughout its lifecycle.
|
|
430
|
+
*
|
|
313
431
|
* @generated from protobuf rpc: WatchWorkspace
|
|
314
432
|
*/
|
|
315
433
|
watchWorkspace(input: WatchWorkspaceRequest, options?: RpcOptions): ServerStreamingCall<WatchWorkspaceRequest, WatchWorkspaceResponse>;
|
|
316
434
|
}
|
|
317
435
|
/**
|
|
436
|
+
* MainService is the primary Cordium API that is used by the Users (i.e. via
|
|
437
|
+
* the `cordium` CLI, the web portal and the SDKs) to manage their Spaces,
|
|
438
|
+
* Templates, Workspaces, Memberships, Secrets, UserSecrets, GitProviders and
|
|
439
|
+
* their UserConfig. Every method is executed on behalf of the authenticated
|
|
440
|
+
* Octelium User and is authorized against that User's ownership of the
|
|
441
|
+
* resource and/or their Membership role in the resource's Space.
|
|
442
|
+
*
|
|
318
443
|
* @generated from protobuf service octelium.api.main.cordium.v1.MainService
|
|
319
444
|
*/
|
|
320
445
|
export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
@@ -324,7 +449,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
324
449
|
constructor(private readonly _transport: RpcTransport) {
|
|
325
450
|
}
|
|
326
451
|
/**
|
|
327
|
-
* CreateSecret creates a Secret
|
|
452
|
+
* CreateSecret creates a Secret inside a Space. The caller must be at least
|
|
453
|
+
* an ADMIN Member of the Space. The Secret data is never returned back by
|
|
454
|
+
* the Cluster once the Secret is created.
|
|
328
455
|
*
|
|
329
456
|
* @generated from protobuf rpc: CreateSecret
|
|
330
457
|
*/
|
|
@@ -333,7 +460,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
333
460
|
return stackIntercept<Secret, Secret>("unary", this._transport, method, opt, input);
|
|
334
461
|
}
|
|
335
462
|
/**
|
|
336
|
-
* ListSecret lists Secrets
|
|
463
|
+
* ListSecret lists the Secrets of a Space. The Secrets' data is not
|
|
464
|
+
* included in the response.
|
|
337
465
|
*
|
|
338
466
|
* @generated from protobuf rpc: ListSecret
|
|
339
467
|
*/
|
|
@@ -342,7 +470,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
342
470
|
return stackIntercept<ListSecretOptions, SecretList>("unary", this._transport, method, opt, input);
|
|
343
471
|
}
|
|
344
472
|
/**
|
|
345
|
-
*
|
|
473
|
+
* DeleteSecret deletes a Secret. The caller must be at least an ADMIN Member
|
|
474
|
+
* of the Secret's Space.
|
|
346
475
|
*
|
|
347
476
|
* @generated from protobuf rpc: DeleteSecret
|
|
348
477
|
*/
|
|
@@ -351,7 +480,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
351
480
|
return stackIntercept<DeleteOptions, OperationResult>("unary", this._transport, method, opt, input);
|
|
352
481
|
}
|
|
353
482
|
/**
|
|
354
|
-
*
|
|
483
|
+
* GetSecret retrieves a specific Secret. The Secret data is not included in
|
|
484
|
+
* the response.
|
|
355
485
|
*
|
|
356
486
|
* @generated from protobuf rpc: GetSecret
|
|
357
487
|
*/
|
|
@@ -360,7 +490,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
360
490
|
return stackIntercept<GetOptions, Secret>("unary", this._transport, method, opt, input);
|
|
361
491
|
}
|
|
362
492
|
/**
|
|
363
|
-
* CreateTemplate creates a Template
|
|
493
|
+
* CreateTemplate creates a Template inside a Space. The caller must be at
|
|
494
|
+
* least an ADMIN Member of the Space.
|
|
364
495
|
*
|
|
365
496
|
* @generated from protobuf rpc: CreateTemplate
|
|
366
497
|
*/
|
|
@@ -369,7 +500,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
369
500
|
return stackIntercept<Template, Template>("unary", this._transport, method, opt, input);
|
|
370
501
|
}
|
|
371
502
|
/**
|
|
372
|
-
* UpdateTemplate updates a Template
|
|
503
|
+
* UpdateTemplate updates a Template. The caller must be at least an ADMIN
|
|
504
|
+
* Member of the Template's Space.
|
|
373
505
|
*
|
|
374
506
|
* @generated from protobuf rpc: UpdateTemplate
|
|
375
507
|
*/
|
|
@@ -378,7 +510,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
378
510
|
return stackIntercept<Template, Template>("unary", this._transport, method, opt, input);
|
|
379
511
|
}
|
|
380
512
|
/**
|
|
381
|
-
* DeleteTemplate deletes a Template
|
|
513
|
+
* DeleteTemplate deletes a Template. The default Template of a Space cannot
|
|
514
|
+
* be deleted.
|
|
382
515
|
*
|
|
383
516
|
* @generated from protobuf rpc: DeleteTemplate
|
|
384
517
|
*/
|
|
@@ -387,6 +520,13 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
387
520
|
return stackIntercept<DeleteOptions, OperationResult>("unary", this._transport, method, opt, input);
|
|
388
521
|
}
|
|
389
522
|
/**
|
|
523
|
+
* BuildTemplate starts a pre-build for a Template. A pre-build runs a
|
|
524
|
+
* hidden build Workspace whose storage is snapshotted once it successfully
|
|
525
|
+
* completes so that the subsequent Workspaces of the Template can be
|
|
526
|
+
* restored from that snapshot instead of being initialized from scratch. A
|
|
527
|
+
* Template can only have one running pre-build at a time. Starting a new
|
|
528
|
+
* pre-build cancels the currently running one, if any.
|
|
529
|
+
*
|
|
390
530
|
* @generated from protobuf rpc: BuildTemplate
|
|
391
531
|
*/
|
|
392
532
|
buildTemplate(input: BuildTemplateRequest, options?: RpcOptions): UnaryCall<BuildTemplateRequest, Template> {
|
|
@@ -394,6 +534,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
394
534
|
return stackIntercept<BuildTemplateRequest, Template>("unary", this._transport, method, opt, input);
|
|
395
535
|
}
|
|
396
536
|
/**
|
|
537
|
+
* CancelBuildTemplate cancels the currently running pre-build of a Template,
|
|
538
|
+
* if any, and returns the updated Template.
|
|
539
|
+
*
|
|
397
540
|
* @generated from protobuf rpc: CancelBuildTemplate
|
|
398
541
|
*/
|
|
399
542
|
cancelBuildTemplate(input: CancelBuildTemplateRequest, options?: RpcOptions): UnaryCall<CancelBuildTemplateRequest, Template> {
|
|
@@ -401,7 +544,10 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
401
544
|
return stackIntercept<CancelBuildTemplateRequest, Template>("unary", this._transport, method, opt, input);
|
|
402
545
|
}
|
|
403
546
|
/**
|
|
404
|
-
*
|
|
547
|
+
* CreateSpace creates a Space owned by the User. Whether a User is allowed
|
|
548
|
+
* to own a Space is controlled by the Space ownership rules of the
|
|
549
|
+
* ClusterConfig. A default Membership and a default Template are
|
|
550
|
+
* automatically created along with the Space.
|
|
405
551
|
*
|
|
406
552
|
* @generated from protobuf rpc: CreateSpace
|
|
407
553
|
*/
|
|
@@ -410,7 +556,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
410
556
|
return stackIntercept<Space, Space>("unary", this._transport, method, opt, input);
|
|
411
557
|
}
|
|
412
558
|
/**
|
|
413
|
-
*
|
|
559
|
+
* UpdateSpace updates a Space. The caller must be the Space creator or an
|
|
560
|
+
* OWNER Member of the Space.
|
|
414
561
|
*
|
|
415
562
|
* @generated from protobuf rpc: UpdateSpace
|
|
416
563
|
*/
|
|
@@ -419,7 +566,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
419
566
|
return stackIntercept<Space, Space>("unary", this._transport, method, opt, input);
|
|
420
567
|
}
|
|
421
568
|
/**
|
|
422
|
-
*
|
|
569
|
+
* DeleteSpace deletes a Space as well as all of its Memberships, Templates,
|
|
570
|
+
* Secrets and GitProviders.
|
|
423
571
|
*
|
|
424
572
|
* @generated from protobuf rpc: DeleteSpace
|
|
425
573
|
*/
|
|
@@ -428,6 +576,10 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
428
576
|
return stackIntercept<DeleteOptions, OperationResult>("unary", this._transport, method, opt, input);
|
|
429
577
|
}
|
|
430
578
|
/**
|
|
579
|
+
* CreateMembership adds a User as a Member to a Space. The caller must be at
|
|
580
|
+
* least an ADMIN Member of the Space. Members can currently only be added to
|
|
581
|
+
* ORGANIZATION Spaces.
|
|
582
|
+
*
|
|
431
583
|
* @generated from protobuf rpc: CreateMembership
|
|
432
584
|
*/
|
|
433
585
|
createMembership(input: CreateMembershipRequest, options?: RpcOptions): UnaryCall<CreateMembershipRequest, Membership> {
|
|
@@ -435,6 +587,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
435
587
|
return stackIntercept<CreateMembershipRequest, Membership>("unary", this._transport, method, opt, input);
|
|
436
588
|
}
|
|
437
589
|
/**
|
|
590
|
+
* DeleteMembership removes a Member from a Space. The caller must be at
|
|
591
|
+
* least an ADMIN Member of the Space. Space creators cannot be removed.
|
|
592
|
+
*
|
|
438
593
|
* @generated from protobuf rpc: DeleteMembership
|
|
439
594
|
*/
|
|
440
595
|
deleteMembership(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult> {
|
|
@@ -442,6 +597,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
442
597
|
return stackIntercept<DeleteOptions, OperationResult>("unary", this._transport, method, opt, input);
|
|
443
598
|
}
|
|
444
599
|
/**
|
|
600
|
+
* GetSpaceMembership retrieves the Membership of the calling User in a
|
|
601
|
+
* specific Space.
|
|
602
|
+
*
|
|
445
603
|
* @generated from protobuf rpc: GetSpaceMembership
|
|
446
604
|
*/
|
|
447
605
|
getSpaceMembership(input: GetSpaceMembershipRequest, options?: RpcOptions): UnaryCall<GetSpaceMembershipRequest, Membership> {
|
|
@@ -449,6 +607,10 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
449
607
|
return stackIntercept<GetSpaceMembershipRequest, Membership>("unary", this._transport, method, opt, input);
|
|
450
608
|
}
|
|
451
609
|
/**
|
|
610
|
+
* UpdateMembership updates a Membership (i.e. its Role). The caller must be
|
|
611
|
+
* at least an ADMIN Member of the Space. Setting a Role to OWNER
|
|
612
|
+
* additionally requires the caller to be an OWNER.
|
|
613
|
+
*
|
|
452
614
|
* @generated from protobuf rpc: UpdateMembership
|
|
453
615
|
*/
|
|
454
616
|
updateMembership(input: Membership, options?: RpcOptions): UnaryCall<Membership, Membership> {
|
|
@@ -456,6 +618,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
456
618
|
return stackIntercept<Membership, Membership>("unary", this._transport, method, opt, input);
|
|
457
619
|
}
|
|
458
620
|
/**
|
|
621
|
+
* CreateGitProvider creates a GitProvider inside a Space. The caller must be
|
|
622
|
+
* at least an ADMIN Member of the Space.
|
|
623
|
+
*
|
|
459
624
|
* @generated from protobuf rpc: CreateGitProvider
|
|
460
625
|
*/
|
|
461
626
|
createGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider> {
|
|
@@ -463,6 +628,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
463
628
|
return stackIntercept<GitProvider, GitProvider>("unary", this._transport, method, opt, input);
|
|
464
629
|
}
|
|
465
630
|
/**
|
|
631
|
+
* UpdateGitProvider updates a GitProvider.
|
|
632
|
+
*
|
|
466
633
|
* @generated from protobuf rpc: UpdateGitProvider
|
|
467
634
|
*/
|
|
468
635
|
updateGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider> {
|
|
@@ -470,6 +637,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
470
637
|
return stackIntercept<GitProvider, GitProvider>("unary", this._transport, method, opt, input);
|
|
471
638
|
}
|
|
472
639
|
/**
|
|
640
|
+
* DeleteGitProvider deletes a GitProvider.
|
|
641
|
+
*
|
|
473
642
|
* @generated from protobuf rpc: DeleteGitProvider
|
|
474
643
|
*/
|
|
475
644
|
deleteGitProvider(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult> {
|
|
@@ -477,7 +646,10 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
477
646
|
return stackIntercept<DeleteOptions, OperationResult>("unary", this._transport, method, opt, input);
|
|
478
647
|
}
|
|
479
648
|
/**
|
|
480
|
-
* CreateWorkspace creates a Workspace owned by the User.
|
|
649
|
+
* CreateWorkspace creates a Workspace owned by the User. The Workspace is
|
|
650
|
+
* created in the STOPPED state and it is assigned a short randomly generated
|
|
651
|
+
* name by the Cluster. If no Template is set in the request's
|
|
652
|
+
* `status.templateRef`, the User's default Template is used.
|
|
481
653
|
*
|
|
482
654
|
* @generated from protobuf rpc: CreateWorkspace
|
|
483
655
|
*/
|
|
@@ -486,7 +658,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
486
658
|
return stackIntercept<Workspace, Workspace>("unary", this._transport, method, opt, input);
|
|
487
659
|
}
|
|
488
660
|
/**
|
|
489
|
-
* UpdateWorkspace updates a Workspace owned by the User.
|
|
661
|
+
* UpdateWorkspace updates a Workspace owned by the User. Only the
|
|
662
|
+
* Workspace's displayName and spec can be updated.
|
|
490
663
|
*
|
|
491
664
|
* @generated from protobuf rpc: UpdateWorkspace
|
|
492
665
|
*/
|
|
@@ -513,6 +686,11 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
513
686
|
return stackIntercept<ListWorkspaceOptions, WorkspaceList>("unary", this._transport, method, opt, input);
|
|
514
687
|
}
|
|
515
688
|
/**
|
|
689
|
+
* StartWorkspace starts a stopped Workspace. The Cluster creates a dedicated
|
|
690
|
+
* Octelium Session for the run and moves the Workspace to the INIT_REQUEST
|
|
691
|
+
* state. The actual initialization is asynchronous and can be followed via
|
|
692
|
+
* the WatchWorkspace method.
|
|
693
|
+
*
|
|
516
694
|
* @generated from protobuf rpc: StartWorkspace
|
|
517
695
|
*/
|
|
518
696
|
startWorkspace(input: StartWorkspaceRequest, options?: RpcOptions): UnaryCall<StartWorkspaceRequest, StartWorkspaceResponse> {
|
|
@@ -520,6 +698,10 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
520
698
|
return stackIntercept<StartWorkspaceRequest, StartWorkspaceResponse>("unary", this._transport, method, opt, input);
|
|
521
699
|
}
|
|
522
700
|
/**
|
|
701
|
+
* StopWorkspace requests a graceful stop of a running Workspace. The
|
|
702
|
+
* Workspace moves to the STOPPING_REQUEST state and the stoppage itself is
|
|
703
|
+
* asynchronous.
|
|
704
|
+
*
|
|
523
705
|
* @generated from protobuf rpc: StopWorkspace
|
|
524
706
|
*/
|
|
525
707
|
stopWorkspace(input: StopWorkspaceRequest, options?: RpcOptions): UnaryCall<StopWorkspaceRequest, StopWorkspaceResponse> {
|
|
@@ -527,6 +709,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
527
709
|
return stackIntercept<StopWorkspaceRequest, StopWorkspaceResponse>("unary", this._transport, method, opt, input);
|
|
528
710
|
}
|
|
529
711
|
/**
|
|
712
|
+
* ShareWorkspacePort shares a named Application of a Workspace with other
|
|
713
|
+
* Users so that they can access it via the Workspace's public hostname.
|
|
714
|
+
*
|
|
530
715
|
* @generated from protobuf rpc: ShareWorkspacePort
|
|
531
716
|
*/
|
|
532
717
|
shareWorkspacePort(input: ShareWorkspacePortRequest, options?: RpcOptions): UnaryCall<ShareWorkspacePortRequest, ShareWorkspacePortResponse> {
|
|
@@ -534,6 +719,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
534
719
|
return stackIntercept<ShareWorkspacePortRequest, ShareWorkspacePortResponse>("unary", this._transport, method, opt, input);
|
|
535
720
|
}
|
|
536
721
|
/**
|
|
722
|
+
* UnshareWorkspacePort stops sharing a previously shared named Application
|
|
723
|
+
* of a Workspace.
|
|
724
|
+
*
|
|
537
725
|
* @generated from protobuf rpc: UnshareWorkspacePort
|
|
538
726
|
*/
|
|
539
727
|
unshareWorkspacePort(input: UnshareWorkspacePortRequest, options?: RpcOptions): UnaryCall<UnshareWorkspacePortRequest, UnshareWorkspacePortResponse> {
|
|
@@ -541,6 +729,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
541
729
|
return stackIntercept<UnshareWorkspacePortRequest, UnshareWorkspacePortResponse>("unary", this._transport, method, opt, input);
|
|
542
730
|
}
|
|
543
731
|
/**
|
|
732
|
+
* ListSpace lists the Spaces that are either created by the User or where
|
|
733
|
+
* the User is a Member depending on the requested mode.
|
|
734
|
+
*
|
|
544
735
|
* @generated from protobuf rpc: ListSpace
|
|
545
736
|
*/
|
|
546
737
|
listSpace(input: ListSpaceOptions, options?: RpcOptions): UnaryCall<ListSpaceOptions, SpaceList> {
|
|
@@ -548,6 +739,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
548
739
|
return stackIntercept<ListSpaceOptions, SpaceList>("unary", this._transport, method, opt, input);
|
|
549
740
|
}
|
|
550
741
|
/**
|
|
742
|
+
* ListTemplate lists the Templates of a Space that the User is a Member of.
|
|
743
|
+
*
|
|
551
744
|
* @generated from protobuf rpc: ListTemplate
|
|
552
745
|
*/
|
|
553
746
|
listTemplate(input: ListTemplateOptions, options?: RpcOptions): UnaryCall<ListTemplateOptions, TemplateList> {
|
|
@@ -555,6 +748,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
555
748
|
return stackIntercept<ListTemplateOptions, TemplateList>("unary", this._transport, method, opt, input);
|
|
556
749
|
}
|
|
557
750
|
/**
|
|
751
|
+
* ListMembership lists the Memberships of a Space that the User is a Member
|
|
752
|
+
* of.
|
|
753
|
+
*
|
|
558
754
|
* @generated from protobuf rpc: ListMembership
|
|
559
755
|
*/
|
|
560
756
|
listMembership(input: ListMembershipOptions, options?: RpcOptions): UnaryCall<ListMembershipOptions, MembershipList> {
|
|
@@ -562,6 +758,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
562
758
|
return stackIntercept<ListMembershipOptions, MembershipList>("unary", this._transport, method, opt, input);
|
|
563
759
|
}
|
|
564
760
|
/**
|
|
761
|
+
* ListGitProvider lists the GitProviders of a Space that the User is a
|
|
762
|
+
* Member of.
|
|
763
|
+
*
|
|
565
764
|
* @generated from protobuf rpc: ListGitProvider
|
|
566
765
|
*/
|
|
567
766
|
listGitProvider(input: ListGitProviderOptions, options?: RpcOptions): UnaryCall<ListGitProviderOptions, GitProviderList> {
|
|
@@ -569,6 +768,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
569
768
|
return stackIntercept<ListGitProviderOptions, GitProviderList>("unary", this._transport, method, opt, input);
|
|
570
769
|
}
|
|
571
770
|
/**
|
|
771
|
+
* GetSpace retrieves a specific Space. The caller must be a Member of the
|
|
772
|
+
* Space.
|
|
773
|
+
*
|
|
572
774
|
* @generated from protobuf rpc: GetSpace
|
|
573
775
|
*/
|
|
574
776
|
getSpace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Space> {
|
|
@@ -576,6 +778,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
576
778
|
return stackIntercept<GetOptions, Space>("unary", this._transport, method, opt, input);
|
|
577
779
|
}
|
|
578
780
|
/**
|
|
781
|
+
* GetWorkspace retrieves a specific Workspace owned by the User.
|
|
782
|
+
*
|
|
579
783
|
* @generated from protobuf rpc: GetWorkspace
|
|
580
784
|
*/
|
|
581
785
|
getWorkspace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Workspace> {
|
|
@@ -583,6 +787,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
583
787
|
return stackIntercept<GetOptions, Workspace>("unary", this._transport, method, opt, input);
|
|
584
788
|
}
|
|
585
789
|
/**
|
|
790
|
+
* GetTemplate retrieves a specific Template. The caller must be a Member of
|
|
791
|
+
* the Template's Space.
|
|
792
|
+
*
|
|
586
793
|
* @generated from protobuf rpc: GetTemplate
|
|
587
794
|
*/
|
|
588
795
|
getTemplate(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Template> {
|
|
@@ -590,6 +797,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
590
797
|
return stackIntercept<GetOptions, Template>("unary", this._transport, method, opt, input);
|
|
591
798
|
}
|
|
592
799
|
/**
|
|
800
|
+
* GetGitProvider retrieves a specific GitProvider. The caller must be a
|
|
801
|
+
* Member of the GitProvider's Space.
|
|
802
|
+
*
|
|
593
803
|
* @generated from protobuf rpc: GetGitProvider
|
|
594
804
|
*/
|
|
595
805
|
getGitProvider(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, GitProvider> {
|
|
@@ -597,6 +807,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
597
807
|
return stackIntercept<GetOptions, GitProvider>("unary", this._transport, method, opt, input);
|
|
598
808
|
}
|
|
599
809
|
/**
|
|
810
|
+
* GetMembership retrieves a specific Membership. The caller must be a Member
|
|
811
|
+
* of the Membership's Space.
|
|
812
|
+
*
|
|
600
813
|
* @generated from protobuf rpc: GetMembership
|
|
601
814
|
*/
|
|
602
815
|
getMembership(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Membership> {
|
|
@@ -604,6 +817,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
604
817
|
return stackIntercept<GetOptions, Membership>("unary", this._transport, method, opt, input);
|
|
605
818
|
}
|
|
606
819
|
/**
|
|
820
|
+
* LeaveSpace removes the calling User's own Membership from a Space. Space
|
|
821
|
+
* creators cannot leave their own Spaces, they can only delete them.
|
|
822
|
+
*
|
|
607
823
|
* @generated from protobuf rpc: LeaveSpace
|
|
608
824
|
*/
|
|
609
825
|
leaveSpace(input: LeaveSpaceRequest, options?: RpcOptions): UnaryCall<LeaveSpaceRequest, LeaveSpaceResponse> {
|
|
@@ -611,7 +827,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
611
827
|
return stackIntercept<LeaveSpaceRequest, LeaveSpaceResponse>("unary", this._transport, method, opt, input);
|
|
612
828
|
}
|
|
613
829
|
/**
|
|
614
|
-
*
|
|
830
|
+
* CreateUserSecret creates a UserSecret owned by the User. UserSecrets of
|
|
831
|
+
* the SSH_KEY type have their key pair generated by the Cluster. The
|
|
832
|
+
* UserSecret data is never returned back by the Cluster.
|
|
615
833
|
*
|
|
616
834
|
* @generated from protobuf rpc: CreateUserSecret
|
|
617
835
|
*/
|
|
@@ -620,7 +838,7 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
620
838
|
return stackIntercept<UserSecret, UserSecret>("unary", this._transport, method, opt, input);
|
|
621
839
|
}
|
|
622
840
|
/**
|
|
623
|
-
*
|
|
841
|
+
* UpdateUserSecret updates a UserSecret owned by the User.
|
|
624
842
|
*
|
|
625
843
|
* @generated from protobuf rpc: UpdateUserSecret
|
|
626
844
|
*/
|
|
@@ -629,7 +847,7 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
629
847
|
return stackIntercept<UserSecret, UserSecret>("unary", this._transport, method, opt, input);
|
|
630
848
|
}
|
|
631
849
|
/**
|
|
632
|
-
*
|
|
850
|
+
* DeleteUserSecret deletes a UserSecret owned by the User.
|
|
633
851
|
*
|
|
634
852
|
* @generated from protobuf rpc: DeleteUserSecret
|
|
635
853
|
*/
|
|
@@ -638,7 +856,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
638
856
|
return stackIntercept<DeleteOptions, OperationResult>("unary", this._transport, method, opt, input);
|
|
639
857
|
}
|
|
640
858
|
/**
|
|
641
|
-
*
|
|
859
|
+
* ListUserSecret lists the UserSecrets owned by the User. The UserSecrets'
|
|
860
|
+
* data is not included in the response.
|
|
642
861
|
*
|
|
643
862
|
* @generated from protobuf rpc: ListUserSecret
|
|
644
863
|
*/
|
|
@@ -647,6 +866,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
647
866
|
return stackIntercept<ListUserSecretOptions, UserSecretList>("unary", this._transport, method, opt, input);
|
|
648
867
|
}
|
|
649
868
|
/**
|
|
869
|
+
* GetUserSecret retrieves a specific UserSecret owned by the User. The
|
|
870
|
+
* UserSecret data is not included in the response.
|
|
871
|
+
*
|
|
650
872
|
* @generated from protobuf rpc: GetUserSecret
|
|
651
873
|
*/
|
|
652
874
|
getUserSecret(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, UserSecret> {
|
|
@@ -654,6 +876,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
654
876
|
return stackIntercept<GetOptions, UserSecret>("unary", this._transport, method, opt, input);
|
|
655
877
|
}
|
|
656
878
|
/**
|
|
879
|
+
* GetUserConfig retrieves the calling User's UserConfig. The UserConfig is
|
|
880
|
+
* automatically created by the Cluster upon the first call.
|
|
881
|
+
*
|
|
657
882
|
* @generated from protobuf rpc: GetUserConfig
|
|
658
883
|
*/
|
|
659
884
|
getUserConfig(input: GetUserConfigRequest, options?: RpcOptions): UnaryCall<GetUserConfigRequest, UserConfig> {
|
|
@@ -661,6 +886,8 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
661
886
|
return stackIntercept<GetUserConfigRequest, UserConfig>("unary", this._transport, method, opt, input);
|
|
662
887
|
}
|
|
663
888
|
/**
|
|
889
|
+
* UpdateUserConfig updates the calling User's UserConfig.
|
|
890
|
+
*
|
|
664
891
|
* @generated from protobuf rpc: UpdateUserConfig
|
|
665
892
|
*/
|
|
666
893
|
updateUserConfig(input: UserConfig, options?: RpcOptions): UnaryCall<UserConfig, UserConfig> {
|
|
@@ -668,6 +895,9 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
668
895
|
return stackIntercept<UserConfig, UserConfig>("unary", this._transport, method, opt, input);
|
|
669
896
|
}
|
|
670
897
|
/**
|
|
898
|
+
* ListRegion lists the Regions of the Cluster that are enabled to host
|
|
899
|
+
* Workspaces.
|
|
900
|
+
*
|
|
671
901
|
* @generated from protobuf rpc: ListRegion
|
|
672
902
|
*/
|
|
673
903
|
listRegion(input: ListRegionOptions, options?: RpcOptions): UnaryCall<ListRegionOptions, RegionList> {
|
|
@@ -675,6 +905,12 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
675
905
|
return stackIntercept<ListRegionOptions, RegionList>("unary", this._transport, method, opt, input);
|
|
676
906
|
}
|
|
677
907
|
/**
|
|
908
|
+
* WatchWorkspace opens a server-side stream that publishes the create,
|
|
909
|
+
* update and delete events of the User's Workspaces. If a workspaceRef is
|
|
910
|
+
* set in the request, only the events of that specific Workspace are
|
|
911
|
+
* published. It is the recommended way to follow a Workspace's state
|
|
912
|
+
* throughout its lifecycle.
|
|
913
|
+
*
|
|
678
914
|
* @generated from protobuf rpc: WatchWorkspace
|
|
679
915
|
*/
|
|
680
916
|
watchWorkspace(input: WatchWorkspaceRequest, options?: RpcOptions): ServerStreamingCall<WatchWorkspaceRequest, WatchWorkspaceResponse> {
|
|
@@ -683,43 +919,77 @@ export class MainServiceClient implements IMainServiceClient, ServiceInfo {
|
|
|
683
919
|
}
|
|
684
920
|
}
|
|
685
921
|
/**
|
|
922
|
+
* WorkspaceService is the API that operates inside a running Workspace. It
|
|
923
|
+
* provides interactive terminals, command execution and the initialization
|
|
924
|
+
* logs. Every method requires the Workspace to be owned by the calling User
|
|
925
|
+
* and to be in the PREPARING or the RUNNING state.
|
|
926
|
+
*
|
|
686
927
|
* @generated from protobuf service octelium.api.main.cordium.v1.WorkspaceService
|
|
687
928
|
*/
|
|
688
929
|
export interface IWorkspaceServiceClient {
|
|
689
930
|
/**
|
|
931
|
+
* CreateTerminal creates a new interactive terminal (i.e. a PTY-backed
|
|
932
|
+
* shell) inside a Workspace and returns its ID.
|
|
933
|
+
*
|
|
690
934
|
* @generated from protobuf rpc: CreateTerminal
|
|
691
935
|
*/
|
|
692
936
|
createTerminal(input: CreateTerminalRequest, options?: RpcOptions): UnaryCall<CreateTerminalRequest, CreateTerminalResponse>;
|
|
693
937
|
/**
|
|
938
|
+
* RemoveTerminal terminates a terminal.
|
|
939
|
+
*
|
|
694
940
|
* @generated from protobuf rpc: RemoveTerminal
|
|
695
941
|
*/
|
|
696
942
|
removeTerminal(input: RemoveTerminalRequest, options?: RpcOptions): UnaryCall<RemoveTerminalRequest, RemoveTerminalResponse>;
|
|
697
943
|
/**
|
|
944
|
+
* ListTerminal lists the currently open terminals of a Workspace.
|
|
945
|
+
*
|
|
698
946
|
* @generated from protobuf rpc: ListTerminal
|
|
699
947
|
*/
|
|
700
948
|
listTerminal(input: ListTerminalRequest, options?: RpcOptions): UnaryCall<ListTerminalRequest, ListTerminalResponse>;
|
|
701
949
|
/**
|
|
950
|
+
* WriteTerminalData writes data (i.e. stdin) to a terminal.
|
|
951
|
+
*
|
|
702
952
|
* @generated from protobuf rpc: WriteTerminalData
|
|
703
953
|
*/
|
|
704
954
|
writeTerminalData(input: WriteTerminalDataRequest, options?: RpcOptions): UnaryCall<WriteTerminalDataRequest, WriteTerminalDataResponse>;
|
|
705
955
|
/**
|
|
956
|
+
* SetTerminalWindowSize resizes a terminal's window.
|
|
957
|
+
*
|
|
706
958
|
* @generated from protobuf rpc: SetTerminalWindowSize
|
|
707
959
|
*/
|
|
708
960
|
setTerminalWindowSize(input: SetTerminalWindowSizeRequest, options?: RpcOptions): UnaryCall<SetTerminalWindowSizeRequest, SetTerminalWindowSizeResponse>;
|
|
709
961
|
/**
|
|
962
|
+
* ListenTerminal opens a server-side stream of a terminal's output. Multiple
|
|
963
|
+
* listeners can be attached to the same terminal at the same time.
|
|
964
|
+
*
|
|
710
965
|
* @generated from protobuf rpc: ListenTerminal
|
|
711
966
|
*/
|
|
712
967
|
listenTerminal(input: ListenTerminalRequest, options?: RpcOptions): ServerStreamingCall<ListenTerminalRequest, ListenTerminalResponse>;
|
|
713
968
|
/**
|
|
969
|
+
* ListenLog opens a server-side stream of a Workspace's initialization logs
|
|
970
|
+
* (i.e. the repository cloning, image pulling, image building and the
|
|
971
|
+
* lifecycle tasks output).
|
|
972
|
+
*
|
|
714
973
|
* @generated from protobuf rpc: ListenLog
|
|
715
974
|
*/
|
|
716
975
|
listenLog(input: ListenLogRequest, options?: RpcOptions): ServerStreamingCall<ListenLogRequest, ListenLogResponse>;
|
|
717
976
|
/**
|
|
977
|
+
* Exec runs a one-off command inside a Workspace over a bidirectional
|
|
978
|
+
* stream. The first client message must be a `request` message. The
|
|
979
|
+
* subsequent client messages carry the command's stdin or a kill signal
|
|
980
|
+
* while the server messages carry the command's stdout, stderr and its
|
|
981
|
+
* eventual exit code.
|
|
982
|
+
*
|
|
718
983
|
* @generated from protobuf rpc: Exec
|
|
719
984
|
*/
|
|
720
985
|
exec(options?: RpcOptions): DuplexStreamingCall<ExecRequest, ExecResponse>;
|
|
721
986
|
}
|
|
722
987
|
/**
|
|
988
|
+
* WorkspaceService is the API that operates inside a running Workspace. It
|
|
989
|
+
* provides interactive terminals, command execution and the initialization
|
|
990
|
+
* logs. Every method requires the Workspace to be owned by the calling User
|
|
991
|
+
* and to be in the PREPARING or the RUNNING state.
|
|
992
|
+
*
|
|
723
993
|
* @generated from protobuf service octelium.api.main.cordium.v1.WorkspaceService
|
|
724
994
|
*/
|
|
725
995
|
export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceInfo {
|
|
@@ -729,6 +999,9 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
729
999
|
constructor(private readonly _transport: RpcTransport) {
|
|
730
1000
|
}
|
|
731
1001
|
/**
|
|
1002
|
+
* CreateTerminal creates a new interactive terminal (i.e. a PTY-backed
|
|
1003
|
+
* shell) inside a Workspace and returns its ID.
|
|
1004
|
+
*
|
|
732
1005
|
* @generated from protobuf rpc: CreateTerminal
|
|
733
1006
|
*/
|
|
734
1007
|
createTerminal(input: CreateTerminalRequest, options?: RpcOptions): UnaryCall<CreateTerminalRequest, CreateTerminalResponse> {
|
|
@@ -736,6 +1009,8 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
736
1009
|
return stackIntercept<CreateTerminalRequest, CreateTerminalResponse>("unary", this._transport, method, opt, input);
|
|
737
1010
|
}
|
|
738
1011
|
/**
|
|
1012
|
+
* RemoveTerminal terminates a terminal.
|
|
1013
|
+
*
|
|
739
1014
|
* @generated from protobuf rpc: RemoveTerminal
|
|
740
1015
|
*/
|
|
741
1016
|
removeTerminal(input: RemoveTerminalRequest, options?: RpcOptions): UnaryCall<RemoveTerminalRequest, RemoveTerminalResponse> {
|
|
@@ -743,6 +1018,8 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
743
1018
|
return stackIntercept<RemoveTerminalRequest, RemoveTerminalResponse>("unary", this._transport, method, opt, input);
|
|
744
1019
|
}
|
|
745
1020
|
/**
|
|
1021
|
+
* ListTerminal lists the currently open terminals of a Workspace.
|
|
1022
|
+
*
|
|
746
1023
|
* @generated from protobuf rpc: ListTerminal
|
|
747
1024
|
*/
|
|
748
1025
|
listTerminal(input: ListTerminalRequest, options?: RpcOptions): UnaryCall<ListTerminalRequest, ListTerminalResponse> {
|
|
@@ -750,6 +1027,8 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
750
1027
|
return stackIntercept<ListTerminalRequest, ListTerminalResponse>("unary", this._transport, method, opt, input);
|
|
751
1028
|
}
|
|
752
1029
|
/**
|
|
1030
|
+
* WriteTerminalData writes data (i.e. stdin) to a terminal.
|
|
1031
|
+
*
|
|
753
1032
|
* @generated from protobuf rpc: WriteTerminalData
|
|
754
1033
|
*/
|
|
755
1034
|
writeTerminalData(input: WriteTerminalDataRequest, options?: RpcOptions): UnaryCall<WriteTerminalDataRequest, WriteTerminalDataResponse> {
|
|
@@ -757,6 +1036,8 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
757
1036
|
return stackIntercept<WriteTerminalDataRequest, WriteTerminalDataResponse>("unary", this._transport, method, opt, input);
|
|
758
1037
|
}
|
|
759
1038
|
/**
|
|
1039
|
+
* SetTerminalWindowSize resizes a terminal's window.
|
|
1040
|
+
*
|
|
760
1041
|
* @generated from protobuf rpc: SetTerminalWindowSize
|
|
761
1042
|
*/
|
|
762
1043
|
setTerminalWindowSize(input: SetTerminalWindowSizeRequest, options?: RpcOptions): UnaryCall<SetTerminalWindowSizeRequest, SetTerminalWindowSizeResponse> {
|
|
@@ -764,6 +1045,9 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
764
1045
|
return stackIntercept<SetTerminalWindowSizeRequest, SetTerminalWindowSizeResponse>("unary", this._transport, method, opt, input);
|
|
765
1046
|
}
|
|
766
1047
|
/**
|
|
1048
|
+
* ListenTerminal opens a server-side stream of a terminal's output. Multiple
|
|
1049
|
+
* listeners can be attached to the same terminal at the same time.
|
|
1050
|
+
*
|
|
767
1051
|
* @generated from protobuf rpc: ListenTerminal
|
|
768
1052
|
*/
|
|
769
1053
|
listenTerminal(input: ListenTerminalRequest, options?: RpcOptions): ServerStreamingCall<ListenTerminalRequest, ListenTerminalResponse> {
|
|
@@ -771,6 +1055,10 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
771
1055
|
return stackIntercept<ListenTerminalRequest, ListenTerminalResponse>("serverStreaming", this._transport, method, opt, input);
|
|
772
1056
|
}
|
|
773
1057
|
/**
|
|
1058
|
+
* ListenLog opens a server-side stream of a Workspace's initialization logs
|
|
1059
|
+
* (i.e. the repository cloning, image pulling, image building and the
|
|
1060
|
+
* lifecycle tasks output).
|
|
1061
|
+
*
|
|
774
1062
|
* @generated from protobuf rpc: ListenLog
|
|
775
1063
|
*/
|
|
776
1064
|
listenLog(input: ListenLogRequest, options?: RpcOptions): ServerStreamingCall<ListenLogRequest, ListenLogResponse> {
|
|
@@ -778,6 +1066,12 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
778
1066
|
return stackIntercept<ListenLogRequest, ListenLogResponse>("serverStreaming", this._transport, method, opt, input);
|
|
779
1067
|
}
|
|
780
1068
|
/**
|
|
1069
|
+
* Exec runs a one-off command inside a Workspace over a bidirectional
|
|
1070
|
+
* stream. The first client message must be a `request` message. The
|
|
1071
|
+
* subsequent client messages carry the command's stdin or a kill signal
|
|
1072
|
+
* while the server messages carry the command's stdout, stderr and its
|
|
1073
|
+
* eventual exit code.
|
|
1074
|
+
*
|
|
781
1075
|
* @generated from protobuf rpc: Exec
|
|
782
1076
|
*/
|
|
783
1077
|
exec(options?: RpcOptions): DuplexStreamingCall<ExecRequest, ExecResponse> {
|
|
@@ -786,6 +1080,10 @@ export class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceI
|
|
|
786
1080
|
}
|
|
787
1081
|
}
|
|
788
1082
|
/**
|
|
1083
|
+
* ManagementService is the administrative API of a Cordium Cluster. It is used
|
|
1084
|
+
* by the Cluster administrators (e.g. via `cordium man`) to read and update
|
|
1085
|
+
* the Cluster-wide configuration.
|
|
1086
|
+
*
|
|
789
1087
|
* @generated from protobuf service octelium.api.main.cordium.v1.ManagementService
|
|
790
1088
|
*/
|
|
791
1089
|
export interface IManagementServiceClient {
|
|
@@ -796,13 +1094,17 @@ export interface IManagementServiceClient {
|
|
|
796
1094
|
*/
|
|
797
1095
|
getClusterConfig(input: GetClusterConfigRequest, options?: RpcOptions): UnaryCall<GetClusterConfigRequest, ClusterConfig>;
|
|
798
1096
|
/**
|
|
799
|
-
*
|
|
1097
|
+
* UpdateClusterConfig updates the Cluster Configuration.
|
|
800
1098
|
*
|
|
801
1099
|
* @generated from protobuf rpc: UpdateClusterConfig
|
|
802
1100
|
*/
|
|
803
1101
|
updateClusterConfig(input: ClusterConfig, options?: RpcOptions): UnaryCall<ClusterConfig, ClusterConfig>;
|
|
804
1102
|
}
|
|
805
1103
|
/**
|
|
1104
|
+
* ManagementService is the administrative API of a Cordium Cluster. It is used
|
|
1105
|
+
* by the Cluster administrators (e.g. via `cordium man`) to read and update
|
|
1106
|
+
* the Cluster-wide configuration.
|
|
1107
|
+
*
|
|
806
1108
|
* @generated from protobuf service octelium.api.main.cordium.v1.ManagementService
|
|
807
1109
|
*/
|
|
808
1110
|
export class ManagementServiceClient implements IManagementServiceClient, ServiceInfo {
|
|
@@ -821,7 +1123,7 @@ export class ManagementServiceClient implements IManagementServiceClient, Servic
|
|
|
821
1123
|
return stackIntercept<GetClusterConfigRequest, ClusterConfig>("unary", this._transport, method, opt, input);
|
|
822
1124
|
}
|
|
823
1125
|
/**
|
|
824
|
-
*
|
|
1126
|
+
* UpdateClusterConfig updates the Cluster Configuration.
|
|
825
1127
|
*
|
|
826
1128
|
* @generated from protobuf rpc: UpdateClusterConfig
|
|
827
1129
|
*/
|