@xeonr/pipelines-sdk 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +247 -24
  2. package/dist/client.d.ts +73 -3
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +48 -1
  5. package/dist/client.js.map +1 -1
  6. package/dist/errors.d.ts +42 -6
  7. package/dist/errors.d.ts.map +1 -1
  8. package/dist/errors.js +45 -2
  9. package/dist/errors.js.map +1 -1
  10. package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.d.ts +173 -12
  11. package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.d.ts.map +1 -1
  12. package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.js +45 -28
  13. package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.js.map +1 -1
  14. package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.d.ts +136 -17
  15. package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.d.ts.map +1 -1
  16. package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.js +42 -35
  17. package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.js.map +1 -1
  18. package/dist/gen/xeonr/pipelines/private/v1/worker_pb.d.ts +346 -15
  19. package/dist/gen/xeonr/pipelines/private/v1/worker_pb.d.ts.map +1 -1
  20. package/dist/gen/xeonr/pipelines/private/v1/worker_pb.js +105 -10
  21. package/dist/gen/xeonr/pipelines/private/v1/worker_pb.js.map +1 -1
  22. package/dist/gen/xeonr/pipelines/v1/common_pb.d.ts +38 -6
  23. package/dist/gen/xeonr/pipelines/v1/common_pb.d.ts.map +1 -1
  24. package/dist/gen/xeonr/pipelines/v1/common_pb.js +37 -5
  25. package/dist/gen/xeonr/pipelines/v1/common_pb.js.map +1 -1
  26. package/dist/gen/xeonr/pipelines/v1/definition_pb.d.ts +280 -5
  27. package/dist/gen/xeonr/pipelines/v1/definition_pb.d.ts.map +1 -1
  28. package/dist/gen/xeonr/pipelines/v1/definition_pb.js +100 -7
  29. package/dist/gen/xeonr/pipelines/v1/definition_pb.js.map +1 -1
  30. package/dist/gen/xeonr/pipelines/v1/pipelines_pb.d.ts +1100 -0
  31. package/dist/gen/xeonr/pipelines/v1/pipelines_pb.d.ts.map +1 -0
  32. package/dist/gen/xeonr/pipelines/v1/pipelines_pb.js +298 -0
  33. package/dist/gen/xeonr/pipelines/v1/pipelines_pb.js.map +1 -0
  34. package/dist/gen/xeonr/pipelines/v1/pools_pb.d.ts +120 -1
  35. package/dist/gen/xeonr/pipelines/v1/pools_pb.d.ts.map +1 -1
  36. package/dist/gen/xeonr/pipelines/v1/pools_pb.js +36 -11
  37. package/dist/gen/xeonr/pipelines/v1/pools_pb.js.map +1 -1
  38. package/dist/gen/xeonr/pipelines/v1/queues_pb.d.ts +769 -0
  39. package/dist/gen/xeonr/pipelines/v1/queues_pb.d.ts.map +1 -0
  40. package/dist/gen/xeonr/pipelines/v1/queues_pb.js +190 -0
  41. package/dist/gen/xeonr/pipelines/v1/queues_pb.js.map +1 -0
  42. package/dist/gen/xeonr/pipelines/v1/registry_pb.d.ts +60 -0
  43. package/dist/gen/xeonr/pipelines/v1/registry_pb.d.ts.map +1 -1
  44. package/dist/gen/xeonr/pipelines/v1/registry_pb.js +21 -16
  45. package/dist/gen/xeonr/pipelines/v1/registry_pb.js.map +1 -1
  46. package/dist/gen/xeonr/pipelines/v1/runs_pb.d.ts +867 -4
  47. package/dist/gen/xeonr/pipelines/v1/runs_pb.d.ts.map +1 -1
  48. package/dist/gen/xeonr/pipelines/v1/runs_pb.js +243 -27
  49. package/dist/gen/xeonr/pipelines/v1/runs_pb.js.map +1 -1
  50. package/dist/gen/xeonr/pipelines/v1/schedules_pb.d.ts +1110 -0
  51. package/dist/gen/xeonr/pipelines/v1/schedules_pb.d.ts.map +1 -0
  52. package/dist/gen/xeonr/pipelines/v1/schedules_pb.js +295 -0
  53. package/dist/gen/xeonr/pipelines/v1/schedules_pb.js.map +1 -0
  54. package/dist/gen/xeonr/pipelines/v1/secrets_pb.d.ts +8 -3
  55. package/dist/gen/xeonr/pipelines/v1/secrets_pb.d.ts.map +1 -1
  56. package/dist/gen/xeonr/pipelines/v1/secrets_pb.js +1 -1
  57. package/dist/gen/xeonr/pipelines/v1/secrets_pb.js.map +1 -1
  58. package/dist/gen/xeonr/platform/v1/options_pb.d.ts +123 -1
  59. package/dist/gen/xeonr/platform/v1/options_pb.d.ts.map +1 -1
  60. package/dist/gen/xeonr/platform/v1/options_pb.js +90 -1
  61. package/dist/gen/xeonr/platform/v1/options_pb.js.map +1 -1
  62. package/dist/handler.d.ts +50 -0
  63. package/dist/handler.d.ts.map +1 -1
  64. package/dist/handler.js +27 -0
  65. package/dist/handler.js.map +1 -1
  66. package/dist/index.d.ts +13 -1
  67. package/dist/index.d.ts.map +1 -1
  68. package/dist/index.js +7 -1
  69. package/dist/index.js.map +1 -1
  70. package/dist/logship.d.ts +60 -10
  71. package/dist/logship.d.ts.map +1 -1
  72. package/dist/logship.js +171 -28
  73. package/dist/logship.js.map +1 -1
  74. package/dist/queues.d.ts +171 -0
  75. package/dist/queues.d.ts.map +1 -0
  76. package/dist/queues.js +135 -0
  77. package/dist/queues.js.map +1 -0
  78. package/dist/reporter.d.ts +120 -0
  79. package/dist/reporter.d.ts.map +1 -0
  80. package/dist/reporter.js +323 -0
  81. package/dist/reporter.js.map +1 -0
  82. package/dist/schedules.d.ts +201 -0
  83. package/dist/schedules.d.ts.map +1 -0
  84. package/dist/schedules.js +127 -0
  85. package/dist/schedules.js.map +1 -0
  86. package/dist/testing/cron.d.ts +33 -0
  87. package/dist/testing/cron.d.ts.map +1 -0
  88. package/dist/testing/cron.js +177 -0
  89. package/dist/testing/cron.js.map +1 -0
  90. package/dist/testing/index.d.ts +142 -4
  91. package/dist/testing/index.d.ts.map +1 -1
  92. package/dist/testing/index.js +843 -44
  93. package/dist/testing/index.js.map +1 -1
  94. package/dist/testing/queues.d.ts +46 -0
  95. package/dist/testing/queues.d.ts.map +1 -0
  96. package/dist/testing/queues.js +70 -0
  97. package/dist/testing/queues.js.map +1 -0
  98. package/dist/testing/schedules.d.ts +113 -0
  99. package/dist/testing/schedules.d.ts.map +1 -0
  100. package/dist/testing/schedules.js +419 -0
  101. package/dist/testing/schedules.js.map +1 -0
  102. package/dist/worker.d.ts +78 -8
  103. package/dist/worker.d.ts.map +1 -1
  104. package/dist/worker.js +163 -33
  105. package/dist/worker.js.map +1 -1
  106. package/package.json +1 -1
@@ -0,0 +1,769 @@
1
+ import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
2
+ import type { Duration, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
3
+ import type { RunState } from "./common_pb.js";
4
+ import type { Retry } from "./definition_pb.js";
5
+ import type { Run } from "./runs_pb.js";
6
+ import type { Message } from "@bufbuild/protobuf";
7
+ /**
8
+ * Describes the file xeonr/pipelines/v1/queues.proto.
9
+ */
10
+ export declare const file_xeonr_pipelines_v1_queues: GenFile;
11
+ /**
12
+ * QueueOwner is who a queue belongs to: always one product, and optionally
13
+ * one team within it.
14
+ *
15
+ * @generated from message xeonr.pipelines.v1.QueueOwner
16
+ */
17
+ export type QueueOwner = Message<"xeonr.pipelines.v1.QueueOwner"> & {
18
+ /**
19
+ * Product is the Auth application id of the product that declared the
20
+ * queue. A product's own service account may name only its own product.
21
+ *
22
+ * @generated from field: string product = 1;
23
+ */
24
+ product: string;
25
+ /**
26
+ * Tenant, when set, makes the queue that team's own: it admits only that
27
+ * team's jobs. Empty serves every tenant the product acts for.
28
+ *
29
+ * @generated from field: string tenant = 2;
30
+ */
31
+ tenant: string;
32
+ };
33
+ /**
34
+ * Describes the message xeonr.pipelines.v1.QueueOwner.
35
+ * Use `create(QueueOwnerSchema)` to create a new message.
36
+ */
37
+ export declare const QueueOwnerSchema: GenMessage<QueueOwner>;
38
+ /**
39
+ * QueueName names a queue by its owner and its name.
40
+ *
41
+ * @generated from message xeonr.pipelines.v1.QueueName
42
+ */
43
+ export type QueueName = Message<"xeonr.pipelines.v1.QueueName"> & {
44
+ /**
45
+ * @generated from field: xeonr.pipelines.v1.QueueOwner owner = 1;
46
+ */
47
+ owner?: QueueOwner | undefined;
48
+ /**
49
+ * @generated from field: string name = 2;
50
+ */
51
+ name: string;
52
+ };
53
+ /**
54
+ * Describes the message xeonr.pipelines.v1.QueueName.
55
+ * Use `create(QueueNameSchema)` to create a new message.
56
+ */
57
+ export declare const QueueNameSchema: GenMessage<QueueName>;
58
+ /**
59
+ * RateLimit caps how fast a queue starts work: at most `limit` attempts
60
+ * claimed per sliding `window`, retries included, on the database's clock.
61
+ * An attempt over the limit stays waiting.
62
+ *
63
+ * @generated from message xeonr.pipelines.v1.RateLimit
64
+ */
65
+ export type RateLimit = Message<"xeonr.pipelines.v1.RateLimit"> & {
66
+ /**
67
+ * @generated from field: uint32 limit = 1;
68
+ */
69
+ limit: number;
70
+ /**
71
+ * @generated from field: google.protobuf.Duration window = 2;
72
+ */
73
+ window?: Duration | undefined;
74
+ };
75
+ /**
76
+ * Describes the message xeonr.pipelines.v1.RateLimit.
77
+ * Use `create(RateLimitSchema)` to create a new message.
78
+ */
79
+ export declare const RateLimitSchema: GenMessage<RateLimit>;
80
+ /**
81
+ * Queue is a lane jobs are admitted through. See QueuesService for what it
82
+ * decides and what it does not.
83
+ *
84
+ * @generated from message xeonr.pipelines.v1.Queue
85
+ */
86
+ export type Queue = Message<"xeonr.pipelines.v1.Queue"> & {
87
+ /**
88
+ * ID is assigned by the platform. Empty in a request that creates.
89
+ *
90
+ * @generated from field: string id = 1;
91
+ */
92
+ id: string;
93
+ /**
94
+ * Owner is fixed when the queue is created.
95
+ *
96
+ * @generated from field: xeonr.pipelines.v1.QueueOwner owner = 2;
97
+ */
98
+ owner?: QueueOwner | undefined;
99
+ /**
100
+ * Name is unique per owner, and with the owner is what SetQueue matches
101
+ * on and what CreateJobRequest.queue names. `default` is the product's
102
+ * default queue.
103
+ *
104
+ * @generated from field: string name = 3;
105
+ */
106
+ name: string;
107
+ /**
108
+ * @generated from field: string description = 4;
109
+ */
110
+ description: string;
111
+ /**
112
+ * MaxConcurrency caps the queue's CLAIMED and RUNNING attempts, all
113
+ * tenants together. Zero is no cap of the queue's own.
114
+ *
115
+ * @generated from field: uint32 max_concurrency = 5;
116
+ */
117
+ maxConcurrency: number;
118
+ /**
119
+ * MaxConcurrencyPerTenant caps one tenant's CLAIMED and RUNNING attempts
120
+ * in this queue: a tenant at its cap is passed over until one finishes.
121
+ * Zero is no per-tenant cap (fairness still orders claims).
122
+ *
123
+ * @generated from field: uint32 max_concurrency_per_tenant = 6;
124
+ */
125
+ maxConcurrencyPerTenant: number;
126
+ /**
127
+ * RateLimit, when set, caps attempts started per window.
128
+ *
129
+ * @generated from field: xeonr.pipelines.v1.RateLimit rate_limit = 7;
130
+ */
131
+ rateLimit?: RateLimit | undefined;
132
+ /**
133
+ * DefaultRetry is the retry policy of a job that gives none, and the most
134
+ * a job may ask for: a job's `retry.max` may not exceed it, and its
135
+ * `retry.when` may list only classes this one retries (an empty `when`
136
+ * here is the platform's transient set). Unset is the platform's default,
137
+ * with the platform's bounds. A job that asks for more is refused by
138
+ * CreateJob with `invalid_argument`.
139
+ *
140
+ * @generated from field: xeonr.pipelines.v1.Retry default_retry = 8;
141
+ */
142
+ defaultRetry?: Retry | undefined;
143
+ /**
144
+ * DefaultTimeout is the timeout of a job that gives none, and the most a
145
+ * job may ask for; a longer one is refused with `invalid_argument`. Unset
146
+ * is the platform's default and bound.
147
+ *
148
+ * @generated from field: google.protobuf.Duration default_timeout = 9;
149
+ */
150
+ defaultTimeout?: Duration | undefined;
151
+ /**
152
+ * Priority orders the product's queues for a worker that could claim
153
+ * from several (one handler fed by two queues): every claimable job of a
154
+ * priority-1 queue is handed out before any of a priority-2 one. Zero
155
+ * means 1.
156
+ *
157
+ * @generated from field: uint32 priority = 10;
158
+ */
159
+ priority: number;
160
+ /**
161
+ * Paused is set by MarkQueuePaused and cleared by MarkQueueResumed; it is
162
+ * not written by SetQueue. A paused queue accepts jobs and starts none.
163
+ *
164
+ * @generated from field: bool paused = 11;
165
+ */
166
+ paused: boolean;
167
+ /**
168
+ * @generated from field: google.protobuf.Timestamp paused_at = 12;
169
+ */
170
+ pausedAt?: Timestamp | undefined;
171
+ /**
172
+ * PausedBy is the subject URN that paused it.
173
+ *
174
+ * @generated from field: string paused_by = 13;
175
+ */
176
+ pausedBy: string;
177
+ /**
178
+ * PausedReason is the reason MarkQueuePaused was given.
179
+ *
180
+ * @generated from field: string paused_reason = 14;
181
+ */
182
+ pausedReason: string;
183
+ /**
184
+ * CreatedAt and UpdatedAt are set by the platform.
185
+ *
186
+ * @generated from field: google.protobuf.Timestamp created_at = 15;
187
+ */
188
+ createdAt?: Timestamp | undefined;
189
+ /**
190
+ * @generated from field: google.protobuf.Timestamp updated_at = 16;
191
+ */
192
+ updatedAt?: Timestamp | undefined;
193
+ };
194
+ /**
195
+ * Describes the message xeonr.pipelines.v1.Queue.
196
+ * Use `create(QueueSchema)` to create a new message.
197
+ */
198
+ export declare const QueueSchema: GenMessage<Queue>;
199
+ /**
200
+ * QueueTenantStats is one tenant's share of a queue.
201
+ *
202
+ * @generated from message xeonr.pipelines.v1.QueueTenantStats
203
+ */
204
+ export type QueueTenantStats = Message<"xeonr.pipelines.v1.QueueTenantStats"> & {
205
+ /**
206
+ * @generated from field: string tenant = 1;
207
+ */
208
+ tenant: string;
209
+ /**
210
+ * @generated from field: uint32 waiting = 2;
211
+ */
212
+ waiting: number;
213
+ /**
214
+ * @generated from field: uint32 running = 3;
215
+ */
216
+ running: number;
217
+ };
218
+ /**
219
+ * Describes the message xeonr.pipelines.v1.QueueTenantStats.
220
+ * Use `create(QueueTenantStatsSchema)` to create a new message.
221
+ */
222
+ export declare const QueueTenantStatsSchema: GenMessage<QueueTenantStats>;
223
+ /**
224
+ * @generated from message xeonr.pipelines.v1.SetQueueRequest
225
+ */
226
+ export type SetQueueRequest = Message<"xeonr.pipelines.v1.SetQueueRequest"> & {
227
+ /**
228
+ * Queue is matched on (owner, name). Its `id`, when given, must be the
229
+ * matched queue's.
230
+ *
231
+ * @generated from field: xeonr.pipelines.v1.Queue queue = 1;
232
+ */
233
+ queue?: Queue | undefined;
234
+ /**
235
+ * UpdateMask narrows a write to an existing queue to the fields it names.
236
+ * Omitted, the whole queue is replaced. Ignored when the queue is
237
+ * created.
238
+ *
239
+ * @generated from field: google.protobuf.FieldMask update_mask = 2;
240
+ */
241
+ updateMask?: FieldMask | undefined;
242
+ };
243
+ /**
244
+ * Describes the message xeonr.pipelines.v1.SetQueueRequest.
245
+ * Use `create(SetQueueRequestSchema)` to create a new message.
246
+ */
247
+ export declare const SetQueueRequestSchema: GenMessage<SetQueueRequest>;
248
+ /**
249
+ * @generated from message xeonr.pipelines.v1.SetQueueResponse
250
+ */
251
+ export type SetQueueResponse = Message<"xeonr.pipelines.v1.SetQueueResponse"> & {
252
+ /**
253
+ * @generated from field: xeonr.pipelines.v1.Queue queue = 1;
254
+ */
255
+ queue?: Queue | undefined;
256
+ /**
257
+ * Created says the queue did not exist before.
258
+ *
259
+ * @generated from field: bool created = 2;
260
+ */
261
+ created: boolean;
262
+ };
263
+ /**
264
+ * Describes the message xeonr.pipelines.v1.SetQueueResponse.
265
+ * Use `create(SetQueueResponseSchema)` to create a new message.
266
+ */
267
+ export declare const SetQueueResponseSchema: GenMessage<SetQueueResponse>;
268
+ /**
269
+ * @generated from message xeonr.pipelines.v1.GetQueueRequest
270
+ */
271
+ export type GetQueueRequest = Message<"xeonr.pipelines.v1.GetQueueRequest"> & {
272
+ /**
273
+ * Queue names the queue to read.
274
+ *
275
+ * @generated from oneof xeonr.pipelines.v1.GetQueueRequest.queue
276
+ */
277
+ queue: {
278
+ /**
279
+ * QueueID is the queue's id.
280
+ *
281
+ * @generated from field: string queue_id = 1;
282
+ */
283
+ value: string;
284
+ case: "queueId";
285
+ } | {
286
+ /**
287
+ * ByName is the queue's owner and name.
288
+ *
289
+ * @generated from field: xeonr.pipelines.v1.QueueName by_name = 2;
290
+ */
291
+ value: QueueName;
292
+ case: "byName";
293
+ } | {
294
+ case: undefined;
295
+ value?: undefined;
296
+ };
297
+ };
298
+ /**
299
+ * Describes the message xeonr.pipelines.v1.GetQueueRequest.
300
+ * Use `create(GetQueueRequestSchema)` to create a new message.
301
+ */
302
+ export declare const GetQueueRequestSchema: GenMessage<GetQueueRequest>;
303
+ /**
304
+ * @generated from message xeonr.pipelines.v1.GetQueueResponse
305
+ */
306
+ export type GetQueueResponse = Message<"xeonr.pipelines.v1.GetQueueResponse"> & {
307
+ /**
308
+ * @generated from field: xeonr.pipelines.v1.Queue queue = 1;
309
+ */
310
+ queue?: Queue | undefined;
311
+ };
312
+ /**
313
+ * Describes the message xeonr.pipelines.v1.GetQueueResponse.
314
+ * Use `create(GetQueueResponseSchema)` to create a new message.
315
+ */
316
+ export declare const GetQueueResponseSchema: GenMessage<GetQueueResponse>;
317
+ /**
318
+ * @generated from message xeonr.pipelines.v1.ListQueuesRequest
319
+ */
320
+ export type ListQueuesRequest = Message<"xeonr.pipelines.v1.ListQueuesRequest"> & {
321
+ /**
322
+ * Product is the Auth application whose queues are listed. Empty is the
323
+ * caller's own product.
324
+ *
325
+ * @generated from field: string product = 1;
326
+ */
327
+ product: string;
328
+ /**
329
+ * Tenant narrows to that team's own queues. Empty lists every queue of
330
+ * the product the caller may read.
331
+ *
332
+ * @generated from field: string tenant = 2;
333
+ */
334
+ tenant: string;
335
+ /**
336
+ * Cursor is opaque, empty for the first page.
337
+ *
338
+ * @generated from field: string cursor = 3;
339
+ */
340
+ cursor: string;
341
+ /**
342
+ * Limit is capped at 500; zero means the default of 50.
343
+ *
344
+ * @generated from field: uint32 limit = 4;
345
+ */
346
+ limit: number;
347
+ };
348
+ /**
349
+ * Describes the message xeonr.pipelines.v1.ListQueuesRequest.
350
+ * Use `create(ListQueuesRequestSchema)` to create a new message.
351
+ */
352
+ export declare const ListQueuesRequestSchema: GenMessage<ListQueuesRequest>;
353
+ /**
354
+ * @generated from message xeonr.pipelines.v1.ListQueuesResponse
355
+ */
356
+ export type ListQueuesResponse = Message<"xeonr.pipelines.v1.ListQueuesResponse"> & {
357
+ /**
358
+ * @generated from field: repeated xeonr.pipelines.v1.Queue queues = 1;
359
+ */
360
+ queues: Queue[];
361
+ /**
362
+ * NextCursor is empty when there is no further page.
363
+ *
364
+ * @generated from field: string next_cursor = 2;
365
+ */
366
+ nextCursor: string;
367
+ };
368
+ /**
369
+ * Describes the message xeonr.pipelines.v1.ListQueuesResponse.
370
+ * Use `create(ListQueuesResponseSchema)` to create a new message.
371
+ */
372
+ export declare const ListQueuesResponseSchema: GenMessage<ListQueuesResponse>;
373
+ /**
374
+ * @generated from message xeonr.pipelines.v1.MarkQueuePausedRequest
375
+ */
376
+ export type MarkQueuePausedRequest = Message<"xeonr.pipelines.v1.MarkQueuePausedRequest"> & {
377
+ /**
378
+ * @generated from field: string queue_id = 1;
379
+ */
380
+ queueId: string;
381
+ /**
382
+ * Reason is shown with the queue while it is paused.
383
+ *
384
+ * @generated from field: string reason = 2;
385
+ */
386
+ reason: string;
387
+ };
388
+ /**
389
+ * Describes the message xeonr.pipelines.v1.MarkQueuePausedRequest.
390
+ * Use `create(MarkQueuePausedRequestSchema)` to create a new message.
391
+ */
392
+ export declare const MarkQueuePausedRequestSchema: GenMessage<MarkQueuePausedRequest>;
393
+ /**
394
+ * @generated from message xeonr.pipelines.v1.MarkQueuePausedResponse
395
+ */
396
+ export type MarkQueuePausedResponse = Message<"xeonr.pipelines.v1.MarkQueuePausedResponse"> & {
397
+ /**
398
+ * @generated from field: xeonr.pipelines.v1.Queue queue = 1;
399
+ */
400
+ queue?: Queue | undefined;
401
+ };
402
+ /**
403
+ * Describes the message xeonr.pipelines.v1.MarkQueuePausedResponse.
404
+ * Use `create(MarkQueuePausedResponseSchema)` to create a new message.
405
+ */
406
+ export declare const MarkQueuePausedResponseSchema: GenMessage<MarkQueuePausedResponse>;
407
+ /**
408
+ * @generated from message xeonr.pipelines.v1.MarkQueueResumedRequest
409
+ */
410
+ export type MarkQueueResumedRequest = Message<"xeonr.pipelines.v1.MarkQueueResumedRequest"> & {
411
+ /**
412
+ * @generated from field: string queue_id = 1;
413
+ */
414
+ queueId: string;
415
+ };
416
+ /**
417
+ * Describes the message xeonr.pipelines.v1.MarkQueueResumedRequest.
418
+ * Use `create(MarkQueueResumedRequestSchema)` to create a new message.
419
+ */
420
+ export declare const MarkQueueResumedRequestSchema: GenMessage<MarkQueueResumedRequest>;
421
+ /**
422
+ * @generated from message xeonr.pipelines.v1.MarkQueueResumedResponse
423
+ */
424
+ export type MarkQueueResumedResponse = Message<"xeonr.pipelines.v1.MarkQueueResumedResponse"> & {
425
+ /**
426
+ * @generated from field: xeonr.pipelines.v1.Queue queue = 1;
427
+ */
428
+ queue?: Queue | undefined;
429
+ };
430
+ /**
431
+ * Describes the message xeonr.pipelines.v1.MarkQueueResumedResponse.
432
+ * Use `create(MarkQueueResumedResponseSchema)` to create a new message.
433
+ */
434
+ export declare const MarkQueueResumedResponseSchema: GenMessage<MarkQueueResumedResponse>;
435
+ /**
436
+ * @generated from message xeonr.pipelines.v1.DeleteQueueRequest
437
+ */
438
+ export type DeleteQueueRequest = Message<"xeonr.pipelines.v1.DeleteQueueRequest"> & {
439
+ /**
440
+ * @generated from field: string queue_id = 1;
441
+ */
442
+ queueId: string;
443
+ /**
444
+ * CancelWaiting cancels the queue's waiting and delayed jobs instead of
445
+ * refusing the delete.
446
+ *
447
+ * validate:skip a bool has no bounds
448
+ *
449
+ * @generated from field: bool cancel_waiting = 2;
450
+ */
451
+ cancelWaiting: boolean;
452
+ };
453
+ /**
454
+ * Describes the message xeonr.pipelines.v1.DeleteQueueRequest.
455
+ * Use `create(DeleteQueueRequestSchema)` to create a new message.
456
+ */
457
+ export declare const DeleteQueueRequestSchema: GenMessage<DeleteQueueRequest>;
458
+ /**
459
+ * @generated from message xeonr.pipelines.v1.DeleteQueueResponse
460
+ */
461
+ export type DeleteQueueResponse = Message<"xeonr.pipelines.v1.DeleteQueueResponse"> & {
462
+ /**
463
+ * CancelledJobs counts the jobs `cancel_waiting` cancelled.
464
+ *
465
+ * @generated from field: uint32 cancelled_jobs = 1;
466
+ */
467
+ cancelledJobs: number;
468
+ };
469
+ /**
470
+ * Describes the message xeonr.pipelines.v1.DeleteQueueResponse.
471
+ * Use `create(DeleteQueueResponseSchema)` to create a new message.
472
+ */
473
+ export declare const DeleteQueueResponseSchema: GenMessage<DeleteQueueResponse>;
474
+ /**
475
+ * @generated from message xeonr.pipelines.v1.GetQueueStatsRequest
476
+ */
477
+ export type GetQueueStatsRequest = Message<"xeonr.pipelines.v1.GetQueueStatsRequest"> & {
478
+ /**
479
+ * @generated from field: string queue_id = 1;
480
+ */
481
+ queueId: string;
482
+ /**
483
+ * Window is the span `started` and `failed` count over. Unset means one
484
+ * hour; the most is a day.
485
+ *
486
+ * @generated from field: google.protobuf.Duration window = 2;
487
+ */
488
+ window?: Duration | undefined;
489
+ /**
490
+ * TopTenants is how many tenants to break out, by waiting then running.
491
+ * Zero means 10; the most is 50.
492
+ *
493
+ * @generated from field: uint32 top_tenants = 3;
494
+ */
495
+ topTenants: number;
496
+ };
497
+ /**
498
+ * Describes the message xeonr.pipelines.v1.GetQueueStatsRequest.
499
+ * Use `create(GetQueueStatsRequestSchema)` to create a new message.
500
+ */
501
+ export declare const GetQueueStatsRequestSchema: GenMessage<GetQueueStatsRequest>;
502
+ /**
503
+ * @generated from message xeonr.pipelines.v1.GetQueueStatsResponse
504
+ */
505
+ export type GetQueueStatsResponse = Message<"xeonr.pipelines.v1.GetQueueStatsResponse"> & {
506
+ /**
507
+ * Waiting counts jobs offered and claimable now, paused aside.
508
+ *
509
+ * @generated from field: uint32 waiting = 1;
510
+ */
511
+ waiting: number;
512
+ /**
513
+ * Delayed counts jobs held back by their delay (`not_before`).
514
+ *
515
+ * @generated from field: uint32 delayed = 2;
516
+ */
517
+ delayed: number;
518
+ /**
519
+ * Running counts jobs with an attempt CLAIMED or RUNNING.
520
+ *
521
+ * @generated from field: uint32 running = 3;
522
+ */
523
+ running: number;
524
+ /**
525
+ * OldestWaitingAt is when the oldest waiting job became claimable; unset
526
+ * when none waits. OldestWaitingAge is its age at `at`.
527
+ *
528
+ * @generated from field: google.protobuf.Timestamp oldest_waiting_at = 4;
529
+ */
530
+ oldestWaitingAt?: Timestamp | undefined;
531
+ /**
532
+ * @generated from field: google.protobuf.Duration oldest_waiting_age = 5;
533
+ */
534
+ oldestWaitingAge?: Duration | undefined;
535
+ /**
536
+ * Tenants are the tenants with the most waiting, then running, jobs.
537
+ *
538
+ * @generated from field: repeated xeonr.pipelines.v1.QueueTenantStats tenants = 6;
539
+ */
540
+ tenants: QueueTenantStats[];
541
+ /**
542
+ * Started counts attempts that started user code within `window`.
543
+ *
544
+ * @generated from field: uint64 started = 7;
545
+ */
546
+ started: bigint;
547
+ /**
548
+ * Failed counts jobs whose run ended FAILED within `window`: the dead
549
+ * letters made in it.
550
+ *
551
+ * @generated from field: uint64 failed = 8;
552
+ */
553
+ failed: bigint;
554
+ /**
555
+ * @generated from field: google.protobuf.Duration window = 9;
556
+ */
557
+ window?: Duration | undefined;
558
+ /**
559
+ * @generated from field: bool paused = 10;
560
+ */
561
+ paused: boolean;
562
+ /**
563
+ * At is when the figures were read.
564
+ *
565
+ * @generated from field: google.protobuf.Timestamp at = 11;
566
+ */
567
+ at?: Timestamp | undefined;
568
+ };
569
+ /**
570
+ * Describes the message xeonr.pipelines.v1.GetQueueStatsResponse.
571
+ * Use `create(GetQueueStatsResponseSchema)` to create a new message.
572
+ */
573
+ export declare const GetQueueStatsResponseSchema: GenMessage<GetQueueStatsResponse>;
574
+ /**
575
+ * @generated from message xeonr.pipelines.v1.ListQueueJobsRequest
576
+ */
577
+ export type ListQueueJobsRequest = Message<"xeonr.pipelines.v1.ListQueueJobsRequest"> & {
578
+ /**
579
+ * @generated from field: string queue_id = 1;
580
+ */
581
+ queueId: string;
582
+ /**
583
+ * Tenant narrows to one team's jobs.
584
+ *
585
+ * @generated from field: string tenant = 2;
586
+ */
587
+ tenant: string;
588
+ /**
589
+ * States narrows to jobs whose run is in any of these states; FAILED
590
+ * lists the dead letters. Empty lists all.
591
+ *
592
+ * @generated from field: repeated xeonr.pipelines.v1.RunState states = 3;
593
+ */
594
+ states: RunState[];
595
+ /**
596
+ * Cursor is opaque, empty for the first page.
597
+ *
598
+ * @generated from field: string cursor = 4;
599
+ */
600
+ cursor: string;
601
+ /**
602
+ * Limit is capped at 500; zero means the default of 50.
603
+ *
604
+ * @generated from field: uint32 limit = 5;
605
+ */
606
+ limit: number;
607
+ };
608
+ /**
609
+ * Describes the message xeonr.pipelines.v1.ListQueueJobsRequest.
610
+ * Use `create(ListQueueJobsRequestSchema)` to create a new message.
611
+ */
612
+ export declare const ListQueueJobsRequestSchema: GenMessage<ListQueueJobsRequest>;
613
+ /**
614
+ * @generated from message xeonr.pipelines.v1.ListQueueJobsResponse
615
+ */
616
+ export type ListQueueJobsResponse = Message<"xeonr.pipelines.v1.ListQueueJobsResponse"> & {
617
+ /**
618
+ * Runs are the jobs' one-node runs.
619
+ *
620
+ * @generated from field: repeated xeonr.pipelines.v1.Run runs = 1;
621
+ */
622
+ runs: Run[];
623
+ /**
624
+ * NextCursor is empty when there is no further page.
625
+ *
626
+ * @generated from field: string next_cursor = 2;
627
+ */
628
+ nextCursor: string;
629
+ };
630
+ /**
631
+ * Describes the message xeonr.pipelines.v1.ListQueueJobsResponse.
632
+ * Use `create(ListQueueJobsResponseSchema)` to create a new message.
633
+ */
634
+ export declare const ListQueueJobsResponseSchema: GenMessage<ListQueueJobsResponse>;
635
+ /**
636
+ * QueuesService manages queues: the lanes a product's jobs are admitted
637
+ * through. Milestone 2.
638
+ *
639
+ * A queue is a logical lane for admission and fairness, not a place where
640
+ * work runs. Pools and their workers are where attempts execute (see
641
+ * PoolsService); a queue decides which of the waiting jobs a worker may be
642
+ * handed next, and when. Its limits are enforced when an attempt is offered
643
+ * and when it is claimed, on top of the pool's own capacity
644
+ * (`capacity_per_instance`) and the claiming worker's free slots: an
645
+ * attempt runs only when the queue, the pool and the worker all allow it.
646
+ * A queue is not bound to a handler: any handler its product owns may be
647
+ * enqueued on any of the product's queues, and one handler may be fed by
648
+ * several queues.
649
+ *
650
+ * Only jobs (RunsService.CreateJob) go through queues. A worker node of a
651
+ * full run is offered as it always was, outside any queue. (Provisional:
652
+ * whether a run's handler nodes may name a queue is left for later.)
653
+ *
654
+ * Isolation. A queue belongs to exactly one product, the Auth application
655
+ * that declared it, and is never shared across products: a job is resolved
656
+ * only among its own product's queues, and a product's workers claim only
657
+ * that product's handlers in any case (WorkerService). Within a product, a
658
+ * queue either serves every tenant the product acts for, with fairness
659
+ * between them, or is a team's own (`owner.tenant`) and serves that team's
660
+ * jobs alone.
661
+ *
662
+ * Fairness. This is platform-design §7.3's per-tenant budget checked when
663
+ * work is handed out ("over-budget steps simply stay in the ready set"), and
664
+ * design-v1 §4.3's per-tenant counter, decided here as follows. Among the
665
+ * claimable jobs of a queue (not delayed, the queue not paused, the queue
666
+ * under `max_concurrency` and its `rate_limit`), only tenants under
667
+ * `max_concurrency_per_tenant` are eligible, and the next claim goes to the
668
+ * eligible tenant with the fewest running attempts in this queue; ties go
669
+ * to the tenant whose oldest waiting job has waited longest; within a
670
+ * tenant, jobs are taken oldest first. Running counts CLAIMED and RUNNING
671
+ * attempts, counted from the attempts themselves (all state is in MySQL),
672
+ * so nothing has to be rebuilt after Redis is lost. A tenant's backlog
673
+ * therefore never delays another tenant's next job by more than one claim.
674
+ * The rule answers platform-design §14's open "fairness mechanism (queue
675
+ * groups vs token counters)" with counters.
676
+ *
677
+ * The default queue. Every product has one, named `default`, without
678
+ * declaring it: a job with no `queue` goes there. Until the product sets a
679
+ * queue named `default` it has no limits, no defaults and no pause, so it
680
+ * behaves exactly as jobs did before queues existed.
681
+ *
682
+ * Dead letters. A job whose run ended FAILED has exhausted its retries (or
683
+ * failed with a class its policy does not retry): ListQueueJobs with that
684
+ * state lists a queue's dead letters, across tenants, which the tenant
685
+ * scoped RunsService.ListRuns cannot. To enqueue one again, call
686
+ * RunsService.RetryNode on its run with node `job`: a job is a one-node
687
+ * run, so RetryNode's semantics (the run reopens, the node gets a new
688
+ * attempt, nothing upstream to keep) are exactly a requeue. The new attempt
689
+ * is offered on the same queue under its settings at that time.
690
+ *
691
+ * Ownership. A queue is set, paused, resumed and deleted by its product's
692
+ * own service accounts (the caller's product must be `owner.product`), by
693
+ * the platform's operators, and, for a team's own queue, by members of that
694
+ * team. The same callers read it. (Provisional: members of a tenant cannot
695
+ * read a product-wide queue, because its stats name other tenants.) A queue
696
+ * the caller may not read answers `not_found`.
697
+ *
698
+ * Verbs outside api.rpc-naming's: none. MarkQueuePaused and MarkQueueResumed
699
+ * use `Mark`, as MarkRunnerDraining does.
700
+ *
701
+ * @generated from service xeonr.pipelines.v1.QueuesService
702
+ */
703
+ export declare const QueuesService: GenService<{
704
+ /**
705
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.SetQueue
706
+ */
707
+ setQueue: {
708
+ methodKind: "unary";
709
+ input: typeof SetQueueRequestSchema;
710
+ output: typeof SetQueueResponseSchema;
711
+ };
712
+ /**
713
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.GetQueue
714
+ */
715
+ getQueue: {
716
+ methodKind: "unary";
717
+ input: typeof GetQueueRequestSchema;
718
+ output: typeof GetQueueResponseSchema;
719
+ };
720
+ /**
721
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.ListQueues
722
+ */
723
+ listQueues: {
724
+ methodKind: "unary";
725
+ input: typeof ListQueuesRequestSchema;
726
+ output: typeof ListQueuesResponseSchema;
727
+ };
728
+ /**
729
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.MarkQueuePaused
730
+ */
731
+ markQueuePaused: {
732
+ methodKind: "unary";
733
+ input: typeof MarkQueuePausedRequestSchema;
734
+ output: typeof MarkQueuePausedResponseSchema;
735
+ };
736
+ /**
737
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.MarkQueueResumed
738
+ */
739
+ markQueueResumed: {
740
+ methodKind: "unary";
741
+ input: typeof MarkQueueResumedRequestSchema;
742
+ output: typeof MarkQueueResumedResponseSchema;
743
+ };
744
+ /**
745
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.DeleteQueue
746
+ */
747
+ deleteQueue: {
748
+ methodKind: "unary";
749
+ input: typeof DeleteQueueRequestSchema;
750
+ output: typeof DeleteQueueResponseSchema;
751
+ };
752
+ /**
753
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.GetQueueStats
754
+ */
755
+ getQueueStats: {
756
+ methodKind: "unary";
757
+ input: typeof GetQueueStatsRequestSchema;
758
+ output: typeof GetQueueStatsResponseSchema;
759
+ };
760
+ /**
761
+ * @generated from rpc xeonr.pipelines.v1.QueuesService.ListQueueJobs
762
+ */
763
+ listQueueJobs: {
764
+ methodKind: "unary";
765
+ input: typeof ListQueueJobsRequestSchema;
766
+ output: typeof ListQueueJobsResponseSchema;
767
+ };
768
+ }>;
769
+ //# sourceMappingURL=queues_pb.d.ts.map