@metal-stack/api 0.4.4 → 0.5.2

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 (151) hide show
  1. package/{js/Makefile → Makefile} +5 -2
  2. package/bun.lock +74 -0
  3. package/client-test.d.ts +1 -0
  4. package/client-test.js +45 -0
  5. package/client-test.ts +49 -0
  6. package/client.d.ts +97 -0
  7. package/client.js +347 -0
  8. package/client.ts +662 -0
  9. package/{js/metalstack → metalstack}/admin/v2/audit_pb.d.ts +5 -5
  10. package/{js/metalstack → metalstack}/admin/v2/audit_pb.ts +5 -5
  11. package/{js/metalstack → metalstack}/admin/v2/component_pb.d.ts +6 -6
  12. package/{js/metalstack → metalstack}/admin/v2/component_pb.ts +6 -6
  13. package/{js/metalstack → metalstack}/admin/v2/filesystem_pb.d.ts +28 -28
  14. package/{js/metalstack → metalstack}/admin/v2/filesystem_pb.ts +28 -28
  15. package/{js/metalstack → metalstack}/admin/v2/image_pb.d.ts +16 -16
  16. package/{js/metalstack → metalstack}/admin/v2/image_pb.ts +16 -16
  17. package/{js/metalstack → metalstack}/admin/v2/ip_pb.d.ts +2 -2
  18. package/{js/metalstack → metalstack}/admin/v2/ip_pb.ts +2 -2
  19. package/{js/metalstack → metalstack}/admin/v2/machine_pb.d.ts +47 -55
  20. package/{js/metalstack → metalstack}/admin/v2/machine_pb.js +1 -1
  21. package/{js/metalstack → metalstack}/admin/v2/machine_pb.ts +48 -55
  22. package/{js/metalstack → metalstack}/admin/v2/network_pb.d.ts +195 -37
  23. package/{js/metalstack → metalstack}/admin/v2/network_pb.js +36 -5
  24. package/{js/metalstack → metalstack}/admin/v2/network_pb.ts +222 -42
  25. package/{js/metalstack → metalstack}/admin/v2/partition_pb.d.ts +26 -26
  26. package/{js/metalstack → metalstack}/admin/v2/partition_pb.ts +26 -26
  27. package/{js/metalstack → metalstack}/admin/v2/project_pb.d.ts +2 -2
  28. package/{js/metalstack → metalstack}/admin/v2/project_pb.ts +2 -2
  29. package/{js/metalstack → metalstack}/admin/v2/size_imageconstraint_pb.d.ts +18 -18
  30. package/{js/metalstack → metalstack}/admin/v2/size_imageconstraint_pb.ts +18 -18
  31. package/{js/metalstack → metalstack}/admin/v2/size_pb.d.ts +11 -11
  32. package/{js/metalstack → metalstack}/admin/v2/size_pb.ts +11 -11
  33. package/{js/metalstack → metalstack}/admin/v2/size_reservation_pb.d.ts +14 -14
  34. package/{js/metalstack → metalstack}/admin/v2/size_reservation_pb.ts +14 -14
  35. package/{js/metalstack → metalstack}/admin/v2/switch_pb.d.ts +29 -29
  36. package/{js/metalstack → metalstack}/admin/v2/switch_pb.ts +29 -29
  37. package/{js/metalstack → metalstack}/admin/v2/task_pb.d.ts +47 -47
  38. package/{js/metalstack → metalstack}/admin/v2/task_pb.js +8 -8
  39. package/{js/metalstack → metalstack}/admin/v2/task_pb.ts +47 -47
  40. package/{js/metalstack → metalstack}/admin/v2/tenant_pb.d.ts +22 -22
  41. package/{js/metalstack → metalstack}/admin/v2/tenant_pb.ts +22 -22
  42. package/{js/metalstack → metalstack}/admin/v2/token_pb.d.ts +8 -8
  43. package/{js/metalstack → metalstack}/admin/v2/token_pb.ts +8 -8
  44. package/{js/metalstack → metalstack}/admin/v2/vpn_pb.d.ts +13 -13
  45. package/{js/metalstack → metalstack}/admin/v2/vpn_pb.ts +13 -13
  46. package/{js/metalstack → metalstack}/api/v2/audit_pb.d.ts +37 -37
  47. package/{js/metalstack → metalstack}/api/v2/audit_pb.js +3 -3
  48. package/{js/metalstack → metalstack}/api/v2/audit_pb.ts +37 -37
  49. package/{js/metalstack → metalstack}/api/v2/common_pb.d.ts +68 -68
  50. package/{js/metalstack → metalstack}/api/v2/common_pb.js +47 -47
  51. package/{js/metalstack → metalstack}/api/v2/common_pb.ts +68 -68
  52. package/{js/metalstack → metalstack}/api/v2/component_pb.d.ts +17 -17
  53. package/{js/metalstack → metalstack}/api/v2/component_pb.js +8 -8
  54. package/{js/metalstack → metalstack}/api/v2/component_pb.ts +17 -17
  55. package/{js/metalstack → metalstack}/api/v2/filesystem_pb.d.ts +82 -82
  56. package/{js/metalstack → metalstack}/api/v2/filesystem_pb.js +23 -23
  57. package/{js/metalstack → metalstack}/api/v2/filesystem_pb.ts +82 -82
  58. package/{js/metalstack → metalstack}/api/v2/health_pb.d.ts +21 -21
  59. package/{js/metalstack → metalstack}/api/v2/health_pb.js +13 -13
  60. package/{js/metalstack → metalstack}/api/v2/health_pb.ts +21 -21
  61. package/{js/metalstack → metalstack}/api/v2/image_pb.d.ts +45 -45
  62. package/{js/metalstack → metalstack}/api/v2/image_pb.js +9 -9
  63. package/{js/metalstack → metalstack}/api/v2/image_pb.ts +45 -45
  64. package/{js/metalstack → metalstack}/api/v2/ip_pb.d.ts +67 -67
  65. package/{js/metalstack → metalstack}/api/v2/ip_pb.js +8 -8
  66. package/{js/metalstack → metalstack}/api/v2/ip_pb.ts +67 -67
  67. package/{js/metalstack → metalstack}/api/v2/machine_pb.d.ts +422 -374
  68. package/{js/metalstack → metalstack}/api/v2/machine_pb.js +94 -89
  69. package/{js/metalstack → metalstack}/api/v2/machine_pb.ts +453 -396
  70. package/{js/metalstack → metalstack}/api/v2/method_pb.d.ts +7 -7
  71. package/{js/metalstack → metalstack}/api/v2/method_pb.ts +7 -7
  72. package/{js/metalstack → metalstack}/api/v2/network_pb.d.ts +146 -98
  73. package/{js/metalstack → metalstack}/api/v2/network_pb.js +30 -20
  74. package/{js/metalstack → metalstack}/api/v2/network_pb.ts +158 -102
  75. package/{js/metalstack → metalstack}/api/v2/partition_pb.d.ts +28 -28
  76. package/{js/metalstack → metalstack}/api/v2/partition_pb.ts +28 -28
  77. package/{js/metalstack → metalstack}/api/v2/predefined_rules_pb.d.ts +30 -24
  78. package/{js/metalstack → metalstack}/api/v2/predefined_rules_pb.js +40 -34
  79. package/{js/metalstack → metalstack}/api/v2/predefined_rules_pb.ts +42 -34
  80. package/{js/metalstack → metalstack}/api/v2/project_pb.d.ts +114 -114
  81. package/{js/metalstack → metalstack}/api/v2/project_pb.ts +114 -114
  82. package/{js/metalstack → metalstack}/api/v2/size_imageconstraint_pb.d.ts +21 -22
  83. package/{js/metalstack → metalstack}/api/v2/size_imageconstraint_pb.ts +21 -22
  84. package/{js/metalstack → metalstack}/api/v2/size_pb.d.ts +29 -29
  85. package/{js/metalstack → metalstack}/api/v2/size_pb.js +6 -6
  86. package/{js/metalstack → metalstack}/api/v2/size_pb.ts +29 -29
  87. package/{js/metalstack → metalstack}/api/v2/size_reservation_pb.d.ts +27 -27
  88. package/{js/metalstack → metalstack}/api/v2/size_reservation_pb.ts +27 -27
  89. package/{js/metalstack → metalstack}/api/v2/switch_pb.d.ts +8 -8
  90. package/{js/metalstack → metalstack}/api/v2/switch_pb.js +1 -1
  91. package/{js/metalstack → metalstack}/api/v2/switch_pb.ts +9 -9
  92. package/{js/metalstack → metalstack}/api/v2/tenant_pb.d.ts +114 -116
  93. package/{js/metalstack → metalstack}/api/v2/tenant_pb.ts +114 -116
  94. package/{js/metalstack → metalstack}/api/v2/token_pb.d.ts +103 -103
  95. package/{js/metalstack → metalstack}/api/v2/token_pb.js +3 -3
  96. package/{js/metalstack → metalstack}/api/v2/token_pb.ts +103 -103
  97. package/{js/metalstack → metalstack}/api/v2/user_pb.d.ts +8 -8
  98. package/{js/metalstack → metalstack}/api/v2/user_pb.ts +8 -8
  99. package/{js/metalstack → metalstack}/api/v2/version_pb.d.ts +5 -5
  100. package/{js/metalstack → metalstack}/api/v2/version_pb.ts +5 -5
  101. package/{js/metalstack → metalstack}/api/v2/vpn_pb.d.ts +6 -6
  102. package/{js/metalstack → metalstack}/api/v2/vpn_pb.ts +6 -6
  103. package/{js/metalstack → metalstack}/infra/v2/bmc_pb.d.ts +15 -17
  104. package/{js/metalstack → metalstack}/infra/v2/bmc_pb.js +1 -1
  105. package/{js/metalstack → metalstack}/infra/v2/bmc_pb.ts +16 -16
  106. package/{js/metalstack → metalstack}/infra/v2/boot_pb.d.ts +36 -36
  107. package/{js/metalstack → metalstack}/infra/v2/boot_pb.ts +36 -36
  108. package/{js/metalstack → metalstack}/infra/v2/component_pb.d.ts +5 -5
  109. package/{js/metalstack → metalstack}/infra/v2/component_pb.ts +5 -5
  110. package/{js/metalstack → metalstack}/infra/v2/event_pb.d.ts +3 -3
  111. package/{js/metalstack → metalstack}/infra/v2/event_pb.ts +3 -3
  112. package/{js/metalstack → metalstack}/infra/v2/switch_pb.d.ts +12 -12
  113. package/{js/metalstack → metalstack}/infra/v2/switch_pb.ts +12 -12
  114. package/package.json +4 -3
  115. package/test-interceptor.d.ts +9 -0
  116. package/test-interceptor.js +33 -0
  117. package/test-interceptor.ts +49 -0
  118. package/tsconfig.json +14 -0
  119. package/LICENSE +0 -21
  120. package/README.md +0 -117
  121. package/js/tsconfig.json +0 -70
  122. /package/{js/buf → buf}/validate/validate_pb.d.ts +0 -0
  123. /package/{js/buf → buf}/validate/validate_pb.js +0 -0
  124. /package/{js/buf → buf}/validate/validate_pb.ts +0 -0
  125. /package/{js/metalstack → metalstack}/admin/v2/audit_pb.js +0 -0
  126. /package/{js/metalstack → metalstack}/admin/v2/component_pb.js +0 -0
  127. /package/{js/metalstack → metalstack}/admin/v2/filesystem_pb.js +0 -0
  128. /package/{js/metalstack → metalstack}/admin/v2/image_pb.js +0 -0
  129. /package/{js/metalstack → metalstack}/admin/v2/ip_pb.js +0 -0
  130. /package/{js/metalstack → metalstack}/admin/v2/partition_pb.js +0 -0
  131. /package/{js/metalstack → metalstack}/admin/v2/project_pb.js +0 -0
  132. /package/{js/metalstack → metalstack}/admin/v2/size_imageconstraint_pb.js +0 -0
  133. /package/{js/metalstack → metalstack}/admin/v2/size_pb.js +0 -0
  134. /package/{js/metalstack → metalstack}/admin/v2/size_reservation_pb.js +0 -0
  135. /package/{js/metalstack → metalstack}/admin/v2/switch_pb.js +0 -0
  136. /package/{js/metalstack → metalstack}/admin/v2/tenant_pb.js +0 -0
  137. /package/{js/metalstack → metalstack}/admin/v2/token_pb.js +0 -0
  138. /package/{js/metalstack → metalstack}/admin/v2/vpn_pb.js +0 -0
  139. /package/{js/metalstack → metalstack}/api/v2/method_pb.js +0 -0
  140. /package/{js/metalstack → metalstack}/api/v2/partition_pb.js +0 -0
  141. /package/{js/metalstack → metalstack}/api/v2/project_pb.js +0 -0
  142. /package/{js/metalstack → metalstack}/api/v2/size_imageconstraint_pb.js +0 -0
  143. /package/{js/metalstack → metalstack}/api/v2/size_reservation_pb.js +0 -0
  144. /package/{js/metalstack → metalstack}/api/v2/tenant_pb.js +0 -0
  145. /package/{js/metalstack → metalstack}/api/v2/user_pb.js +0 -0
  146. /package/{js/metalstack → metalstack}/api/v2/version_pb.js +0 -0
  147. /package/{js/metalstack → metalstack}/api/v2/vpn_pb.js +0 -0
  148. /package/{js/metalstack → metalstack}/infra/v2/boot_pb.js +0 -0
  149. /package/{js/metalstack → metalstack}/infra/v2/component_pb.js +0 -0
  150. /package/{js/metalstack → metalstack}/infra/v2/event_pb.js +0 -0
  151. /package/{js/metalstack → metalstack}/infra/v2/switch_pb.js +0 -0
@@ -12,13 +12,13 @@ export declare const file_metalstack_admin_v2_task: GenFile;
12
12
  */
13
13
  export type TaskServiceGetRequest = Message<"metalstack.admin.v2.TaskServiceGetRequest"> & {
14
14
  /**
15
- * TaskId is the identifier of the task to get
15
+ * TaskId is the identifier of the task to get.
16
16
  *
17
17
  * @generated from field: string task_id = 1;
18
18
  */
19
19
  taskId: string;
20
20
  /**
21
- * Queue is the queue where this task was scheduled to
21
+ * Queue is the queue where this task was scheduled to.
22
22
  *
23
23
  * @generated from field: string queue = 2;
24
24
  */
@@ -36,7 +36,7 @@ export declare const TaskServiceGetRequestSchema: GenMessage<TaskServiceGetReque
36
36
  */
37
37
  export type TaskServiceGetResponse = Message<"metalstack.admin.v2.TaskServiceGetResponse"> & {
38
38
  /**
39
- * Task contains the task details
39
+ * Task contains the task details.
40
40
  *
41
41
  * @generated from field: metalstack.admin.v2.TaskInfo task = 1;
42
42
  */
@@ -54,13 +54,13 @@ export declare const TaskServiceGetResponseSchema: GenMessage<TaskServiceGetResp
54
54
  */
55
55
  export type TaskServiceDeleteRequest = Message<"metalstack.admin.v2.TaskServiceDeleteRequest"> & {
56
56
  /**
57
- * TaskId is the identifier of the task to cancel
57
+ * TaskId is the identifier of the task to cancel.
58
58
  *
59
59
  * @generated from field: string task_id = 1;
60
60
  */
61
61
  taskId: string;
62
62
  /**
63
- * Queue is the queue where this task was scheduled to
63
+ * Queue is the queue where this task was scheduled to.
64
64
  *
65
65
  * @generated from field: string queue = 2;
66
66
  */
@@ -100,7 +100,7 @@ export declare const TaskServiceQueuesRequestSchema: GenMessage<TaskServiceQueue
100
100
  */
101
101
  export type TaskServiceQueuesResponse = Message<"metalstack.admin.v2.TaskServiceQueuesResponse"> & {
102
102
  /**
103
- * Queues configured for the async system
103
+ * Queues configured for the async system.
104
104
  *
105
105
  * @generated from field: repeated string queues = 1;
106
106
  */
@@ -118,20 +118,20 @@ export declare const TaskServiceQueuesResponseSchema: GenMessage<TaskServiceQueu
118
118
  */
119
119
  export type TaskServiceListRequest = Message<"metalstack.admin.v2.TaskServiceListRequest"> & {
120
120
  /**
121
- * Queue filters tasks by this queue
122
- * Will return tasks from all queues if not specified
121
+ * Queue filters tasks by this queue.
122
+ * Will return tasks from all queues if not specified.
123
123
  *
124
124
  * @generated from field: optional string queue = 1;
125
125
  */
126
126
  queue?: string | undefined;
127
127
  /**
128
- * Count is the number of tasks to return
128
+ * Count is the number of tasks to return.
129
129
  *
130
130
  * @generated from field: optional uint32 count = 2;
131
131
  */
132
132
  count?: number | undefined;
133
133
  /**
134
- * Page is the page of tasks to return
134
+ * Page is the page of tasks to return.
135
135
  *
136
136
  * @generated from field: optional uint32 page = 3;
137
137
  */
@@ -149,7 +149,7 @@ export declare const TaskServiceListRequestSchema: GenMessage<TaskServiceListReq
149
149
  */
150
150
  export type TaskServiceListResponse = Message<"metalstack.admin.v2.TaskServiceListResponse"> & {
151
151
  /**
152
- * Tasks contains the list of requested tasks
152
+ * Tasks contains the list of requested tasks.
153
153
  *
154
154
  * @generated from field: repeated metalstack.admin.v2.TaskInfo tasks = 1;
155
155
  */
@@ -167,117 +167,117 @@ export declare const TaskServiceListResponseSchema: GenMessage<TaskServiceListRe
167
167
  */
168
168
  export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & {
169
169
  /**
170
- * ID is the identifier of the task
170
+ * ID is the identifier of the task.
171
171
  *
172
172
  * @generated from field: string id = 1;
173
173
  */
174
174
  id: string;
175
175
  /**
176
- * Queue is the name of the queue in which the task belongs
176
+ * Queue is the name of the queue in which the task belongs.
177
177
  *
178
178
  * @generated from field: string queue = 2;
179
179
  */
180
180
  queue: string;
181
181
  /**
182
- * Type is the type name of the task
182
+ * Type is the type name of the task.
183
183
  *
184
184
  * @generated from field: string type = 3;
185
185
  */
186
186
  type: string;
187
187
  /**
188
- * Payload is the payload data of the task
188
+ * Payload is the payload data of the task.
189
189
  *
190
190
  * @generated from field: bytes payload = 4;
191
191
  */
192
192
  payload: Uint8Array;
193
193
  /**
194
- * State indicates the task state
194
+ * State indicates the task state.
195
195
  *
196
196
  * @generated from field: metalstack.admin.v2.TaskState state = 5;
197
197
  */
198
198
  state: TaskState;
199
199
  /**
200
- * MaxRetry is the maximum number of times the task can be retried
200
+ * MaxRetry is the maximum number of times the task can be retried.
201
201
  *
202
202
  * @generated from field: int32 max_retry = 6;
203
203
  */
204
204
  maxRetry: number;
205
205
  /**
206
- * Retried is the number of times the task has retried so far
206
+ * Retried is the number of times the task has retried so far.
207
207
  *
208
208
  * @generated from field: int32 retried = 7;
209
209
  */
210
210
  retried: number;
211
211
  /**
212
- * LastError is the error message from the last failure
212
+ * LastError is the error message from the last failure.
213
213
  *
214
214
  * @generated from field: string last_error = 8;
215
215
  */
216
216
  lastError: string;
217
217
  /**
218
- * LastFailedAt is the time of the last failure if any
219
- * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{})
218
+ * LastFailedAt is the time of the last failure if any.
219
+ * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}).
220
220
  *
221
221
  * @generated from field: google.protobuf.Timestamp last_failed_at = 9;
222
222
  */
223
223
  lastFailedAt?: Timestamp | undefined;
224
224
  /**
225
- * Timeout is the duration the task can be processed by Handler before being retried
225
+ * Timeout is the duration the task can be processed by Handler before being retried.
226
226
  *
227
227
  * @generated from field: google.protobuf.Duration timeout = 10;
228
228
  */
229
229
  timeout?: Duration | undefined;
230
230
  /**
231
- * Deadline is the deadline for the task
231
+ * Deadline is the deadline for the task.
232
232
  *
233
233
  * @generated from field: google.protobuf.Timestamp deadline = 11;
234
234
  */
235
235
  deadline?: Timestamp | undefined;
236
236
  /**
237
- * Group is the name of the group in which the task belongs
237
+ * Group is the name of the group in which the task belongs.
238
238
  *
239
- * Tasks in the same queue can be grouped together by Group name and will be aggregated into one task
240
- * by a Server processing the queue
239
+ * Tasks in the same queue can be grouped together by Group name and will be aggregated into one task.
240
+ * by a Server processing the queue.
241
241
  *
242
- * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task
242
+ * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task.
243
243
  *
244
244
  * @generated from field: string group = 12;
245
245
  */
246
246
  group: string;
247
247
  /**
248
- * NextProcessAt is the time the task is scheduled to be processed
249
- * Zero if not applicable
248
+ * NextProcessAt is the time the task is scheduled to be processed.
249
+ * Zero if not applicable.
250
250
  *
251
251
  * @generated from field: google.protobuf.Timestamp next_process_at = 13;
252
252
  */
253
253
  nextProcessAt?: Timestamp | undefined;
254
254
  /**
255
- * IsOrphaned describes whether the task is left in active state with no worker processing it
256
- * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to
257
- * extend its lease on the task
255
+ * IsOrphaned describes whether the task is left in active state with no worker processing it.
256
+ * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to.
257
+ * extend its lease on the task.
258
258
  *
259
- * This task will be recovered by running a server against the queue the task is in
260
- * This field is only applicable to tasks with TaskStateActive
259
+ * This task will be recovered by running a server against the queue the task is in.
260
+ * This field is only applicable to tasks with TaskStateActive.
261
261
  *
262
262
  * @generated from field: bool is_orphaned = 14;
263
263
  */
264
264
  isOrphaned: boolean;
265
265
  /**
266
- * Retention is duration of the retention period after the task is successfully processed
266
+ * Retention is duration of the retention period after the task is successfully processed.
267
267
  *
268
268
  * @generated from field: google.protobuf.Duration retention = 15;
269
269
  */
270
270
  retention?: Duration | undefined;
271
271
  /**
272
- * CompletedAt is the time when the task is processed successfully
273
- * Zero value (i.e. time.Time{}) indicates no value
272
+ * CompletedAt is the time when the task is processed successfully.
273
+ * Zero value (i.e. time.Time{}) indicates no value.
274
274
  *
275
275
  * @generated from field: google.protobuf.Timestamp completed_at = 16;
276
276
  */
277
277
  completedAt?: Timestamp | undefined;
278
278
  /**
279
- * Result holds the result data associated with the task
280
- * Use ResultWriter to write result data from the Handler
279
+ * Result holds the result data associated with the task.
280
+ * Use ResultWriter to write result data from the Handler.
281
281
  *
282
282
  * @generated from field: bytes result = 17;
283
283
  */
@@ -295,49 +295,49 @@ export declare const TaskInfoSchema: GenMessage<TaskInfo>;
295
295
  */
296
296
  export declare enum TaskState {
297
297
  /**
298
- * TASK_STATE_UNSPECIFIED is not specified
298
+ * TASK_STATE_UNSPECIFIED is not specified.
299
299
  *
300
300
  * @generated from enum value: TASK_STATE_UNSPECIFIED = 0;
301
301
  */
302
302
  UNSPECIFIED = 0,
303
303
  /**
304
- * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler
304
+ * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler.
305
305
  *
306
306
  * @generated from enum value: TASK_STATE_ACTIVE = 1;
307
307
  */
308
308
  ACTIVE = 1,
309
309
  /**
310
- * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler
310
+ * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler.
311
311
  *
312
312
  * @generated from enum value: TASK_STATE_PENDING = 2;
313
313
  */
314
314
  PENDING = 2,
315
315
  /**
316
- * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future
316
+ * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future.
317
317
  *
318
318
  * @generated from enum value: TASK_STATE_SCHEDULED = 3;
319
319
  */
320
320
  SCHEDULED = 3,
321
321
  /**
322
- * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future
322
+ * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future.
323
323
  *
324
324
  * @generated from enum value: TASK_STATE_RETRY = 4;
325
325
  */
326
326
  RETRY = 4,
327
327
  /**
328
- * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes
328
+ * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes.
329
329
  *
330
330
  * @generated from enum value: TASK_STATE_ARCHIVED = 5;
331
331
  */
332
332
  ARCHIVED = 5,
333
333
  /**
334
- * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires
334
+ * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires.
335
335
  *
336
336
  * @generated from enum value: TASK_STATE_COMPLETED = 6;
337
337
  */
338
338
  COMPLETED = 6,
339
339
  /**
340
- * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task
340
+ * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task.
341
341
  *
342
342
  * @generated from enum value: TASK_STATE_AGGREGATING = 7;
343
343
  */
@@ -61,49 +61,49 @@ export const TaskInfoSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2
61
61
  export var TaskState;
62
62
  (function (TaskState) {
63
63
  /**
64
- * TASK_STATE_UNSPECIFIED is not specified
64
+ * TASK_STATE_UNSPECIFIED is not specified.
65
65
  *
66
66
  * @generated from enum value: TASK_STATE_UNSPECIFIED = 0;
67
67
  */
68
68
  TaskState[TaskState["UNSPECIFIED"] = 0] = "UNSPECIFIED";
69
69
  /**
70
- * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler
70
+ * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler.
71
71
  *
72
72
  * @generated from enum value: TASK_STATE_ACTIVE = 1;
73
73
  */
74
74
  TaskState[TaskState["ACTIVE"] = 1] = "ACTIVE";
75
75
  /**
76
- * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler
76
+ * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler.
77
77
  *
78
78
  * @generated from enum value: TASK_STATE_PENDING = 2;
79
79
  */
80
80
  TaskState[TaskState["PENDING"] = 2] = "PENDING";
81
81
  /**
82
- * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future
82
+ * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future.
83
83
  *
84
84
  * @generated from enum value: TASK_STATE_SCHEDULED = 3;
85
85
  */
86
86
  TaskState[TaskState["SCHEDULED"] = 3] = "SCHEDULED";
87
87
  /**
88
- * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future
88
+ * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future.
89
89
  *
90
90
  * @generated from enum value: TASK_STATE_RETRY = 4;
91
91
  */
92
92
  TaskState[TaskState["RETRY"] = 4] = "RETRY";
93
93
  /**
94
- * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes
94
+ * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes.
95
95
  *
96
96
  * @generated from enum value: TASK_STATE_ARCHIVED = 5;
97
97
  */
98
98
  TaskState[TaskState["ARCHIVED"] = 5] = "ARCHIVED";
99
99
  /**
100
- * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires
100
+ * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires.
101
101
  *
102
102
  * @generated from enum value: TASK_STATE_COMPLETED = 6;
103
103
  */
104
104
  TaskState[TaskState["COMPLETED"] = 6] = "COMPLETED";
105
105
  /**
106
- * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task
106
+ * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task.
107
107
  *
108
108
  * @generated from enum value: TASK_STATE_AGGREGATING = 7;
109
109
  */
@@ -22,14 +22,14 @@ export const file_metalstack_admin_v2_task: GenFile = /*@__PURE__*/
22
22
  */
23
23
  export type TaskServiceGetRequest = Message<"metalstack.admin.v2.TaskServiceGetRequest"> & {
24
24
  /**
25
- * TaskId is the identifier of the task to get
25
+ * TaskId is the identifier of the task to get.
26
26
  *
27
27
  * @generated from field: string task_id = 1;
28
28
  */
29
29
  taskId: string;
30
30
 
31
31
  /**
32
- * Queue is the queue where this task was scheduled to
32
+ * Queue is the queue where this task was scheduled to.
33
33
  *
34
34
  * @generated from field: string queue = 2;
35
35
  */
@@ -50,7 +50,7 @@ export const TaskServiceGetRequestSchema: GenMessage<TaskServiceGetRequest> = /*
50
50
  */
51
51
  export type TaskServiceGetResponse = Message<"metalstack.admin.v2.TaskServiceGetResponse"> & {
52
52
  /**
53
- * Task contains the task details
53
+ * Task contains the task details.
54
54
  *
55
55
  * @generated from field: metalstack.admin.v2.TaskInfo task = 1;
56
56
  */
@@ -71,14 +71,14 @@ export const TaskServiceGetResponseSchema: GenMessage<TaskServiceGetResponse> =
71
71
  */
72
72
  export type TaskServiceDeleteRequest = Message<"metalstack.admin.v2.TaskServiceDeleteRequest"> & {
73
73
  /**
74
- * TaskId is the identifier of the task to cancel
74
+ * TaskId is the identifier of the task to cancel.
75
75
  *
76
76
  * @generated from field: string task_id = 1;
77
77
  */
78
78
  taskId: string;
79
79
 
80
80
  /**
81
- * Queue is the queue where this task was scheduled to
81
+ * Queue is the queue where this task was scheduled to.
82
82
  *
83
83
  * @generated from field: string queue = 2;
84
84
  */
@@ -129,7 +129,7 @@ export const TaskServiceQueuesRequestSchema: GenMessage<TaskServiceQueuesRequest
129
129
  */
130
130
  export type TaskServiceQueuesResponse = Message<"metalstack.admin.v2.TaskServiceQueuesResponse"> & {
131
131
  /**
132
- * Queues configured for the async system
132
+ * Queues configured for the async system.
133
133
  *
134
134
  * @generated from field: repeated string queues = 1;
135
135
  */
@@ -150,22 +150,22 @@ export const TaskServiceQueuesResponseSchema: GenMessage<TaskServiceQueuesRespon
150
150
  */
151
151
  export type TaskServiceListRequest = Message<"metalstack.admin.v2.TaskServiceListRequest"> & {
152
152
  /**
153
- * Queue filters tasks by this queue
154
- * Will return tasks from all queues if not specified
153
+ * Queue filters tasks by this queue.
154
+ * Will return tasks from all queues if not specified.
155
155
  *
156
156
  * @generated from field: optional string queue = 1;
157
157
  */
158
158
  queue?: string | undefined;
159
159
 
160
160
  /**
161
- * Count is the number of tasks to return
161
+ * Count is the number of tasks to return.
162
162
  *
163
163
  * @generated from field: optional uint32 count = 2;
164
164
  */
165
165
  count?: number | undefined;
166
166
 
167
167
  /**
168
- * Page is the page of tasks to return
168
+ * Page is the page of tasks to return.
169
169
  *
170
170
  * @generated from field: optional uint32 page = 3;
171
171
  */
@@ -186,7 +186,7 @@ export const TaskServiceListRequestSchema: GenMessage<TaskServiceListRequest> =
186
186
  */
187
187
  export type TaskServiceListResponse = Message<"metalstack.admin.v2.TaskServiceListResponse"> & {
188
188
  /**
189
- * Tasks contains the list of requested tasks
189
+ * Tasks contains the list of requested tasks.
190
190
  *
191
191
  * @generated from field: repeated metalstack.admin.v2.TaskInfo tasks = 1;
192
192
  */
@@ -207,133 +207,133 @@ export const TaskServiceListResponseSchema: GenMessage<TaskServiceListResponse>
207
207
  */
208
208
  export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & {
209
209
  /**
210
- * ID is the identifier of the task
210
+ * ID is the identifier of the task.
211
211
  *
212
212
  * @generated from field: string id = 1;
213
213
  */
214
214
  id: string;
215
215
 
216
216
  /**
217
- * Queue is the name of the queue in which the task belongs
217
+ * Queue is the name of the queue in which the task belongs.
218
218
  *
219
219
  * @generated from field: string queue = 2;
220
220
  */
221
221
  queue: string;
222
222
 
223
223
  /**
224
- * Type is the type name of the task
224
+ * Type is the type name of the task.
225
225
  *
226
226
  * @generated from field: string type = 3;
227
227
  */
228
228
  type: string;
229
229
 
230
230
  /**
231
- * Payload is the payload data of the task
231
+ * Payload is the payload data of the task.
232
232
  *
233
233
  * @generated from field: bytes payload = 4;
234
234
  */
235
235
  payload: Uint8Array;
236
236
 
237
237
  /**
238
- * State indicates the task state
238
+ * State indicates the task state.
239
239
  *
240
240
  * @generated from field: metalstack.admin.v2.TaskState state = 5;
241
241
  */
242
242
  state: TaskState;
243
243
 
244
244
  /**
245
- * MaxRetry is the maximum number of times the task can be retried
245
+ * MaxRetry is the maximum number of times the task can be retried.
246
246
  *
247
247
  * @generated from field: int32 max_retry = 6;
248
248
  */
249
249
  maxRetry: number;
250
250
 
251
251
  /**
252
- * Retried is the number of times the task has retried so far
252
+ * Retried is the number of times the task has retried so far.
253
253
  *
254
254
  * @generated from field: int32 retried = 7;
255
255
  */
256
256
  retried: number;
257
257
 
258
258
  /**
259
- * LastError is the error message from the last failure
259
+ * LastError is the error message from the last failure.
260
260
  *
261
261
  * @generated from field: string last_error = 8;
262
262
  */
263
263
  lastError: string;
264
264
 
265
265
  /**
266
- * LastFailedAt is the time of the last failure if any
267
- * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{})
266
+ * LastFailedAt is the time of the last failure if any.
267
+ * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}).
268
268
  *
269
269
  * @generated from field: google.protobuf.Timestamp last_failed_at = 9;
270
270
  */
271
271
  lastFailedAt?: Timestamp | undefined;
272
272
 
273
273
  /**
274
- * Timeout is the duration the task can be processed by Handler before being retried
274
+ * Timeout is the duration the task can be processed by Handler before being retried.
275
275
  *
276
276
  * @generated from field: google.protobuf.Duration timeout = 10;
277
277
  */
278
278
  timeout?: Duration | undefined;
279
279
 
280
280
  /**
281
- * Deadline is the deadline for the task
281
+ * Deadline is the deadline for the task.
282
282
  *
283
283
  * @generated from field: google.protobuf.Timestamp deadline = 11;
284
284
  */
285
285
  deadline?: Timestamp | undefined;
286
286
 
287
287
  /**
288
- * Group is the name of the group in which the task belongs
288
+ * Group is the name of the group in which the task belongs.
289
289
  *
290
- * Tasks in the same queue can be grouped together by Group name and will be aggregated into one task
291
- * by a Server processing the queue
290
+ * Tasks in the same queue can be grouped together by Group name and will be aggregated into one task.
291
+ * by a Server processing the queue.
292
292
  *
293
- * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task
293
+ * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task.
294
294
  *
295
295
  * @generated from field: string group = 12;
296
296
  */
297
297
  group: string;
298
298
 
299
299
  /**
300
- * NextProcessAt is the time the task is scheduled to be processed
301
- * Zero if not applicable
300
+ * NextProcessAt is the time the task is scheduled to be processed.
301
+ * Zero if not applicable.
302
302
  *
303
303
  * @generated from field: google.protobuf.Timestamp next_process_at = 13;
304
304
  */
305
305
  nextProcessAt?: Timestamp | undefined;
306
306
 
307
307
  /**
308
- * IsOrphaned describes whether the task is left in active state with no worker processing it
309
- * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to
310
- * extend its lease on the task
308
+ * IsOrphaned describes whether the task is left in active state with no worker processing it.
309
+ * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to.
310
+ * extend its lease on the task.
311
311
  *
312
- * This task will be recovered by running a server against the queue the task is in
313
- * This field is only applicable to tasks with TaskStateActive
312
+ * This task will be recovered by running a server against the queue the task is in.
313
+ * This field is only applicable to tasks with TaskStateActive.
314
314
  *
315
315
  * @generated from field: bool is_orphaned = 14;
316
316
  */
317
317
  isOrphaned: boolean;
318
318
 
319
319
  /**
320
- * Retention is duration of the retention period after the task is successfully processed
320
+ * Retention is duration of the retention period after the task is successfully processed.
321
321
  *
322
322
  * @generated from field: google.protobuf.Duration retention = 15;
323
323
  */
324
324
  retention?: Duration | undefined;
325
325
 
326
326
  /**
327
- * CompletedAt is the time when the task is processed successfully
328
- * Zero value (i.e. time.Time{}) indicates no value
327
+ * CompletedAt is the time when the task is processed successfully.
328
+ * Zero value (i.e. time.Time{}) indicates no value.
329
329
  *
330
330
  * @generated from field: google.protobuf.Timestamp completed_at = 16;
331
331
  */
332
332
  completedAt?: Timestamp | undefined;
333
333
 
334
334
  /**
335
- * Result holds the result data associated with the task
336
- * Use ResultWriter to write result data from the Handler
335
+ * Result holds the result data associated with the task.
336
+ * Use ResultWriter to write result data from the Handler.
337
337
  *
338
338
  * @generated from field: bytes result = 17;
339
339
  */
@@ -354,56 +354,56 @@ export const TaskInfoSchema: GenMessage<TaskInfo> = /*@__PURE__*/
354
354
  */
355
355
  export enum TaskState {
356
356
  /**
357
- * TASK_STATE_UNSPECIFIED is not specified
357
+ * TASK_STATE_UNSPECIFIED is not specified.
358
358
  *
359
359
  * @generated from enum value: TASK_STATE_UNSPECIFIED = 0;
360
360
  */
361
361
  UNSPECIFIED = 0,
362
362
 
363
363
  /**
364
- * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler
364
+ * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler.
365
365
  *
366
366
  * @generated from enum value: TASK_STATE_ACTIVE = 1;
367
367
  */
368
368
  ACTIVE = 1,
369
369
 
370
370
  /**
371
- * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler
371
+ * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler.
372
372
  *
373
373
  * @generated from enum value: TASK_STATE_PENDING = 2;
374
374
  */
375
375
  PENDING = 2,
376
376
 
377
377
  /**
378
- * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future
378
+ * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future.
379
379
  *
380
380
  * @generated from enum value: TASK_STATE_SCHEDULED = 3;
381
381
  */
382
382
  SCHEDULED = 3,
383
383
 
384
384
  /**
385
- * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future
385
+ * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future.
386
386
  *
387
387
  * @generated from enum value: TASK_STATE_RETRY = 4;
388
388
  */
389
389
  RETRY = 4,
390
390
 
391
391
  /**
392
- * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes
392
+ * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes.
393
393
  *
394
394
  * @generated from enum value: TASK_STATE_ARCHIVED = 5;
395
395
  */
396
396
  ARCHIVED = 5,
397
397
 
398
398
  /**
399
- * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires
399
+ * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires.
400
400
  *
401
401
  * @generated from enum value: TASK_STATE_COMPLETED = 6;
402
402
  */
403
403
  COMPLETED = 6,
404
404
 
405
405
  /**
406
- * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task
406
+ * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task.
407
407
  *
408
408
  * @generated from enum value: TASK_STATE_AGGREGATING = 7;
409
409
  */