@xeonr/pipelines-sdk 0.2.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.
- package/README.md +172 -16
- package/dist/client.d.ts +63 -4
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +43 -1
- package/dist/client.js.map +1 -1
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.d.ts +173 -12
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.js +45 -28
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.d.ts +136 -17
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.js +42 -35
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.d.ts +187 -2
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.js +38 -5
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/common_pb.d.ts +4 -2
- package/dist/gen/xeonr/pipelines/v1/common_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/common_pb.js +4 -2
- package/dist/gen/xeonr/pipelines/v1/common_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/definition_pb.d.ts +277 -4
- package/dist/gen/xeonr/pipelines/v1/definition_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/definition_pb.js +100 -7
- package/dist/gen/xeonr/pipelines/v1/definition_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/pipelines_pb.d.ts +1100 -0
- package/dist/gen/xeonr/pipelines/v1/pipelines_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/pipelines_pb.js +298 -0
- package/dist/gen/xeonr/pipelines/v1/pipelines_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/pools_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/pools_pb.js +1 -1
- package/dist/gen/xeonr/pipelines/v1/pools_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/queues_pb.d.ts +769 -0
- package/dist/gen/xeonr/pipelines/v1/queues_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/queues_pb.js +190 -0
- package/dist/gen/xeonr/pipelines/v1/queues_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/registry_pb.d.ts +60 -0
- package/dist/gen/xeonr/pipelines/v1/registry_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/registry_pb.js +21 -16
- package/dist/gen/xeonr/pipelines/v1/registry_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/runs_pb.d.ts +846 -3
- package/dist/gen/xeonr/pipelines/v1/runs_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/runs_pb.js +243 -27
- package/dist/gen/xeonr/pipelines/v1/runs_pb.js.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/schedules_pb.d.ts +1110 -0
- package/dist/gen/xeonr/pipelines/v1/schedules_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/schedules_pb.js +295 -0
- package/dist/gen/xeonr/pipelines/v1/schedules_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/secrets_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/pipelines/v1/secrets_pb.js +1 -1
- package/dist/gen/xeonr/pipelines/v1/secrets_pb.js.map +1 -1
- package/dist/gen/xeonr/platform/v1/options_pb.d.ts +123 -1
- package/dist/gen/xeonr/platform/v1/options_pb.d.ts.map +1 -1
- package/dist/gen/xeonr/platform/v1/options_pb.js +90 -1
- package/dist/gen/xeonr/platform/v1/options_pb.js.map +1 -1
- package/dist/handler.d.ts +50 -0
- package/dist/handler.d.ts.map +1 -1
- package/dist/handler.js +27 -0
- package/dist/handler.js.map +1 -1
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -1
- package/dist/queues.d.ts +171 -0
- package/dist/queues.d.ts.map +1 -0
- package/dist/queues.js +135 -0
- package/dist/queues.js.map +1 -0
- package/dist/reporter.d.ts +120 -0
- package/dist/reporter.d.ts.map +1 -0
- package/dist/reporter.js +323 -0
- package/dist/reporter.js.map +1 -0
- package/dist/schedules.d.ts +201 -0
- package/dist/schedules.d.ts.map +1 -0
- package/dist/schedules.js +127 -0
- package/dist/schedules.js.map +1 -0
- package/dist/testing/cron.d.ts +33 -0
- package/dist/testing/cron.d.ts.map +1 -0
- package/dist/testing/cron.js +177 -0
- package/dist/testing/cron.js.map +1 -0
- package/dist/testing/index.d.ts +129 -4
- package/dist/testing/index.d.ts.map +1 -1
- package/dist/testing/index.js +723 -30
- package/dist/testing/index.js.map +1 -1
- package/dist/testing/queues.d.ts +46 -0
- package/dist/testing/queues.d.ts.map +1 -0
- package/dist/testing/queues.js +70 -0
- package/dist/testing/queues.js.map +1 -0
- package/dist/testing/schedules.d.ts +113 -0
- package/dist/testing/schedules.d.ts.map +1 -0
- package/dist/testing/schedules.js +419 -0
- package/dist/testing/schedules.js.map +1 -0
- package/dist/worker.d.ts +48 -1
- package/dist/worker.d.ts.map +1 -1
- package/dist/worker.js +67 -6
- package/dist/worker.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,1110 @@
|
|
|
1
|
+
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { Duration, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
|
|
3
|
+
import type { Resource, RunState } from "./common_pb.js";
|
|
4
|
+
import type { Retry } from "./definition_pb.js";
|
|
5
|
+
import type { Run } from "./runs_pb.js";
|
|
6
|
+
import type { JsonObject, Message } from "@bufbuild/protobuf";
|
|
7
|
+
/**
|
|
8
|
+
* Describes the file xeonr/pipelines/v1/schedules.proto.
|
|
9
|
+
*/
|
|
10
|
+
export declare const file_xeonr_pipelines_v1_schedules: GenFile;
|
|
11
|
+
/**
|
|
12
|
+
* ScheduleOwner is who a schedule belongs to: one product, and optionally one
|
|
13
|
+
* team within it.
|
|
14
|
+
*
|
|
15
|
+
* @generated from message xeonr.pipelines.v1.ScheduleOwner
|
|
16
|
+
*/
|
|
17
|
+
export type ScheduleOwner = Message<"xeonr.pipelines.v1.ScheduleOwner"> & {
|
|
18
|
+
/**
|
|
19
|
+
* Product is the Auth application id of the product that declared it.
|
|
20
|
+
*
|
|
21
|
+
* @generated from field: string product = 1;
|
|
22
|
+
*/
|
|
23
|
+
product: string;
|
|
24
|
+
/**
|
|
25
|
+
* Tenant, when set, makes it that team's own. Required for a schedule
|
|
26
|
+
* that starts a stored pipeline (the pipeline's tenant).
|
|
27
|
+
*
|
|
28
|
+
* @generated from field: string tenant = 2;
|
|
29
|
+
*/
|
|
30
|
+
tenant: string;
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Describes the message xeonr.pipelines.v1.ScheduleOwner.
|
|
34
|
+
* Use `create(ScheduleOwnerSchema)` to create a new message.
|
|
35
|
+
*/
|
|
36
|
+
export declare const ScheduleOwnerSchema: GenMessage<ScheduleOwner>;
|
|
37
|
+
/**
|
|
38
|
+
* ScheduleName names a schedule by its owner and its name.
|
|
39
|
+
*
|
|
40
|
+
* @generated from message xeonr.pipelines.v1.ScheduleName
|
|
41
|
+
*/
|
|
42
|
+
export type ScheduleName = Message<"xeonr.pipelines.v1.ScheduleName"> & {
|
|
43
|
+
/**
|
|
44
|
+
* @generated from field: xeonr.pipelines.v1.ScheduleOwner owner = 1;
|
|
45
|
+
*/
|
|
46
|
+
owner?: ScheduleOwner | undefined;
|
|
47
|
+
/**
|
|
48
|
+
* @generated from field: string name = 2;
|
|
49
|
+
*/
|
|
50
|
+
name: string;
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Describes the message xeonr.pipelines.v1.ScheduleName.
|
|
54
|
+
* Use `create(ScheduleNameSchema)` to create a new message.
|
|
55
|
+
*/
|
|
56
|
+
export declare const ScheduleNameSchema: GenMessage<ScheduleName>;
|
|
57
|
+
/**
|
|
58
|
+
* SchedulePipelineTarget starts a published version of a stored pipeline.
|
|
59
|
+
*
|
|
60
|
+
* @generated from message xeonr.pipelines.v1.SchedulePipelineTarget
|
|
61
|
+
*/
|
|
62
|
+
export type SchedulePipelineTarget = Message<"xeonr.pipelines.v1.SchedulePipelineTarget"> & {
|
|
63
|
+
/**
|
|
64
|
+
* @generated from field: string pipeline_id = 1;
|
|
65
|
+
*/
|
|
66
|
+
pipelineId: string;
|
|
67
|
+
/**
|
|
68
|
+
* Version is the version to run; 0 is the latest published when the
|
|
69
|
+
* occurrence fires.
|
|
70
|
+
*
|
|
71
|
+
* @generated from field: uint32 version = 2;
|
|
72
|
+
*/
|
|
73
|
+
version: number;
|
|
74
|
+
/**
|
|
75
|
+
* Resource is what each run is about, unless a target gives its own.
|
|
76
|
+
* Unset is the pipeline's scope.
|
|
77
|
+
*
|
|
78
|
+
* @generated from field: xeonr.pipelines.v1.Resource resource = 3;
|
|
79
|
+
*/
|
|
80
|
+
resource?: Resource | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* Variables are each run's variables, merged under a target's `args`.
|
|
83
|
+
*
|
|
84
|
+
* @generated from field: google.protobuf.Struct variables = 4;
|
|
85
|
+
*/
|
|
86
|
+
variables?: JsonObject | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* AttestedFacts are each run's facts, attested by the schedule's product
|
|
89
|
+
* as it would on CreateRun. A schedule set by a person carries none.
|
|
90
|
+
*
|
|
91
|
+
* @generated from field: google.protobuf.Struct attested_facts = 5;
|
|
92
|
+
*/
|
|
93
|
+
attestedFacts?: JsonObject | undefined;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* Describes the message xeonr.pipelines.v1.SchedulePipelineTarget.
|
|
97
|
+
* Use `create(SchedulePipelineTargetSchema)` to create a new message.
|
|
98
|
+
*/
|
|
99
|
+
export declare const SchedulePipelineTargetSchema: GenMessage<SchedulePipelineTarget>;
|
|
100
|
+
/**
|
|
101
|
+
* ScheduleJobTarget creates a job to a worker handler, as CreateJob does.
|
|
102
|
+
*
|
|
103
|
+
* @generated from message xeonr.pipelines.v1.ScheduleJobTarget
|
|
104
|
+
*/
|
|
105
|
+
export type ScheduleJobTarget = Message<"xeonr.pipelines.v1.ScheduleJobTarget"> & {
|
|
106
|
+
/**
|
|
107
|
+
* Handler is the worker handler, `<namespace>/<name>`, of the schedule's
|
|
108
|
+
* product.
|
|
109
|
+
*
|
|
110
|
+
* @generated from field: string handler = 1;
|
|
111
|
+
*/
|
|
112
|
+
handler: string;
|
|
113
|
+
/**
|
|
114
|
+
* Payload is each job's inputs, merged under a target's `args`.
|
|
115
|
+
*
|
|
116
|
+
* @generated from field: google.protobuf.Struct payload = 2;
|
|
117
|
+
*/
|
|
118
|
+
payload?: JsonObject | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* Queue, Retry, Timeout and Interruptible are as on CreateJobRequest.
|
|
121
|
+
*
|
|
122
|
+
* @generated from field: string queue = 3;
|
|
123
|
+
*/
|
|
124
|
+
queue: string;
|
|
125
|
+
/**
|
|
126
|
+
* @generated from field: xeonr.pipelines.v1.Retry retry = 4;
|
|
127
|
+
*/
|
|
128
|
+
retry?: Retry | undefined;
|
|
129
|
+
/**
|
|
130
|
+
* @generated from field: google.protobuf.Duration timeout = 5;
|
|
131
|
+
*/
|
|
132
|
+
timeout?: Duration | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* @generated from field: bool interruptible = 6;
|
|
135
|
+
*/
|
|
136
|
+
interruptible: boolean;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Describes the message xeonr.pipelines.v1.ScheduleJobTarget.
|
|
140
|
+
* Use `create(ScheduleJobTargetSchema)` to create a new message.
|
|
141
|
+
*/
|
|
142
|
+
export declare const ScheduleJobTargetSchema: GenMessage<ScheduleJobTarget>;
|
|
143
|
+
/**
|
|
144
|
+
* ScheduleTarget is one thing an occurrence fans out to.
|
|
145
|
+
*
|
|
146
|
+
* @generated from message xeonr.pipelines.v1.ScheduleTarget
|
|
147
|
+
*/
|
|
148
|
+
export type ScheduleTarget = Message<"xeonr.pipelines.v1.ScheduleTarget"> & {
|
|
149
|
+
/**
|
|
150
|
+
* Key identifies the target across occurrences ("server:42",
|
|
151
|
+
* "account:7"): with the schedule and the time it makes the occurrence
|
|
152
|
+
* unique, and it is the grain `queue_while_pending` checks. Unique in a
|
|
153
|
+
* list.
|
|
154
|
+
*
|
|
155
|
+
* @generated from field: string key = 1;
|
|
156
|
+
*/
|
|
157
|
+
key: string;
|
|
158
|
+
/**
|
|
159
|
+
* Tenant is the team the target's run belongs to. Empty is the
|
|
160
|
+
* schedule's own team; required for a product-wide schedule, and one the
|
|
161
|
+
* product acts for.
|
|
162
|
+
*
|
|
163
|
+
* @generated from field: string tenant = 2;
|
|
164
|
+
*/
|
|
165
|
+
tenant: string;
|
|
166
|
+
/**
|
|
167
|
+
* Resource is what the target's run is about, in place of the target
|
|
168
|
+
* spec's.
|
|
169
|
+
*
|
|
170
|
+
* @generated from field: xeonr.pipelines.v1.Resource resource = 3;
|
|
171
|
+
*/
|
|
172
|
+
resource?: Resource | undefined;
|
|
173
|
+
/**
|
|
174
|
+
* Args are merged over the target spec's variables (a pipeline) or
|
|
175
|
+
* payload (a job). At most 16 KiB encoded.
|
|
176
|
+
*
|
|
177
|
+
* @generated from field: google.protobuf.Struct args = 4;
|
|
178
|
+
*/
|
|
179
|
+
args?: JsonObject | undefined;
|
|
180
|
+
};
|
|
181
|
+
/**
|
|
182
|
+
* Describes the message xeonr.pipelines.v1.ScheduleTarget.
|
|
183
|
+
* Use `create(ScheduleTargetSchema)` to create a new message.
|
|
184
|
+
*/
|
|
185
|
+
export declare const ScheduleTargetSchema: GenMessage<ScheduleTarget>;
|
|
186
|
+
/**
|
|
187
|
+
* ScheduleTargetList is a stored list of targets.
|
|
188
|
+
*
|
|
189
|
+
* @generated from message xeonr.pipelines.v1.ScheduleTargetList
|
|
190
|
+
*/
|
|
191
|
+
export type ScheduleTargetList = Message<"xeonr.pipelines.v1.ScheduleTargetList"> & {
|
|
192
|
+
/**
|
|
193
|
+
* @generated from field: repeated xeonr.pipelines.v1.ScheduleTarget targets = 1;
|
|
194
|
+
*/
|
|
195
|
+
targets: ScheduleTarget[];
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* Describes the message xeonr.pipelines.v1.ScheduleTargetList.
|
|
199
|
+
* Use `create(ScheduleTargetListSchema)` to create a new message.
|
|
200
|
+
*/
|
|
201
|
+
export declare const ScheduleTargetListSchema: GenMessage<ScheduleTargetList>;
|
|
202
|
+
/**
|
|
203
|
+
* Enumeration says where a schedule's targets come from at each occurrence.
|
|
204
|
+
* Unset is one target: the schedule's own team and the target spec as given.
|
|
205
|
+
*
|
|
206
|
+
* @generated from message xeonr.pipelines.v1.Enumeration
|
|
207
|
+
*/
|
|
208
|
+
export type Enumeration = Message<"xeonr.pipelines.v1.Enumeration"> & {
|
|
209
|
+
/**
|
|
210
|
+
* @generated from oneof xeonr.pipelines.v1.Enumeration.source
|
|
211
|
+
*/
|
|
212
|
+
source: {
|
|
213
|
+
/**
|
|
214
|
+
* List is a stored list, changed by setting the schedule again.
|
|
215
|
+
*
|
|
216
|
+
* @generated from field: xeonr.pipelines.v1.ScheduleTargetList list = 1;
|
|
217
|
+
*/
|
|
218
|
+
value: ScheduleTargetList;
|
|
219
|
+
case: "list";
|
|
220
|
+
} | {
|
|
221
|
+
/**
|
|
222
|
+
* Handler is a worker handler of the schedule's product, run as a job
|
|
223
|
+
* (in the schedule's queue, at the schedule's tenant or, product-wide,
|
|
224
|
+
* with no tenant of its own) at each occurrence, before anything
|
|
225
|
+
* else. Its kv output `targets` is a JSON array of ScheduleTarget, in
|
|
226
|
+
* its JSON form. When it fails or the list is invalid, the occurrence
|
|
227
|
+
* fires nothing and is recorded ENUMERATION_FAILED.
|
|
228
|
+
*
|
|
229
|
+
* @generated from field: string handler = 2;
|
|
230
|
+
*/
|
|
231
|
+
value: string;
|
|
232
|
+
case: "handler";
|
|
233
|
+
} | {
|
|
234
|
+
case: undefined;
|
|
235
|
+
value?: undefined;
|
|
236
|
+
};
|
|
237
|
+
/**
|
|
238
|
+
* MaxTargets refuses a list longer than this (ENUMERATION_FAILED) rather
|
|
239
|
+
* than fire part of it. Zero is the platform's default of 1,000; the most
|
|
240
|
+
* is 10,000.
|
|
241
|
+
*
|
|
242
|
+
* @generated from field: uint32 max_targets = 3;
|
|
243
|
+
*/
|
|
244
|
+
maxTargets: number;
|
|
245
|
+
};
|
|
246
|
+
/**
|
|
247
|
+
* Describes the message xeonr.pipelines.v1.Enumeration.
|
|
248
|
+
* Use `create(EnumerationSchema)` to create a new message.
|
|
249
|
+
*/
|
|
250
|
+
export declare const EnumerationSchema: GenMessage<Enumeration>;
|
|
251
|
+
/**
|
|
252
|
+
* ScheduleOverride is what an owner may change about a declared schedule:
|
|
253
|
+
* the cron expression and the enabled flag, nothing else (XMB's
|
|
254
|
+
* ScheduleOverride).
|
|
255
|
+
*
|
|
256
|
+
* @generated from message xeonr.pipelines.v1.ScheduleOverride
|
|
257
|
+
*/
|
|
258
|
+
export type ScheduleOverride = Message<"xeonr.pipelines.v1.ScheduleOverride"> & {
|
|
259
|
+
/**
|
|
260
|
+
* Cron, when set, replaces the declared expression; set to empty, it
|
|
261
|
+
* makes the schedule run-now only.
|
|
262
|
+
*
|
|
263
|
+
* @generated from field: optional string cron = 1;
|
|
264
|
+
*/
|
|
265
|
+
cron?: string | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* Enabled, when set, replaces the declared flag.
|
|
268
|
+
*
|
|
269
|
+
* @generated from field: optional bool enabled = 2;
|
|
270
|
+
*/
|
|
271
|
+
enabled?: boolean | undefined;
|
|
272
|
+
/**
|
|
273
|
+
* SetBy and SetAt say who set it and when. Set by the platform.
|
|
274
|
+
*
|
|
275
|
+
* @generated from field: string set_by = 3;
|
|
276
|
+
*/
|
|
277
|
+
setBy: string;
|
|
278
|
+
/**
|
|
279
|
+
* @generated from field: google.protobuf.Timestamp set_at = 4;
|
|
280
|
+
*/
|
|
281
|
+
setAt?: Timestamp | undefined;
|
|
282
|
+
};
|
|
283
|
+
/**
|
|
284
|
+
* Describes the message xeonr.pipelines.v1.ScheduleOverride.
|
|
285
|
+
* Use `create(ScheduleOverrideSchema)` to create a new message.
|
|
286
|
+
*/
|
|
287
|
+
export declare const ScheduleOverrideSchema: GenMessage<ScheduleOverride>;
|
|
288
|
+
/**
|
|
289
|
+
* Schedule is a cron schedule and what it starts.
|
|
290
|
+
*
|
|
291
|
+
* @generated from message xeonr.pipelines.v1.Schedule
|
|
292
|
+
*/
|
|
293
|
+
export type Schedule = Message<"xeonr.pipelines.v1.Schedule"> & {
|
|
294
|
+
/**
|
|
295
|
+
* ID is assigned by the platform. Empty in a request that creates.
|
|
296
|
+
*
|
|
297
|
+
* @generated from field: string id = 1;
|
|
298
|
+
*/
|
|
299
|
+
id: string;
|
|
300
|
+
/**
|
|
301
|
+
* Owner is fixed when the schedule is created.
|
|
302
|
+
*
|
|
303
|
+
* @generated from field: xeonr.pipelines.v1.ScheduleOwner owner = 2;
|
|
304
|
+
*/
|
|
305
|
+
owner?: ScheduleOwner | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* Name is unique per owner and never renamed: history is keyed by it
|
|
308
|
+
* (XMB's task key). Convention `<area>.<verb>`.
|
|
309
|
+
*
|
|
310
|
+
* @generated from field: string name = 3;
|
|
311
|
+
*/
|
|
312
|
+
name: string;
|
|
313
|
+
/**
|
|
314
|
+
* @generated from field: string description = 4;
|
|
315
|
+
*/
|
|
316
|
+
description: string;
|
|
317
|
+
/**
|
|
318
|
+
* Cron is the declared expression, in standard five-field form or a
|
|
319
|
+
* descriptor (`@hourly`, `@daily`). Empty is run-now only.
|
|
320
|
+
*
|
|
321
|
+
* @generated from field: string cron = 5;
|
|
322
|
+
*/
|
|
323
|
+
cron: string;
|
|
324
|
+
/**
|
|
325
|
+
* CronLabel is the declared expression in plain words ("Every day at
|
|
326
|
+
* 4am"), written by its author. A console shows it while the declared
|
|
327
|
+
* expression applies, and the raw expression once overridden.
|
|
328
|
+
*
|
|
329
|
+
* @generated from field: string cron_label = 6;
|
|
330
|
+
*/
|
|
331
|
+
cronLabel: string;
|
|
332
|
+
/**
|
|
333
|
+
* TimeZone is the IANA zone the expression is read in. Empty is UTC.
|
|
334
|
+
* Occurrences are stored in UTC.
|
|
335
|
+
*
|
|
336
|
+
* @generated from field: string time_zone = 7;
|
|
337
|
+
*/
|
|
338
|
+
timeZone: string;
|
|
339
|
+
/**
|
|
340
|
+
* Enabled is the declared flag. A disabled schedule fires nothing and is
|
|
341
|
+
* still listed.
|
|
342
|
+
*
|
|
343
|
+
* @generated from field: bool enabled = 8;
|
|
344
|
+
*/
|
|
345
|
+
enabled: boolean;
|
|
346
|
+
/**
|
|
347
|
+
* Target is what each occurrence starts.
|
|
348
|
+
*
|
|
349
|
+
* @generated from oneof xeonr.pipelines.v1.Schedule.target
|
|
350
|
+
*/
|
|
351
|
+
target: {
|
|
352
|
+
/**
|
|
353
|
+
* @generated from field: xeonr.pipelines.v1.SchedulePipelineTarget pipeline = 9;
|
|
354
|
+
*/
|
|
355
|
+
value: SchedulePipelineTarget;
|
|
356
|
+
case: "pipeline";
|
|
357
|
+
} | {
|
|
358
|
+
/**
|
|
359
|
+
* @generated from field: xeonr.pipelines.v1.ScheduleJobTarget job = 10;
|
|
360
|
+
*/
|
|
361
|
+
value: ScheduleJobTarget;
|
|
362
|
+
case: "job";
|
|
363
|
+
} | {
|
|
364
|
+
case: undefined;
|
|
365
|
+
value?: undefined;
|
|
366
|
+
};
|
|
367
|
+
/**
|
|
368
|
+
* Enumerate, when set, fans each occurrence out to many targets.
|
|
369
|
+
*
|
|
370
|
+
* @generated from field: xeonr.pipelines.v1.Enumeration enumerate = 11;
|
|
371
|
+
*/
|
|
372
|
+
enumerate?: Enumeration | undefined;
|
|
373
|
+
/**
|
|
374
|
+
* @generated from field: xeonr.pipelines.v1.MisfirePolicy misfire = 12;
|
|
375
|
+
*/
|
|
376
|
+
misfire: MisfirePolicy;
|
|
377
|
+
/**
|
|
378
|
+
* CatchupWindow is how stale a missed occurrence may be and still fire,
|
|
379
|
+
* under LATEST. Unset is one hour; the most is seven days.
|
|
380
|
+
*
|
|
381
|
+
* @generated from field: google.protobuf.Duration catchup_window = 13;
|
|
382
|
+
*/
|
|
383
|
+
catchupWindow?: Duration | undefined;
|
|
384
|
+
/**
|
|
385
|
+
* QueueWhilePending lets an occurrence fire although a run of the same
|
|
386
|
+
* schedule and target is still queued or running. Off by default: see
|
|
387
|
+
* SchedulesService.
|
|
388
|
+
*
|
|
389
|
+
* @generated from field: bool queue_while_pending = 14;
|
|
390
|
+
*/
|
|
391
|
+
queueWhilePending: boolean;
|
|
392
|
+
/**
|
|
393
|
+
* Routine marks a high-frequency housekeeping schedule whose clean runs
|
|
394
|
+
* are noise: a console's recent activity leaves out its runs that
|
|
395
|
+
* succeeded with no issues, unless asked. A failed run, or one with
|
|
396
|
+
* issues, always shows.
|
|
397
|
+
*
|
|
398
|
+
* @generated from field: bool routine = 15;
|
|
399
|
+
*/
|
|
400
|
+
routine: boolean;
|
|
401
|
+
/**
|
|
402
|
+
* Override is the owner's override, kept across SetSchedule. Set only
|
|
403
|
+
* by SetScheduleOverride.
|
|
404
|
+
*
|
|
405
|
+
* @generated from field: xeonr.pipelines.v1.ScheduleOverride override = 16;
|
|
406
|
+
*/
|
|
407
|
+
override?: ScheduleOverride | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* EffectiveCron and EffectiveEnabled are what applies: the override's
|
|
410
|
+
* where it has one, else the declaration's. CronOverridden says the
|
|
411
|
+
* expression is the override's. Set by the platform.
|
|
412
|
+
*
|
|
413
|
+
* @generated from field: string effective_cron = 17;
|
|
414
|
+
*/
|
|
415
|
+
effectiveCron: string;
|
|
416
|
+
/**
|
|
417
|
+
* @generated from field: bool effective_enabled = 18;
|
|
418
|
+
*/
|
|
419
|
+
effectiveEnabled: boolean;
|
|
420
|
+
/**
|
|
421
|
+
* @generated from field: bool cron_overridden = 19;
|
|
422
|
+
*/
|
|
423
|
+
cronOverridden: boolean;
|
|
424
|
+
/**
|
|
425
|
+
* Paused is set by MarkSchedulePaused and cleared by MarkScheduleResumed.
|
|
426
|
+
*
|
|
427
|
+
* @generated from field: bool paused = 20;
|
|
428
|
+
*/
|
|
429
|
+
paused: boolean;
|
|
430
|
+
/**
|
|
431
|
+
* @generated from field: google.protobuf.Timestamp paused_at = 21;
|
|
432
|
+
*/
|
|
433
|
+
pausedAt?: Timestamp | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* @generated from field: string paused_by = 22;
|
|
436
|
+
*/
|
|
437
|
+
pausedBy: string;
|
|
438
|
+
/**
|
|
439
|
+
* NextOccurrence is the next time it will fire, computed when read;
|
|
440
|
+
* unset when disabled, paused or run-now only.
|
|
441
|
+
*
|
|
442
|
+
* @generated from field: google.protobuf.Timestamp next_occurrence = 23;
|
|
443
|
+
*/
|
|
444
|
+
nextOccurrence?: Timestamp | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* LastOccurrence is the most recent time it fired.
|
|
447
|
+
*
|
|
448
|
+
* @generated from field: google.protobuf.Timestamp last_occurrence = 24;
|
|
449
|
+
*/
|
|
450
|
+
lastOccurrence?: Timestamp | undefined;
|
|
451
|
+
/**
|
|
452
|
+
* @generated from field: google.protobuf.Timestamp created_at = 25;
|
|
453
|
+
*/
|
|
454
|
+
createdAt?: Timestamp | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* @generated from field: google.protobuf.Timestamp updated_at = 26;
|
|
457
|
+
*/
|
|
458
|
+
updatedAt?: Timestamp | undefined;
|
|
459
|
+
};
|
|
460
|
+
/**
|
|
461
|
+
* Describes the message xeonr.pipelines.v1.Schedule.
|
|
462
|
+
* Use `create(ScheduleSchema)` to create a new message.
|
|
463
|
+
*/
|
|
464
|
+
export declare const ScheduleSchema: GenMessage<Schedule>;
|
|
465
|
+
/**
|
|
466
|
+
* ScheduleOccurrence is one target of one fired occurrence, or one upcoming
|
|
467
|
+
* occurrence.
|
|
468
|
+
*
|
|
469
|
+
* @generated from message xeonr.pipelines.v1.ScheduleOccurrence
|
|
470
|
+
*/
|
|
471
|
+
export type ScheduleOccurrence = Message<"xeonr.pipelines.v1.ScheduleOccurrence"> & {
|
|
472
|
+
/**
|
|
473
|
+
* @generated from field: google.protobuf.Timestamp scheduled_for = 1;
|
|
474
|
+
*/
|
|
475
|
+
scheduledFor?: Timestamp | undefined;
|
|
476
|
+
/**
|
|
477
|
+
* TargetKey is the target's key; empty for a schedule with one target.
|
|
478
|
+
*
|
|
479
|
+
* @generated from field: string target_key = 2;
|
|
480
|
+
*/
|
|
481
|
+
targetKey: string;
|
|
482
|
+
/**
|
|
483
|
+
* @generated from field: string tenant = 3;
|
|
484
|
+
*/
|
|
485
|
+
tenant: string;
|
|
486
|
+
/**
|
|
487
|
+
* Outcome is unset for an upcoming occurrence.
|
|
488
|
+
*
|
|
489
|
+
* @generated from field: xeonr.pipelines.v1.OccurrenceOutcome outcome = 4;
|
|
490
|
+
*/
|
|
491
|
+
outcome: OccurrenceOutcome;
|
|
492
|
+
/**
|
|
493
|
+
* RunID and RunState are the run it started.
|
|
494
|
+
*
|
|
495
|
+
* @generated from field: string run_id = 5;
|
|
496
|
+
*/
|
|
497
|
+
runId: string;
|
|
498
|
+
/**
|
|
499
|
+
* @generated from field: xeonr.pipelines.v1.RunState run_state = 6;
|
|
500
|
+
*/
|
|
501
|
+
runState: RunState;
|
|
502
|
+
/**
|
|
503
|
+
* Message says why no run started, for SKIPPED, ENUMERATION_FAILED and
|
|
504
|
+
* REFUSED.
|
|
505
|
+
*
|
|
506
|
+
* @generated from field: string message = 7;
|
|
507
|
+
*/
|
|
508
|
+
message: string;
|
|
509
|
+
/**
|
|
510
|
+
* @generated from field: google.protobuf.Timestamp fired_at = 8;
|
|
511
|
+
*/
|
|
512
|
+
firedAt?: Timestamp | undefined;
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* Describes the message xeonr.pipelines.v1.ScheduleOccurrence.
|
|
516
|
+
* Use `create(ScheduleOccurrenceSchema)` to create a new message.
|
|
517
|
+
*/
|
|
518
|
+
export declare const ScheduleOccurrenceSchema: GenMessage<ScheduleOccurrence>;
|
|
519
|
+
/**
|
|
520
|
+
* @generated from message xeonr.pipelines.v1.SetScheduleRequest
|
|
521
|
+
*/
|
|
522
|
+
export type SetScheduleRequest = Message<"xeonr.pipelines.v1.SetScheduleRequest"> & {
|
|
523
|
+
/**
|
|
524
|
+
* Schedule is matched on (owner, name). Its `id`, when given, must be the
|
|
525
|
+
* matched schedule's.
|
|
526
|
+
*
|
|
527
|
+
* @generated from field: xeonr.pipelines.v1.Schedule schedule = 1;
|
|
528
|
+
*/
|
|
529
|
+
schedule?: Schedule | undefined;
|
|
530
|
+
/**
|
|
531
|
+
* UpdateMask narrows a write to an existing schedule to the fields it
|
|
532
|
+
* names. Ignored when the schedule is created.
|
|
533
|
+
*
|
|
534
|
+
* @generated from field: google.protobuf.FieldMask update_mask = 2;
|
|
535
|
+
*/
|
|
536
|
+
updateMask?: FieldMask | undefined;
|
|
537
|
+
};
|
|
538
|
+
/**
|
|
539
|
+
* Describes the message xeonr.pipelines.v1.SetScheduleRequest.
|
|
540
|
+
* Use `create(SetScheduleRequestSchema)` to create a new message.
|
|
541
|
+
*/
|
|
542
|
+
export declare const SetScheduleRequestSchema: GenMessage<SetScheduleRequest>;
|
|
543
|
+
/**
|
|
544
|
+
* @generated from message xeonr.pipelines.v1.SetScheduleResponse
|
|
545
|
+
*/
|
|
546
|
+
export type SetScheduleResponse = Message<"xeonr.pipelines.v1.SetScheduleResponse"> & {
|
|
547
|
+
/**
|
|
548
|
+
* @generated from field: xeonr.pipelines.v1.Schedule schedule = 1;
|
|
549
|
+
*/
|
|
550
|
+
schedule?: Schedule | undefined;
|
|
551
|
+
/**
|
|
552
|
+
* Created says the schedule did not exist before.
|
|
553
|
+
*
|
|
554
|
+
* @generated from field: bool created = 2;
|
|
555
|
+
*/
|
|
556
|
+
created: boolean;
|
|
557
|
+
};
|
|
558
|
+
/**
|
|
559
|
+
* Describes the message xeonr.pipelines.v1.SetScheduleResponse.
|
|
560
|
+
* Use `create(SetScheduleResponseSchema)` to create a new message.
|
|
561
|
+
*/
|
|
562
|
+
export declare const SetScheduleResponseSchema: GenMessage<SetScheduleResponse>;
|
|
563
|
+
/**
|
|
564
|
+
* @generated from message xeonr.pipelines.v1.GetScheduleRequest
|
|
565
|
+
*/
|
|
566
|
+
export type GetScheduleRequest = Message<"xeonr.pipelines.v1.GetScheduleRequest"> & {
|
|
567
|
+
/**
|
|
568
|
+
* @generated from oneof xeonr.pipelines.v1.GetScheduleRequest.schedule
|
|
569
|
+
*/
|
|
570
|
+
schedule: {
|
|
571
|
+
/**
|
|
572
|
+
* @generated from field: string schedule_id = 1;
|
|
573
|
+
*/
|
|
574
|
+
value: string;
|
|
575
|
+
case: "scheduleId";
|
|
576
|
+
} | {
|
|
577
|
+
/**
|
|
578
|
+
* @generated from field: xeonr.pipelines.v1.ScheduleName by_name = 2;
|
|
579
|
+
*/
|
|
580
|
+
value: ScheduleName;
|
|
581
|
+
case: "byName";
|
|
582
|
+
} | {
|
|
583
|
+
case: undefined;
|
|
584
|
+
value?: undefined;
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
/**
|
|
588
|
+
* Describes the message xeonr.pipelines.v1.GetScheduleRequest.
|
|
589
|
+
* Use `create(GetScheduleRequestSchema)` to create a new message.
|
|
590
|
+
*/
|
|
591
|
+
export declare const GetScheduleRequestSchema: GenMessage<GetScheduleRequest>;
|
|
592
|
+
/**
|
|
593
|
+
* @generated from message xeonr.pipelines.v1.GetScheduleResponse
|
|
594
|
+
*/
|
|
595
|
+
export type GetScheduleResponse = Message<"xeonr.pipelines.v1.GetScheduleResponse"> & {
|
|
596
|
+
/**
|
|
597
|
+
* @generated from field: xeonr.pipelines.v1.Schedule schedule = 1;
|
|
598
|
+
*/
|
|
599
|
+
schedule?: Schedule | undefined;
|
|
600
|
+
};
|
|
601
|
+
/**
|
|
602
|
+
* Describes the message xeonr.pipelines.v1.GetScheduleResponse.
|
|
603
|
+
* Use `create(GetScheduleResponseSchema)` to create a new message.
|
|
604
|
+
*/
|
|
605
|
+
export declare const GetScheduleResponseSchema: GenMessage<GetScheduleResponse>;
|
|
606
|
+
/**
|
|
607
|
+
* @generated from message xeonr.pipelines.v1.ListSchedulesRequest
|
|
608
|
+
*/
|
|
609
|
+
export type ListSchedulesRequest = Message<"xeonr.pipelines.v1.ListSchedulesRequest"> & {
|
|
610
|
+
/**
|
|
611
|
+
* Product is the Auth application whose schedules are listed. Empty is
|
|
612
|
+
* the caller's own.
|
|
613
|
+
*
|
|
614
|
+
* @generated from field: string product = 1;
|
|
615
|
+
*/
|
|
616
|
+
product: string;
|
|
617
|
+
/**
|
|
618
|
+
* Tenant narrows to that team's own schedules.
|
|
619
|
+
*
|
|
620
|
+
* @generated from field: string tenant = 2;
|
|
621
|
+
*/
|
|
622
|
+
tenant: string;
|
|
623
|
+
/**
|
|
624
|
+
* PipelineID narrows to the schedules that start one stored pipeline.
|
|
625
|
+
*
|
|
626
|
+
* @generated from field: string pipeline_id = 3;
|
|
627
|
+
*/
|
|
628
|
+
pipelineId: string;
|
|
629
|
+
/**
|
|
630
|
+
* Cursor is opaque, empty for the first page.
|
|
631
|
+
*
|
|
632
|
+
* @generated from field: string cursor = 4;
|
|
633
|
+
*/
|
|
634
|
+
cursor: string;
|
|
635
|
+
/**
|
|
636
|
+
* Limit is capped at 500; zero means the default of 50.
|
|
637
|
+
*
|
|
638
|
+
* @generated from field: uint32 limit = 5;
|
|
639
|
+
*/
|
|
640
|
+
limit: number;
|
|
641
|
+
};
|
|
642
|
+
/**
|
|
643
|
+
* Describes the message xeonr.pipelines.v1.ListSchedulesRequest.
|
|
644
|
+
* Use `create(ListSchedulesRequestSchema)` to create a new message.
|
|
645
|
+
*/
|
|
646
|
+
export declare const ListSchedulesRequestSchema: GenMessage<ListSchedulesRequest>;
|
|
647
|
+
/**
|
|
648
|
+
* @generated from message xeonr.pipelines.v1.ListSchedulesResponse
|
|
649
|
+
*/
|
|
650
|
+
export type ListSchedulesResponse = Message<"xeonr.pipelines.v1.ListSchedulesResponse"> & {
|
|
651
|
+
/**
|
|
652
|
+
* @generated from field: repeated xeonr.pipelines.v1.Schedule schedules = 1;
|
|
653
|
+
*/
|
|
654
|
+
schedules: Schedule[];
|
|
655
|
+
/**
|
|
656
|
+
* NextCursor is empty when there is no further page.
|
|
657
|
+
*
|
|
658
|
+
* @generated from field: string next_cursor = 2;
|
|
659
|
+
*/
|
|
660
|
+
nextCursor: string;
|
|
661
|
+
};
|
|
662
|
+
/**
|
|
663
|
+
* Describes the message xeonr.pipelines.v1.ListSchedulesResponse.
|
|
664
|
+
* Use `create(ListSchedulesResponseSchema)` to create a new message.
|
|
665
|
+
*/
|
|
666
|
+
export declare const ListSchedulesResponseSchema: GenMessage<ListSchedulesResponse>;
|
|
667
|
+
/**
|
|
668
|
+
* @generated from message xeonr.pipelines.v1.SetScheduleOverrideRequest
|
|
669
|
+
*/
|
|
670
|
+
export type SetScheduleOverrideRequest = Message<"xeonr.pipelines.v1.SetScheduleOverrideRequest"> & {
|
|
671
|
+
/**
|
|
672
|
+
* @generated from field: string schedule_id = 1;
|
|
673
|
+
*/
|
|
674
|
+
scheduleId: string;
|
|
675
|
+
/**
|
|
676
|
+
* Cron, when set, overrides the expression; empty makes it run-now only.
|
|
677
|
+
*
|
|
678
|
+
* @generated from field: optional string cron = 2;
|
|
679
|
+
*/
|
|
680
|
+
cron?: string | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* Enabled, when set, overrides the flag.
|
|
683
|
+
*
|
|
684
|
+
* validate:skip a bool has no bounds
|
|
685
|
+
*
|
|
686
|
+
* @generated from field: optional bool enabled = 3;
|
|
687
|
+
*/
|
|
688
|
+
enabled?: boolean | undefined;
|
|
689
|
+
};
|
|
690
|
+
/**
|
|
691
|
+
* Describes the message xeonr.pipelines.v1.SetScheduleOverrideRequest.
|
|
692
|
+
* Use `create(SetScheduleOverrideRequestSchema)` to create a new message.
|
|
693
|
+
*/
|
|
694
|
+
export declare const SetScheduleOverrideRequestSchema: GenMessage<SetScheduleOverrideRequest>;
|
|
695
|
+
/**
|
|
696
|
+
* @generated from message xeonr.pipelines.v1.SetScheduleOverrideResponse
|
|
697
|
+
*/
|
|
698
|
+
export type SetScheduleOverrideResponse = Message<"xeonr.pipelines.v1.SetScheduleOverrideResponse"> & {
|
|
699
|
+
/**
|
|
700
|
+
* @generated from field: xeonr.pipelines.v1.Schedule schedule = 1;
|
|
701
|
+
*/
|
|
702
|
+
schedule?: Schedule | undefined;
|
|
703
|
+
};
|
|
704
|
+
/**
|
|
705
|
+
* Describes the message xeonr.pipelines.v1.SetScheduleOverrideResponse.
|
|
706
|
+
* Use `create(SetScheduleOverrideResponseSchema)` to create a new message.
|
|
707
|
+
*/
|
|
708
|
+
export declare const SetScheduleOverrideResponseSchema: GenMessage<SetScheduleOverrideResponse>;
|
|
709
|
+
/**
|
|
710
|
+
* @generated from message xeonr.pipelines.v1.MarkSchedulePausedRequest
|
|
711
|
+
*/
|
|
712
|
+
export type MarkSchedulePausedRequest = Message<"xeonr.pipelines.v1.MarkSchedulePausedRequest"> & {
|
|
713
|
+
/**
|
|
714
|
+
* @generated from field: string schedule_id = 1;
|
|
715
|
+
*/
|
|
716
|
+
scheduleId: string;
|
|
717
|
+
};
|
|
718
|
+
/**
|
|
719
|
+
* Describes the message xeonr.pipelines.v1.MarkSchedulePausedRequest.
|
|
720
|
+
* Use `create(MarkSchedulePausedRequestSchema)` to create a new message.
|
|
721
|
+
*/
|
|
722
|
+
export declare const MarkSchedulePausedRequestSchema: GenMessage<MarkSchedulePausedRequest>;
|
|
723
|
+
/**
|
|
724
|
+
* @generated from message xeonr.pipelines.v1.MarkSchedulePausedResponse
|
|
725
|
+
*/
|
|
726
|
+
export type MarkSchedulePausedResponse = Message<"xeonr.pipelines.v1.MarkSchedulePausedResponse"> & {
|
|
727
|
+
/**
|
|
728
|
+
* @generated from field: xeonr.pipelines.v1.Schedule schedule = 1;
|
|
729
|
+
*/
|
|
730
|
+
schedule?: Schedule | undefined;
|
|
731
|
+
};
|
|
732
|
+
/**
|
|
733
|
+
* Describes the message xeonr.pipelines.v1.MarkSchedulePausedResponse.
|
|
734
|
+
* Use `create(MarkSchedulePausedResponseSchema)` to create a new message.
|
|
735
|
+
*/
|
|
736
|
+
export declare const MarkSchedulePausedResponseSchema: GenMessage<MarkSchedulePausedResponse>;
|
|
737
|
+
/**
|
|
738
|
+
* @generated from message xeonr.pipelines.v1.MarkScheduleResumedRequest
|
|
739
|
+
*/
|
|
740
|
+
export type MarkScheduleResumedRequest = Message<"xeonr.pipelines.v1.MarkScheduleResumedRequest"> & {
|
|
741
|
+
/**
|
|
742
|
+
* @generated from field: string schedule_id = 1;
|
|
743
|
+
*/
|
|
744
|
+
scheduleId: string;
|
|
745
|
+
};
|
|
746
|
+
/**
|
|
747
|
+
* Describes the message xeonr.pipelines.v1.MarkScheduleResumedRequest.
|
|
748
|
+
* Use `create(MarkScheduleResumedRequestSchema)` to create a new message.
|
|
749
|
+
*/
|
|
750
|
+
export declare const MarkScheduleResumedRequestSchema: GenMessage<MarkScheduleResumedRequest>;
|
|
751
|
+
/**
|
|
752
|
+
* @generated from message xeonr.pipelines.v1.MarkScheduleResumedResponse
|
|
753
|
+
*/
|
|
754
|
+
export type MarkScheduleResumedResponse = Message<"xeonr.pipelines.v1.MarkScheduleResumedResponse"> & {
|
|
755
|
+
/**
|
|
756
|
+
* @generated from field: xeonr.pipelines.v1.Schedule schedule = 1;
|
|
757
|
+
*/
|
|
758
|
+
schedule?: Schedule | undefined;
|
|
759
|
+
};
|
|
760
|
+
/**
|
|
761
|
+
* Describes the message xeonr.pipelines.v1.MarkScheduleResumedResponse.
|
|
762
|
+
* Use `create(MarkScheduleResumedResponseSchema)` to create a new message.
|
|
763
|
+
*/
|
|
764
|
+
export declare const MarkScheduleResumedResponseSchema: GenMessage<MarkScheduleResumedResponse>;
|
|
765
|
+
/**
|
|
766
|
+
* @generated from message xeonr.pipelines.v1.DeleteScheduleRequest
|
|
767
|
+
*/
|
|
768
|
+
export type DeleteScheduleRequest = Message<"xeonr.pipelines.v1.DeleteScheduleRequest"> & {
|
|
769
|
+
/**
|
|
770
|
+
* @generated from field: string schedule_id = 1;
|
|
771
|
+
*/
|
|
772
|
+
scheduleId: string;
|
|
773
|
+
};
|
|
774
|
+
/**
|
|
775
|
+
* Describes the message xeonr.pipelines.v1.DeleteScheduleRequest.
|
|
776
|
+
* Use `create(DeleteScheduleRequestSchema)` to create a new message.
|
|
777
|
+
*/
|
|
778
|
+
export declare const DeleteScheduleRequestSchema: GenMessage<DeleteScheduleRequest>;
|
|
779
|
+
/**
|
|
780
|
+
* @generated from message xeonr.pipelines.v1.DeleteScheduleResponse
|
|
781
|
+
*/
|
|
782
|
+
export type DeleteScheduleResponse = Message<"xeonr.pipelines.v1.DeleteScheduleResponse"> & {};
|
|
783
|
+
/**
|
|
784
|
+
* Describes the message xeonr.pipelines.v1.DeleteScheduleResponse.
|
|
785
|
+
* Use `create(DeleteScheduleResponseSchema)` to create a new message.
|
|
786
|
+
*/
|
|
787
|
+
export declare const DeleteScheduleResponseSchema: GenMessage<DeleteScheduleResponse>;
|
|
788
|
+
/**
|
|
789
|
+
* @generated from message xeonr.pipelines.v1.CreateScheduleRunRequest
|
|
790
|
+
*/
|
|
791
|
+
export type CreateScheduleRunRequest = Message<"xeonr.pipelines.v1.CreateScheduleRunRequest"> & {
|
|
792
|
+
/**
|
|
793
|
+
* @generated from field: string schedule_id = 1;
|
|
794
|
+
*/
|
|
795
|
+
scheduleId: string;
|
|
796
|
+
/**
|
|
797
|
+
* TargetKey runs only that target. Empty runs every target, enumerated
|
|
798
|
+
* now.
|
|
799
|
+
*
|
|
800
|
+
* @generated from field: string target_key = 2;
|
|
801
|
+
*/
|
|
802
|
+
targetKey: string;
|
|
803
|
+
/**
|
|
804
|
+
* Force runs a target although one of its runs is still pending.
|
|
805
|
+
*
|
|
806
|
+
* validate:skip a bool has no bounds
|
|
807
|
+
*
|
|
808
|
+
* @generated from field: bool force = 3;
|
|
809
|
+
*/
|
|
810
|
+
force: boolean;
|
|
811
|
+
};
|
|
812
|
+
/**
|
|
813
|
+
* Describes the message xeonr.pipelines.v1.CreateScheduleRunRequest.
|
|
814
|
+
* Use `create(CreateScheduleRunRequestSchema)` to create a new message.
|
|
815
|
+
*/
|
|
816
|
+
export declare const CreateScheduleRunRequestSchema: GenMessage<CreateScheduleRunRequest>;
|
|
817
|
+
/**
|
|
818
|
+
* @generated from message xeonr.pipelines.v1.CreateScheduleRunResponse
|
|
819
|
+
*/
|
|
820
|
+
export type CreateScheduleRunResponse = Message<"xeonr.pipelines.v1.CreateScheduleRunResponse"> & {
|
|
821
|
+
/**
|
|
822
|
+
* Runs are the runs started, one per target that was not skipped.
|
|
823
|
+
*
|
|
824
|
+
* @generated from field: repeated xeonr.pipelines.v1.Run runs = 1;
|
|
825
|
+
*/
|
|
826
|
+
runs: Run[];
|
|
827
|
+
/**
|
|
828
|
+
* Skipped counts targets skipped while pending.
|
|
829
|
+
*
|
|
830
|
+
* @generated from field: uint32 skipped = 2;
|
|
831
|
+
*/
|
|
832
|
+
skipped: number;
|
|
833
|
+
};
|
|
834
|
+
/**
|
|
835
|
+
* Describes the message xeonr.pipelines.v1.CreateScheduleRunResponse.
|
|
836
|
+
* Use `create(CreateScheduleRunResponseSchema)` to create a new message.
|
|
837
|
+
*/
|
|
838
|
+
export declare const CreateScheduleRunResponseSchema: GenMessage<CreateScheduleRunResponse>;
|
|
839
|
+
/**
|
|
840
|
+
* @generated from message xeonr.pipelines.v1.ListScheduleOccurrencesRequest
|
|
841
|
+
*/
|
|
842
|
+
export type ListScheduleOccurrencesRequest = Message<"xeonr.pipelines.v1.ListScheduleOccurrencesRequest"> & {
|
|
843
|
+
/**
|
|
844
|
+
* @generated from field: string schedule_id = 1;
|
|
845
|
+
*/
|
|
846
|
+
scheduleId: string;
|
|
847
|
+
/**
|
|
848
|
+
* Upcoming is how many future occurrences to compute. Zero means 5; the
|
|
849
|
+
* most is 50.
|
|
850
|
+
*
|
|
851
|
+
* @generated from field: uint32 upcoming = 2;
|
|
852
|
+
*/
|
|
853
|
+
upcoming: number;
|
|
854
|
+
/**
|
|
855
|
+
* Cursor is opaque, empty for the first page of past occurrences.
|
|
856
|
+
*
|
|
857
|
+
* @generated from field: string cursor = 3;
|
|
858
|
+
*/
|
|
859
|
+
cursor: string;
|
|
860
|
+
/**
|
|
861
|
+
* Limit is capped at 500; zero means the default of 50.
|
|
862
|
+
*
|
|
863
|
+
* @generated from field: uint32 limit = 4;
|
|
864
|
+
*/
|
|
865
|
+
limit: number;
|
|
866
|
+
};
|
|
867
|
+
/**
|
|
868
|
+
* Describes the message xeonr.pipelines.v1.ListScheduleOccurrencesRequest.
|
|
869
|
+
* Use `create(ListScheduleOccurrencesRequestSchema)` to create a new message.
|
|
870
|
+
*/
|
|
871
|
+
export declare const ListScheduleOccurrencesRequestSchema: GenMessage<ListScheduleOccurrencesRequest>;
|
|
872
|
+
/**
|
|
873
|
+
* @generated from message xeonr.pipelines.v1.ListScheduleOccurrencesResponse
|
|
874
|
+
*/
|
|
875
|
+
export type ListScheduleOccurrencesResponse = Message<"xeonr.pipelines.v1.ListScheduleOccurrencesResponse"> & {
|
|
876
|
+
/**
|
|
877
|
+
* Upcoming are the next occurrences, soonest first, with no outcome.
|
|
878
|
+
*
|
|
879
|
+
* @generated from field: repeated xeonr.pipelines.v1.ScheduleOccurrence upcoming = 1;
|
|
880
|
+
*/
|
|
881
|
+
upcoming: ScheduleOccurrence[];
|
|
882
|
+
/**
|
|
883
|
+
* Past are fired occurrences, newest first, one per target.
|
|
884
|
+
*
|
|
885
|
+
* @generated from field: repeated xeonr.pipelines.v1.ScheduleOccurrence past = 2;
|
|
886
|
+
*/
|
|
887
|
+
past: ScheduleOccurrence[];
|
|
888
|
+
/**
|
|
889
|
+
* NextCursor is empty when there is no further page.
|
|
890
|
+
*
|
|
891
|
+
* @generated from field: string next_cursor = 3;
|
|
892
|
+
*/
|
|
893
|
+
nextCursor: string;
|
|
894
|
+
};
|
|
895
|
+
/**
|
|
896
|
+
* Describes the message xeonr.pipelines.v1.ListScheduleOccurrencesResponse.
|
|
897
|
+
* Use `create(ListScheduleOccurrencesResponseSchema)` to create a new message.
|
|
898
|
+
*/
|
|
899
|
+
export declare const ListScheduleOccurrencesResponseSchema: GenMessage<ListScheduleOccurrencesResponse>;
|
|
900
|
+
/**
|
|
901
|
+
* MisfirePolicy is what a schedule does about occurrences it missed (the
|
|
902
|
+
* platform was down, or a tick ran late).
|
|
903
|
+
*
|
|
904
|
+
* @generated from enum xeonr.pipelines.v1.MisfirePolicy
|
|
905
|
+
*/
|
|
906
|
+
export declare enum MisfirePolicy {
|
|
907
|
+
/**
|
|
908
|
+
* The default: LATEST.
|
|
909
|
+
*
|
|
910
|
+
* @generated from enum value: MISFIRE_POLICY_UNSPECIFIED = 0;
|
|
911
|
+
*/
|
|
912
|
+
UNSPECIFIED = 0,
|
|
913
|
+
/**
|
|
914
|
+
* Fire the most recent missed occurrence, if it is within
|
|
915
|
+
* `catchup_window`, and no other.
|
|
916
|
+
*
|
|
917
|
+
* @generated from enum value: MISFIRE_POLICY_LATEST = 1;
|
|
918
|
+
*/
|
|
919
|
+
LATEST = 1,
|
|
920
|
+
/**
|
|
921
|
+
* Fire nothing that was missed.
|
|
922
|
+
*
|
|
923
|
+
* @generated from enum value: MISFIRE_POLICY_SKIP = 2;
|
|
924
|
+
*/
|
|
925
|
+
SKIP = 2
|
|
926
|
+
}
|
|
927
|
+
/**
|
|
928
|
+
* Describes the enum xeonr.pipelines.v1.MisfirePolicy.
|
|
929
|
+
*/
|
|
930
|
+
export declare const MisfirePolicySchema: GenEnum<MisfirePolicy>;
|
|
931
|
+
/**
|
|
932
|
+
* OccurrenceOutcome is what became of one target of one occurrence.
|
|
933
|
+
*
|
|
934
|
+
* @generated from enum xeonr.pipelines.v1.OccurrenceOutcome
|
|
935
|
+
*/
|
|
936
|
+
export declare enum OccurrenceOutcome {
|
|
937
|
+
/**
|
|
938
|
+
* @generated from enum value: OCCURRENCE_OUTCOME_UNSPECIFIED = 0;
|
|
939
|
+
*/
|
|
940
|
+
UNSPECIFIED = 0,
|
|
941
|
+
/**
|
|
942
|
+
* A run was started; `run_id` names it.
|
|
943
|
+
*
|
|
944
|
+
* @generated from enum value: OCCURRENCE_OUTCOME_STARTED = 1;
|
|
945
|
+
*/
|
|
946
|
+
STARTED = 1,
|
|
947
|
+
/**
|
|
948
|
+
* Skipped: a run of the same schedule and target was still queued or
|
|
949
|
+
* running, and `queue_while_pending` is off.
|
|
950
|
+
*
|
|
951
|
+
* @generated from enum value: OCCURRENCE_OUTCOME_SKIPPED_PENDING = 2;
|
|
952
|
+
*/
|
|
953
|
+
SKIPPED_PENDING = 2,
|
|
954
|
+
/**
|
|
955
|
+
* The enumeration handler failed or returned an invalid list, so no
|
|
956
|
+
* target was known; `message` says why.
|
|
957
|
+
*
|
|
958
|
+
* @generated from enum value: OCCURRENCE_OUTCOME_ENUMERATION_FAILED = 3;
|
|
959
|
+
*/
|
|
960
|
+
ENUMERATION_FAILED = 3,
|
|
961
|
+
/**
|
|
962
|
+
* The run could not be created (the pipeline archived, a quota, a
|
|
963
|
+
* refusal of CreateRun); `message` says why.
|
|
964
|
+
*
|
|
965
|
+
* @generated from enum value: OCCURRENCE_OUTCOME_REFUSED = 4;
|
|
966
|
+
*/
|
|
967
|
+
REFUSED = 4
|
|
968
|
+
}
|
|
969
|
+
/**
|
|
970
|
+
* Describes the enum xeonr.pipelines.v1.OccurrenceOutcome.
|
|
971
|
+
*/
|
|
972
|
+
export declare const OccurrenceOutcomeSchema: GenEnum<OccurrenceOutcome>;
|
|
973
|
+
/**
|
|
974
|
+
* SchedulesService holds cron schedules: platform-design §6.2's `cron`
|
|
975
|
+
* trigger and design-v1 §5.2, built to XMB's scheduler (`xeonr/xmb/api`
|
|
976
|
+
* `pkg/scheduler`), which the platform absorbs so that XMB can adopt it.
|
|
977
|
+
* Event triggers are not here: a product reacts to its own events and calls
|
|
978
|
+
* CreateRun. Milestone 4.
|
|
979
|
+
*
|
|
980
|
+
* A schedule starts, at each occurrence of its cron expression, either a
|
|
981
|
+
* published version of a stored pipeline or a job to a worker handler, once
|
|
982
|
+
* per target. Each occurrence is one row, unique on (schedule, target key,
|
|
983
|
+
* scheduled-for): every API replica computes the same occurrence and tries
|
|
984
|
+
* to insert it, and exactly one insert wins. There is no leader election,
|
|
985
|
+
* no last-run-at column and no lock: the unique index is the authority, so
|
|
986
|
+
* an occurrence fires at most once whatever the replicas, restarts or
|
|
987
|
+
* overlapping ticks. The next occurrence is a pure function of the clock
|
|
988
|
+
* and the expression, computed when read, never stored.
|
|
989
|
+
*
|
|
990
|
+
* Misfire. After an outage only the most recent missed occurrence within
|
|
991
|
+
* `catchup_window` is fired (policy LATEST), never a backlog: three days down
|
|
992
|
+
* fires one run, not seventy-two. SKIP fires none. The window must stay far
|
|
993
|
+
* below the platform's run retention, or a pruned occurrence would fire
|
|
994
|
+
* twice (the server checks at boot).
|
|
995
|
+
*
|
|
996
|
+
* Overlap. Unless `queue_while_pending` is set, an occurrence is skipped
|
|
997
|
+
* while a run of the same schedule and target is still queued or running:
|
|
998
|
+
* a ten-minute job on a five-minute cron otherwise grows a queue that never
|
|
999
|
+
* drains, and the safe behaviour is the zero value.
|
|
1000
|
+
*
|
|
1001
|
+
* Override. A product declares its schedules (SetSchedule), typically at
|
|
1002
|
+
* boot, as XMB's code declares its tasks. The owner may override just the
|
|
1003
|
+
* cron expression and the enabled flag (SetScheduleOverride); the override
|
|
1004
|
+
* survives the product setting the schedule again, exactly as XMB's
|
|
1005
|
+
* `XMB_SCHEDULER_SCHEDULES` survives a deploy. `cron_overridden` tells a
|
|
1006
|
+
* console to show the expression rather than a `cron_label` that no longer
|
|
1007
|
+
* describes it.
|
|
1008
|
+
*
|
|
1009
|
+
* Enumeration. One schedule can fan out to many runs per occurrence, one per
|
|
1010
|
+
* target, re-enumerated at every occurrence so new tenants and resources are
|
|
1011
|
+
* picked up with no re-registration (platform-design §6.2, design-v1
|
|
1012
|
+
* §5.2). The platform does not resolve products' resources, so the product
|
|
1013
|
+
* supplies the list, in either of two ways: a stored list on the schedule,
|
|
1014
|
+
* for a small set that changes when the product says so (it sets the
|
|
1015
|
+
* schedule again); or a worker handler of the product, run as a job at each
|
|
1016
|
+
* occurrence, whose `targets` output is the list, for a set only the
|
|
1017
|
+
* product's database knows and that changes on its own (XMB's per-server
|
|
1018
|
+
* tasks enumerate servers from its database). Both exist because neither
|
|
1019
|
+
* covers the other: a stored list cannot follow the product's data, and a
|
|
1020
|
+
* handler is a worker the product must run.
|
|
1021
|
+
*
|
|
1022
|
+
* Ownership, like queues: a schedule belongs to one product (the caller's,
|
|
1023
|
+
* from its token), and optionally to one team. A product-wide schedule may
|
|
1024
|
+
* enumerate targets across the tenants the product acts for; a team's
|
|
1025
|
+
* schedule runs only for that team. A schedule that starts a stored
|
|
1026
|
+
* pipeline must be its tenant's. Set and changed by the product's service
|
|
1027
|
+
* accounts, the operators and, for a team's schedule, that team's members;
|
|
1028
|
+
* the override, pause and run-now likewise. A schedule the caller may not
|
|
1029
|
+
* read answers `not_found`.
|
|
1030
|
+
*
|
|
1031
|
+
* Verbs outside api.rpc-naming's: none. CreateScheduleRun creates a run;
|
|
1032
|
+
* MarkSchedulePaused and MarkScheduleResumed use `Mark`.
|
|
1033
|
+
*
|
|
1034
|
+
* @generated from service xeonr.pipelines.v1.SchedulesService
|
|
1035
|
+
*/
|
|
1036
|
+
export declare const SchedulesService: GenService<{
|
|
1037
|
+
/**
|
|
1038
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.SetSchedule
|
|
1039
|
+
*/
|
|
1040
|
+
setSchedule: {
|
|
1041
|
+
methodKind: "unary";
|
|
1042
|
+
input: typeof SetScheduleRequestSchema;
|
|
1043
|
+
output: typeof SetScheduleResponseSchema;
|
|
1044
|
+
};
|
|
1045
|
+
/**
|
|
1046
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.GetSchedule
|
|
1047
|
+
*/
|
|
1048
|
+
getSchedule: {
|
|
1049
|
+
methodKind: "unary";
|
|
1050
|
+
input: typeof GetScheduleRequestSchema;
|
|
1051
|
+
output: typeof GetScheduleResponseSchema;
|
|
1052
|
+
};
|
|
1053
|
+
/**
|
|
1054
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.ListSchedules
|
|
1055
|
+
*/
|
|
1056
|
+
listSchedules: {
|
|
1057
|
+
methodKind: "unary";
|
|
1058
|
+
input: typeof ListSchedulesRequestSchema;
|
|
1059
|
+
output: typeof ListSchedulesResponseSchema;
|
|
1060
|
+
};
|
|
1061
|
+
/**
|
|
1062
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.SetScheduleOverride
|
|
1063
|
+
*/
|
|
1064
|
+
setScheduleOverride: {
|
|
1065
|
+
methodKind: "unary";
|
|
1066
|
+
input: typeof SetScheduleOverrideRequestSchema;
|
|
1067
|
+
output: typeof SetScheduleOverrideResponseSchema;
|
|
1068
|
+
};
|
|
1069
|
+
/**
|
|
1070
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.MarkSchedulePaused
|
|
1071
|
+
*/
|
|
1072
|
+
markSchedulePaused: {
|
|
1073
|
+
methodKind: "unary";
|
|
1074
|
+
input: typeof MarkSchedulePausedRequestSchema;
|
|
1075
|
+
output: typeof MarkSchedulePausedResponseSchema;
|
|
1076
|
+
};
|
|
1077
|
+
/**
|
|
1078
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.MarkScheduleResumed
|
|
1079
|
+
*/
|
|
1080
|
+
markScheduleResumed: {
|
|
1081
|
+
methodKind: "unary";
|
|
1082
|
+
input: typeof MarkScheduleResumedRequestSchema;
|
|
1083
|
+
output: typeof MarkScheduleResumedResponseSchema;
|
|
1084
|
+
};
|
|
1085
|
+
/**
|
|
1086
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.DeleteSchedule
|
|
1087
|
+
*/
|
|
1088
|
+
deleteSchedule: {
|
|
1089
|
+
methodKind: "unary";
|
|
1090
|
+
input: typeof DeleteScheduleRequestSchema;
|
|
1091
|
+
output: typeof DeleteScheduleResponseSchema;
|
|
1092
|
+
};
|
|
1093
|
+
/**
|
|
1094
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.CreateScheduleRun
|
|
1095
|
+
*/
|
|
1096
|
+
createScheduleRun: {
|
|
1097
|
+
methodKind: "unary";
|
|
1098
|
+
input: typeof CreateScheduleRunRequestSchema;
|
|
1099
|
+
output: typeof CreateScheduleRunResponseSchema;
|
|
1100
|
+
};
|
|
1101
|
+
/**
|
|
1102
|
+
* @generated from rpc xeonr.pipelines.v1.SchedulesService.ListScheduleOccurrences
|
|
1103
|
+
*/
|
|
1104
|
+
listScheduleOccurrences: {
|
|
1105
|
+
methodKind: "unary";
|
|
1106
|
+
input: typeof ListScheduleOccurrencesRequestSchema;
|
|
1107
|
+
output: typeof ListScheduleOccurrencesResponseSchema;
|
|
1108
|
+
};
|
|
1109
|
+
}>;
|
|
1110
|
+
//# sourceMappingURL=schedules_pb.d.ts.map
|