@octelium/apis 1.0.6 → 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.
Files changed (39) hide show
  1. package/google/protobuf/struct.d.ts +3 -3
  2. package/google/protobuf/struct.js +3 -3
  3. package/google/protobuf/struct.ts +3 -3
  4. package/main/authv1/authv1.d.ts +32 -1
  5. package/main/authv1/authv1.d.ts.map +1 -1
  6. package/main/authv1/authv1.js +44 -4
  7. package/main/authv1/authv1.js.map +1 -1
  8. package/main/authv1/authv1.ts +68 -5
  9. package/main/cordiumv1/cordiumv1.client.d.ts +336 -34
  10. package/main/cordiumv1/cordiumv1.client.d.ts.map +1 -1
  11. package/main/cordiumv1/cordiumv1.client.js +168 -17
  12. package/main/cordiumv1/cordiumv1.client.js.map +1 -1
  13. package/main/cordiumv1/cordiumv1.client.ts +336 -34
  14. package/main/cordiumv1/cordiumv1.d.ts +1849 -6
  15. package/main/cordiumv1/cordiumv1.d.ts.map +1 -1
  16. package/main/cordiumv1/cordiumv1.js +206 -0
  17. package/main/cordiumv1/cordiumv1.js.map +1 -1
  18. package/main/cordiumv1/cordiumv1.ts +1849 -6
  19. package/main/corev1/corev1.client.d.ts +22 -12
  20. package/main/corev1/corev1.client.d.ts.map +1 -1
  21. package/main/corev1/corev1.client.js +11 -6
  22. package/main/corev1/corev1.client.js.map +1 -1
  23. package/main/corev1/corev1.client.ts +22 -12
  24. package/main/corev1/corev1.d.ts +11971 -3175
  25. package/main/corev1/corev1.d.ts.map +1 -1
  26. package/main/corev1/corev1.js +16753 -9976
  27. package/main/corev1/corev1.js.map +1 -1
  28. package/main/corev1/corev1.ts +25818 -12771
  29. package/main/metav1/metav1.d.ts +69 -9
  30. package/main/metav1/metav1.d.ts.map +1 -1
  31. package/main/metav1/metav1.js +17 -0
  32. package/main/metav1/metav1.js.map +1 -1
  33. package/main/metav1/metav1.ts +69 -9
  34. package/main/userv1/userv1.d.ts +13 -1
  35. package/main/userv1/userv1.d.ts.map +1 -1
  36. package/main/userv1/userv1.js +12 -0
  37. package/main/userv1/userv1.js.map +1 -1
  38. package/main/userv1/userv1.ts +13 -1
  39. package/package.json +1 -1
@@ -33,350 +33,556 @@ import { Timestamp } from "../../google/protobuf/timestamp.js";
33
33
  import { ObjectReference } from "../metav1/metav1.js";
34
34
  import { Metadata } from "../metav1/metav1.js";
35
35
  /**
36
+ * Type is the point of the Workspace's lifecycle at which the Task is
37
+ * run
38
+ *
36
39
  * @generated from protobuf enum octelium.api.main.cordium.v1.Workspace.Spec.Runtime.Task.Type
37
40
  */
38
41
  export var Workspace_Spec_Runtime_Task_Type;
39
42
  (function (Workspace_Spec_Runtime_Task_Type) {
40
43
  /**
44
+ * UNKNOWN is not used. The type of a Task must be explicitly set.
45
+ *
41
46
  * @generated from protobuf enum value: UNKNOWN = 0;
42
47
  */
43
48
  Workspace_Spec_Runtime_Task_Type[Workspace_Spec_Runtime_Task_Type["UNKNOWN"] = 0] = "UNKNOWN";
44
49
  /**
50
+ * ON_CREATE runs the Task only on a fresh run (i.e. the first start
51
+ * of a persistent Workspace and every start of an ephemeral one). It
52
+ * is typically used for one-time setup such as installing
53
+ * dependencies or running migrations.
54
+ *
45
55
  * @generated from protobuf enum value: ON_CREATE = 1;
46
56
  */
47
57
  Workspace_Spec_Runtime_Task_Type[Workspace_Spec_Runtime_Task_Type["ON_CREATE"] = 1] = "ON_CREATE";
48
58
  /**
59
+ * POST_START runs the Task on every start of the Workspace. It is
60
+ * typically used to start background services and dev servers.
61
+ *
49
62
  * @generated from protobuf enum value: POST_START = 2;
50
63
  */
51
64
  Workspace_Spec_Runtime_Task_Type[Workspace_Spec_Runtime_Task_Type["POST_START"] = 2] = "POST_START";
52
65
  /**
66
+ * PRE_STOP runs the Task right before the Workspace's container is
67
+ * stopped. It is typically used for graceful shutdown and cleanup.
68
+ *
53
69
  * @generated from protobuf enum value: PRE_STOP = 3;
54
70
  */
55
71
  Workspace_Spec_Runtime_Task_Type[Workspace_Spec_Runtime_Task_Type["PRE_STOP"] = 3] = "PRE_STOP";
56
72
  })(Workspace_Spec_Runtime_Task_Type || (Workspace_Spec_Runtime_Task_Type = {}));
57
73
  /**
74
+ * OnFailure is the behavior of the Cluster when the Task fails
75
+ *
58
76
  * @generated from protobuf enum octelium.api.main.cordium.v1.Workspace.Spec.Runtime.Task.OnFailure
59
77
  */
60
78
  export var Workspace_Spec_Runtime_Task_OnFailure;
61
79
  (function (Workspace_Spec_Runtime_Task_OnFailure) {
62
80
  /**
81
+ * ON_FAILURE_UNSET falls back to the default behavior.
82
+ *
63
83
  * @generated from protobuf enum value: ON_FAILURE_UNSET = 0;
64
84
  */
65
85
  Workspace_Spec_Runtime_Task_OnFailure[Workspace_Spec_Runtime_Task_OnFailure["UNSET"] = 0] = "UNSET";
66
86
  /**
87
+ * ON_FAILURE_ABORT aborts the initialization of the Workspace once
88
+ * the Task fails.
89
+ *
67
90
  * @generated from protobuf enum value: ON_FAILURE_ABORT = 1;
68
91
  */
69
92
  Workspace_Spec_Runtime_Task_OnFailure[Workspace_Spec_Runtime_Task_OnFailure["ABORT"] = 1] = "ABORT";
70
93
  /**
94
+ * ON_FAILURE_CONTINUE logs the Task's failure and continues the
95
+ * initialization of the Workspace.
96
+ *
71
97
  * @generated from protobuf enum value: ON_FAILURE_CONTINUE = 2;
72
98
  */
73
99
  Workspace_Spec_Runtime_Task_OnFailure[Workspace_Spec_Runtime_Task_OnFailure["CONTINUE"] = 2] = "CONTINUE";
74
100
  })(Workspace_Spec_Runtime_Task_OnFailure || (Workspace_Spec_Runtime_Task_OnFailure = {}));
75
101
  /**
102
+ * Action is the effect of the Rule when it matches
103
+ *
76
104
  * @generated from protobuf enum octelium.api.main.cordium.v1.Workspace.Spec.Runtime.Network.Rule.Action
77
105
  */
78
106
  export var Workspace_Spec_Runtime_Network_Rule_Action;
79
107
  (function (Workspace_Spec_Runtime_Network_Rule_Action) {
80
108
  /**
109
+ * ACTION_UNSET falls back to the default action.
110
+ *
81
111
  * @generated from protobuf enum value: ACTION_UNSET = 0;
82
112
  */
83
113
  Workspace_Spec_Runtime_Network_Rule_Action[Workspace_Spec_Runtime_Network_Rule_Action["ACTION_UNSET"] = 0] = "ACTION_UNSET";
84
114
  /**
115
+ * ALLOW allows the matched traffic.
116
+ *
85
117
  * @generated from protobuf enum value: ALLOW = 1;
86
118
  */
87
119
  Workspace_Spec_Runtime_Network_Rule_Action[Workspace_Spec_Runtime_Network_Rule_Action["ALLOW"] = 1] = "ALLOW";
88
120
  /**
121
+ * DENY denies the matched traffic.
122
+ *
89
123
  * @generated from protobuf enum value: DENY = 2;
90
124
  */
91
125
  Workspace_Spec_Runtime_Network_Rule_Action[Workspace_Spec_Runtime_Network_Rule_Action["DENY"] = 2] = "DENY";
92
126
  })(Workspace_Spec_Runtime_Network_Rule_Action || (Workspace_Spec_Runtime_Network_Rule_Action = {}));
93
127
  /**
128
+ * Mode is the inactivity timeout mode
129
+ *
94
130
  * @generated from protobuf enum octelium.api.main.cordium.v1.Workspace.Spec.Runtime.Timeout.Mode
95
131
  */
96
132
  export var Workspace_Spec_Runtime_Timeout_Mode;
97
133
  (function (Workspace_Spec_Runtime_Timeout_Mode) {
98
134
  /**
135
+ * MODE_UNSET falls back to the default behavior which is to apply
136
+ * the Cluster's inactivity timeout.
137
+ *
99
138
  * @generated from protobuf enum value: MODE_UNSET = 0;
100
139
  */
101
140
  Workspace_Spec_Runtime_Timeout_Mode[Workspace_Spec_Runtime_Timeout_Mode["MODE_UNSET"] = 0] = "MODE_UNSET";
102
141
  /**
142
+ * DEFAULT applies the Cluster's inactivity timeout.
143
+ *
103
144
  * @generated from protobuf enum value: DEFAULT = 1;
104
145
  */
105
146
  Workspace_Spec_Runtime_Timeout_Mode[Workspace_Spec_Runtime_Timeout_Mode["DEFAULT"] = 1] = "DEFAULT";
106
147
  /**
148
+ * DISABLED disables the inactivity timeout entirely. It is only
149
+ * honored when the ClusterConfig allows Workspaces to have no
150
+ * timeout.
151
+ *
107
152
  * @generated from protobuf enum value: DISABLED = 2;
108
153
  */
109
154
  Workspace_Spec_Runtime_Timeout_Mode[Workspace_Spec_Runtime_Timeout_Mode["DISABLED"] = 2] = "DISABLED";
110
155
  })(Workspace_Spec_Runtime_Timeout_Mode || (Workspace_Spec_Runtime_Timeout_Mode = {}));
111
156
  /**
157
+ * Mode is the audience with which the Application is shared
158
+ *
112
159
  * @generated from protobuf enum octelium.api.main.cordium.v1.Workspace.Status.SharedPort.Mode
113
160
  */
114
161
  export var Workspace_Status_SharedPort_Mode;
115
162
  (function (Workspace_Status_SharedPort_Mode) {
116
163
  /**
164
+ * UNSET is not used. A shared Application must have an explicit mode.
165
+ *
117
166
  * @generated from protobuf enum value: UNSET = 0;
118
167
  */
119
168
  Workspace_Status_SharedPort_Mode[Workspace_Status_SharedPort_Mode["UNSET"] = 0] = "UNSET";
120
169
  /**
170
+ * MEMBERS shares the Application with the Members of the Workspace's
171
+ * Space.
172
+ *
121
173
  * @generated from protobuf enum value: MEMBERS = 1;
122
174
  */
123
175
  Workspace_Status_SharedPort_Mode[Workspace_Status_SharedPort_Mode["MEMBERS"] = 1] = "MEMBERS";
124
176
  /**
177
+ * ALL shares the Application with all the Cluster's Users.
178
+ *
125
179
  * @generated from protobuf enum value: ALL = 2;
126
180
  */
127
181
  Workspace_Status_SharedPort_Mode[Workspace_Status_SharedPort_Mode["ALL"] = 2] = "ALL";
128
182
  })(Workspace_Status_SharedPort_Mode || (Workspace_Status_SharedPort_Mode = {}));
129
183
  /**
184
+ * State is the current state of the Workspace's lifecycle
185
+ *
130
186
  * @generated from protobuf enum octelium.api.main.cordium.v1.Workspace.Status.State
131
187
  */
132
188
  export var Workspace_Status_State;
133
189
  (function (Workspace_Status_State) {
134
190
  /**
191
+ * UNKNOWN is not used.
192
+ *
135
193
  * @generated from protobuf enum value: UNKNOWN = 0;
136
194
  */
137
195
  Workspace_Status_State[Workspace_Status_State["UNKNOWN"] = 0] = "UNKNOWN";
138
196
  /**
197
+ * INIT_REQUEST means that a start request has been accepted by the API
198
+ * server.
199
+ *
139
200
  * @generated from protobuf enum value: INIT_REQUEST = 1;
140
201
  */
141
202
  Workspace_Status_State[Workspace_Status_State["INIT_REQUEST"] = 1] = "INIT_REQUEST";
142
203
  /**
204
+ * INITIALIZING means that the Cluster is provisioning the Workspace's
205
+ * underlying resources and waiting for its supervisor to become ready.
206
+ *
143
207
  * @generated from protobuf enum value: INITIALIZING = 2;
144
208
  */
145
209
  Workspace_Status_State[Workspace_Status_State["INITIALIZING"] = 2] = "INITIALIZING";
146
210
  /**
211
+ * PULLING_IMAGE means that the container image is being pulled from the
212
+ * registry.
213
+ *
147
214
  * @generated from protobuf enum value: PULLING_IMAGE = 3;
148
215
  */
149
216
  Workspace_Status_State[Workspace_Status_State["PULLING_IMAGE"] = 3] = "PULLING_IMAGE";
150
217
  /**
218
+ * BUILDING_IMAGE means that the container image is being built from a
219
+ * Dockerfile or a devcontainer spec.
220
+ *
151
221
  * @generated from protobuf enum value: BUILDING_IMAGE = 4;
152
222
  */
153
223
  Workspace_Status_State[Workspace_Status_State["BUILDING_IMAGE"] = 4] = "BUILDING_IMAGE";
154
224
  /**
225
+ * STARTING_RUNTIME means that the Workspace's container has started and
226
+ * that the agent is initializing.
227
+ *
155
228
  * @generated from protobuf enum value: STARTING_RUNTIME = 5;
156
229
  */
157
230
  Workspace_Status_State[Workspace_Status_State["STARTING_RUNTIME"] = 5] = "STARTING_RUNTIME";
158
231
  /**
232
+ * PREPARING means that the agent is running the lifecycle setup (i.e.
233
+ * the repository cloning, the ON_CREATE tasks, the dotfiles and the
234
+ * devcontainer Features).
235
+ *
159
236
  * @generated from protobuf enum value: PREPARING = 6;
160
237
  */
161
238
  Workspace_Status_State[Workspace_Status_State["PREPARING"] = 6] = "PREPARING";
162
239
  /**
240
+ * RUNNING means that the Workspace is fully initialized and ready to be
241
+ * used.
242
+ *
163
243
  * @generated from protobuf enum value: RUNNING = 7;
164
244
  */
165
245
  Workspace_Status_State[Workspace_Status_State["RUNNING"] = 7] = "RUNNING";
166
246
  /**
247
+ * STOPPING_REQUEST means that a stop request has been received.
248
+ *
167
249
  * @generated from protobuf enum value: STOPPING_REQUEST = 9;
168
250
  */
169
251
  Workspace_Status_State[Workspace_Status_State["STOPPING_REQUEST"] = 9] = "STOPPING_REQUEST";
170
252
  /**
253
+ * STOPPING means that the Workspace is shutting down gracefully and
254
+ * running its PRE_STOP tasks.
255
+ *
171
256
  * @generated from protobuf enum value: STOPPING = 10;
172
257
  */
173
258
  Workspace_Status_State[Workspace_Status_State["STOPPING"] = 10] = "STOPPING";
174
259
  /**
260
+ * STOPPED means that the Workspace is not running. Its storage is
261
+ * preserved unless the Workspace is ephemeral.
262
+ *
175
263
  * @generated from protobuf enum value: STOPPED = 11;
176
264
  */
177
265
  Workspace_Status_State[Workspace_Status_State["STOPPED"] = 11] = "STOPPED";
178
266
  })(Workspace_Status_State || (Workspace_Status_State = {}));
179
267
  /**
268
+ * StoppingReason is the reason for which a Workspace was stopped
269
+ *
180
270
  * @generated from protobuf enum octelium.api.main.cordium.v1.Workspace.Status.StoppingReason
181
271
  */
182
272
  export var Workspace_Status_StoppingReason;
183
273
  (function (Workspace_Status_StoppingReason) {
184
274
  /**
275
+ * STOPPING_REASON_UNSET means that no stoppage reason is set (e.g. the
276
+ * Workspace has never been stopped yet).
277
+ *
185
278
  * @generated from protobuf enum value: STOPPING_REASON_UNSET = 0;
186
279
  */
187
280
  Workspace_Status_StoppingReason[Workspace_Status_StoppingReason["UNSET"] = 0] = "UNSET";
188
281
  /**
282
+ * STOPPING_REASON_API means that the Workspace was stopped upon an
283
+ * explicit API request (e.g. via the StopWorkspace method).
284
+ *
189
285
  * @generated from protobuf enum value: STOPPING_REASON_API = 1;
190
286
  */
191
287
  Workspace_Status_StoppingReason[Workspace_Status_StoppingReason["API"] = 1] = "API";
192
288
  /**
289
+ * STOPPING_REASON_ERROR means that the Workspace was stopped because of
290
+ * a failure of the run.
291
+ *
193
292
  * @generated from protobuf enum value: STOPPING_REASON_ERROR = 2;
194
293
  */
195
294
  Workspace_Status_StoppingReason[Workspace_Status_StoppingReason["ERROR"] = 2] = "ERROR";
196
295
  /**
296
+ * STOPPING_REASON_CLUSTER means that the Workspace was stopped by the
297
+ * Cluster itself (e.g. once its inactivity timeout was exceeded).
298
+ *
197
299
  * @generated from protobuf enum value: STOPPING_REASON_CLUSTER = 3;
198
300
  */
199
301
  Workspace_Status_StoppingReason[Workspace_Status_StoppingReason["CLUSTER"] = 3] = "CLUSTER";
200
302
  })(Workspace_Status_StoppingReason || (Workspace_Status_StoppingReason = {}));
201
303
  /**
304
+ * State is the current state of the pre-build
305
+ *
202
306
  * @generated from protobuf enum octelium.api.main.cordium.v1.Template.Status.BuildInfo.Build.State
203
307
  */
204
308
  export var Template_Status_BuildInfo_Build_State;
205
309
  (function (Template_Status_BuildInfo_Build_State) {
206
310
  /**
311
+ * STATE_UNKNOWN is not used.
312
+ *
207
313
  * @generated from protobuf enum value: STATE_UNKNOWN = 0;
208
314
  */
209
315
  Template_Status_BuildInfo_Build_State[Template_Status_BuildInfo_Build_State["UNKNOWN"] = 0] = "UNKNOWN";
210
316
  /**
317
+ * STATE_RUNNING means that the pre-build is currently running.
318
+ *
211
319
  * @generated from protobuf enum value: STATE_RUNNING = 1;
212
320
  */
213
321
  Template_Status_BuildInfo_Build_State[Template_Status_BuildInfo_Build_State["RUNNING"] = 1] = "RUNNING";
214
322
  /**
323
+ * STATE_READY means that the pre-build successfully completed and
324
+ * that its storage snapshot can be used by the new Workspaces.
325
+ *
215
326
  * @generated from protobuf enum value: STATE_READY = 2;
216
327
  */
217
328
  Template_Status_BuildInfo_Build_State[Template_Status_BuildInfo_Build_State["READY"] = 2] = "READY";
218
329
  /**
330
+ * STATE_FAILED means that the pre-build failed or that it was
331
+ * canceled.
332
+ *
219
333
  * @generated from protobuf enum value: STATE_FAILED = 3;
220
334
  */
221
335
  Template_Status_BuildInfo_Build_State[Template_Status_BuildInfo_Build_State["FAILED"] = 3] = "FAILED";
222
336
  })(Template_Status_BuildInfo_Build_State || (Template_Status_BuildInfo_Build_State = {}));
223
337
  /**
338
+ * Type is the type of the Space
339
+ *
224
340
  * @generated from protobuf enum octelium.api.main.cordium.v1.Space.Status.Type
225
341
  */
226
342
  export var Space_Status_Type;
227
343
  (function (Space_Status_Type) {
228
344
  /**
345
+ * SPACE_TYPE_UNSET is not used.
346
+ *
229
347
  * @generated from protobuf enum value: SPACE_TYPE_UNSET = 0;
230
348
  */
231
349
  Space_Status_Type[Space_Status_Type["SPACE_TYPE_UNSET"] = 0] = "SPACE_TYPE_UNSET";
232
350
  /**
351
+ * USER is a Space that is personal to a single Octelium User. Members
352
+ * cannot currently be added to it and it cannot define resource limits.
353
+ *
233
354
  * @generated from protobuf enum value: USER = 1;
234
355
  */
235
356
  Space_Status_Type[Space_Status_Type["USER"] = 1] = "USER";
236
357
  /**
358
+ * ORGANIZATION is a shared Space that can have several Members with
359
+ * different roles.
360
+ *
237
361
  * @generated from protobuf enum value: ORGANIZATION = 2;
238
362
  */
239
363
  Space_Status_Type[Space_Status_Type["ORGANIZATION"] = 2] = "ORGANIZATION";
240
364
  })(Space_Status_Type || (Space_Status_Type = {}));
241
365
  /**
366
+ * Mode is the relationship between the calling User and the listed Spaces
367
+ *
242
368
  * @generated from protobuf enum octelium.api.main.cordium.v1.ListSpaceOptions.Mode
243
369
  */
244
370
  export var ListSpaceOptions_Mode;
245
371
  (function (ListSpaceOptions_Mode) {
246
372
  /**
373
+ * MODE_UNSET falls back to MODE_CREATED_BY.
374
+ *
247
375
  * @generated from protobuf enum value: MODE_UNSET = 0;
248
376
  */
249
377
  ListSpaceOptions_Mode[ListSpaceOptions_Mode["UNSET"] = 0] = "UNSET";
250
378
  /**
379
+ * MODE_CREATED_BY lists only the Spaces that were created by the calling
380
+ * User.
381
+ *
251
382
  * @generated from protobuf enum value: MODE_CREATED_BY = 1;
252
383
  */
253
384
  ListSpaceOptions_Mode[ListSpaceOptions_Mode["CREATED_BY"] = 1] = "CREATED_BY";
254
385
  /**
386
+ * MODE_MEMBER lists the Spaces in which the calling User has a Membership.
387
+ *
255
388
  * @generated from protobuf enum value: MODE_MEMBER = 2;
256
389
  */
257
390
  ListSpaceOptions_Mode[ListSpaceOptions_Mode["MEMBER"] = 2] = "MEMBER";
258
391
  })(ListSpaceOptions_Mode || (ListSpaceOptions_Mode = {}));
259
392
  /**
393
+ * Role is the level of access that the Member has inside the Space
394
+ *
260
395
  * @generated from protobuf enum octelium.api.main.cordium.v1.Membership.Spec.Role
261
396
  */
262
397
  export var Membership_Spec_Role;
263
398
  (function (Membership_Spec_Role) {
264
399
  /**
400
+ * UNKNOWN is not used. It is treated as USER upon the creation of a
401
+ * Membership.
402
+ *
265
403
  * @generated from protobuf enum value: UNKNOWN = 0;
266
404
  */
267
405
  Membership_Spec_Role[Membership_Spec_Role["UNKNOWN"] = 0] = "UNKNOWN";
268
406
  /**
407
+ * OWNER has full control over the Space including deleting it and
408
+ * managing its Owners. Granting this Role requires the caller to be an
409
+ * OWNER themselves and requires the target User to be authorized to own
410
+ * Spaces by the ClusterConfig.
411
+ *
269
412
  * @generated from protobuf enum value: OWNER = 1;
270
413
  */
271
414
  Membership_Spec_Role[Membership_Spec_Role["OWNER"] = 1] = "OWNER";
272
415
  /**
416
+ * ADMIN can manage the Space's Templates, Secrets, GitProviders and
417
+ * Memberships.
418
+ *
273
419
  * @generated from protobuf enum value: ADMIN = 2;
274
420
  */
275
421
  Membership_Spec_Role[Membership_Spec_Role["ADMIN"] = 2] = "ADMIN";
276
422
  /**
423
+ * USER can use the Space (e.g. create Workspaces in it) but cannot
424
+ * manage it.
425
+ *
277
426
  * @generated from protobuf enum value: USER = 3;
278
427
  */
279
428
  Membership_Spec_Role[Membership_Spec_Role["USER"] = 3] = "USER";
280
429
  })(Membership_Spec_Role || (Membership_Spec_Role = {}));
281
430
  /**
431
+ * Role is the level of access that the new Member has inside the Space. It
432
+ * mirrors the Membership's own Role
433
+ *
282
434
  * @generated from protobuf enum octelium.api.main.cordium.v1.CreateMembershipRequest.Role
283
435
  */
284
436
  export var CreateMembershipRequest_Role;
285
437
  (function (CreateMembershipRequest_Role) {
286
438
  /**
439
+ * UNKNOWN is not used. It is treated as USER.
440
+ *
287
441
  * @generated from protobuf enum value: UNKNOWN = 0;
288
442
  */
289
443
  CreateMembershipRequest_Role[CreateMembershipRequest_Role["UNKNOWN"] = 0] = "UNKNOWN";
290
444
  /**
445
+ * OWNER has full control over the Space. Granting this Role requires the
446
+ * caller to be an OWNER themselves.
447
+ *
291
448
  * @generated from protobuf enum value: OWNER = 1;
292
449
  */
293
450
  CreateMembershipRequest_Role[CreateMembershipRequest_Role["OWNER"] = 1] = "OWNER";
294
451
  /**
452
+ * ADMIN can manage the Space's Templates, Secrets, GitProviders and
453
+ * Memberships.
454
+ *
295
455
  * @generated from protobuf enum value: ADMIN = 2;
296
456
  */
297
457
  CreateMembershipRequest_Role[CreateMembershipRequest_Role["ADMIN"] = 2] = "ADMIN";
298
458
  /**
459
+ * USER can use the Space but cannot manage it.
460
+ *
299
461
  * @generated from protobuf enum value: USER = 3;
300
462
  */
301
463
  CreateMembershipRequest_Role[CreateMembershipRequest_Role["USER"] = 3] = "USER";
302
464
  })(CreateMembershipRequest_Role || (CreateMembershipRequest_Role = {}));
303
465
  /**
466
+ * Type is the kind of the UserSecret's content
467
+ *
304
468
  * @generated from protobuf enum octelium.api.main.cordium.v1.UserSecret.Spec.Type
305
469
  */
306
470
  export var UserSecret_Spec_Type;
307
471
  (function (UserSecret_Spec_Type) {
308
472
  /**
473
+ * DEFAULT is an arbitrary value that is provided by the User.
474
+ *
309
475
  * @generated from protobuf enum value: DEFAULT = 0;
310
476
  */
311
477
  UserSecret_Spec_Type[UserSecret_Spec_Type["DEFAULT"] = 0] = "DEFAULT";
312
478
  /**
479
+ * SSH_KEY is an ECDSA key pair that is generated by the Cluster. The
480
+ * private key is stored as the UserSecret's data and it is automatically
481
+ * loaded into an SSH agent inside every Workspace of the User while the
482
+ * public key is exposed in the status.
483
+ *
313
484
  * @generated from protobuf enum value: SSH_KEY = 1;
314
485
  */
315
486
  UserSecret_Spec_Type[UserSecret_Spec_Type["SSH_KEY"] = 1] = "SSH_KEY";
316
487
  })(UserSecret_Spec_Type || (UserSecret_Spec_Type = {}));
317
488
  /**
489
+ * Mode is the audience with which the Application is shared. It mirrors the
490
+ * Workspace status' SharedPort mode
491
+ *
318
492
  * @generated from protobuf enum octelium.api.main.cordium.v1.ShareWorkspacePortRequest.Mode
319
493
  */
320
494
  export var ShareWorkspacePortRequest_Mode;
321
495
  (function (ShareWorkspacePortRequest_Mode) {
322
496
  /**
497
+ * UNSET is not used. A mode must be explicitly provided.
498
+ *
323
499
  * @generated from protobuf enum value: UNSET = 0;
324
500
  */
325
501
  ShareWorkspacePortRequest_Mode[ShareWorkspacePortRequest_Mode["UNSET"] = 0] = "UNSET";
326
502
  /**
503
+ * MEMBERS shares the Application with the Members of the Workspace's
504
+ * Space.
505
+ *
327
506
  * @generated from protobuf enum value: MEMBERS = 1;
328
507
  */
329
508
  ShareWorkspacePortRequest_Mode[ShareWorkspacePortRequest_Mode["MEMBERS"] = 1] = "MEMBERS";
330
509
  /**
510
+ * ALL shares the Application with all the Cluster's Users.
511
+ *
331
512
  * @generated from protobuf enum value: ALL = 2;
332
513
  */
333
514
  ShareWorkspacePortRequest_Mode[ShareWorkspacePortRequest_Mode["ALL"] = 2] = "ALL";
334
515
  })(ShareWorkspacePortRequest_Mode || (ShareWorkspacePortRequest_Mode = {}));
335
516
  /**
517
+ * Mode is the output stream that the log entry was emitted on
518
+ *
336
519
  * @generated from protobuf enum octelium.api.main.cordium.v1.ListenLogResponse.Mode
337
520
  */
338
521
  export var ListenLogResponse_Mode;
339
522
  (function (ListenLogResponse_Mode) {
340
523
  /**
524
+ * MODE_UNKNOWN is not used.
525
+ *
341
526
  * @generated from protobuf enum value: MODE_UNKNOWN = 0;
342
527
  */
343
528
  ListenLogResponse_Mode[ListenLogResponse_Mode["UNKNOWN"] = 0] = "UNKNOWN";
344
529
  /**
530
+ * MODE_STDOUT means that the entry was emitted on the standard output.
531
+ *
345
532
  * @generated from protobuf enum value: MODE_STDOUT = 1;
346
533
  */
347
534
  ListenLogResponse_Mode[ListenLogResponse_Mode["STDOUT"] = 1] = "STDOUT";
348
535
  /**
536
+ * MODE_STDERR means that the entry was emitted on the standard error.
537
+ *
349
538
  * @generated from protobuf enum value: MODE_STDERR = 2;
350
539
  */
351
540
  ListenLogResponse_Mode[ListenLogResponse_Mode["STDERR"] = 2] = "STDERR";
352
541
  })(ListenLogResponse_Mode || (ListenLogResponse_Mode = {}));
353
542
  /**
543
+ * Type is the initialization stage that produced the log entry
544
+ *
354
545
  * @generated from protobuf enum octelium.api.main.cordium.v1.ListenLogResponse.Type
355
546
  */
356
547
  export var ListenLogResponse_Type;
357
548
  (function (ListenLogResponse_Type) {
358
549
  /**
550
+ * TYPE_UNKNOWN is not used.
551
+ *
359
552
  * @generated from protobuf enum value: TYPE_UNKNOWN = 0;
360
553
  */
361
554
  ListenLogResponse_Type[ListenLogResponse_Type["UNKNOWN"] = 0] = "UNKNOWN";
362
555
  /**
556
+ * TYPE_CLONING_REPO means that the entry was produced while cloning a
557
+ * repository.
558
+ *
363
559
  * @generated from protobuf enum value: TYPE_CLONING_REPO = 1;
364
560
  */
365
561
  ListenLogResponse_Type[ListenLogResponse_Type["CLONING_REPO"] = 1] = "CLONING_REPO";
366
562
  /**
563
+ * TYPE_PULLING_IMAGE means that the entry was produced while pulling the
564
+ * container image.
565
+ *
367
566
  * @generated from protobuf enum value: TYPE_PULLING_IMAGE = 2;
368
567
  */
369
568
  ListenLogResponse_Type[ListenLogResponse_Type["PULLING_IMAGE"] = 2] = "PULLING_IMAGE";
370
569
  /**
570
+ * TYPE_BUILDING_IMAGE means that the entry was produced while building the
571
+ * container image.
572
+ *
371
573
  * @generated from protobuf enum value: TYPE_BUILDING_IMAGE = 3;
372
574
  */
373
575
  ListenLogResponse_Type[ListenLogResponse_Type["BUILDING_IMAGE"] = 3] = "BUILDING_IMAGE";
374
576
  /**
577
+ * TYPE_TASK means that the entry was produced by a lifecycle task.
578
+ *
375
579
  * @generated from protobuf enum value: TYPE_TASK = 4;
376
580
  */
377
581
  ListenLogResponse_Type[ListenLogResponse_Type["TASK"] = 4] = "TASK";
378
582
  })(ListenLogResponse_Type || (ListenLogResponse_Type = {}));
379
583
  /**
584
+ * Effect is the effect of the Rule when its Condition matches
585
+ *
380
586
  * @generated from protobuf enum octelium.api.main.cordium.v1.ClusterConfig.Spec.Space.Ownership.Rule.Effect
381
587
  */
382
588
  export var ClusterConfig_Spec_Space_Ownership_Rule_Effect;