-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathautomation.go
More file actions
3866 lines (3506 loc) · 151 KB
/
automation.go
File metadata and controls
3866 lines (3506 loc) · 151 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package gitpod
import (
"context"
"net/http"
"net/url"
"slices"
"time"
"github.com/gitpod-io/gitpod-sdk-go/internal/apijson"
"github.com/gitpod-io/gitpod-sdk-go/internal/apiquery"
"github.com/gitpod-io/gitpod-sdk-go/internal/param"
"github.com/gitpod-io/gitpod-sdk-go/internal/requestconfig"
"github.com/gitpod-io/gitpod-sdk-go/option"
"github.com/gitpod-io/gitpod-sdk-go/packages/pagination"
"github.com/gitpod-io/gitpod-sdk-go/shared"
)
// AutomationService contains methods and other services that help with interacting
// with the gitpod API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewAutomationService] method instead.
type AutomationService struct {
Options []option.RequestOption
}
// NewAutomationService generates a new service that applies the given options to
// each request. These options are applied after the parent client's options (if
// there is one), and before any request-specific options.
func NewAutomationService(opts ...option.RequestOption) (r *AutomationService) {
r = &AutomationService{}
r.Options = opts
return
}
// Creates a new workflow with specified configuration.
//
// Use this method to:
//
// - Set up automated workflows
// - Configure workflow triggers
// - Define workflow actions and steps
// - Set execution limits and constraints
func (r *AutomationService) New(ctx context.Context, body AutomationNewParams, opts ...option.RequestOption) (res *AutomationNewResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/CreateWorkflow"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Gets details about a specific workflow.
//
// Use this method to:
//
// - View workflow configuration
// - Check workflow status
// - Get workflow metadata
//
// ### Examples
//
// - Get workflow details:
//
// Retrieves information about a specific workflow.
//
// ```yaml
// workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// ```
func (r *AutomationService) Get(ctx context.Context, body AutomationGetParams, opts ...option.RequestOption) (res *AutomationGetResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/GetWorkflow"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Updates a workflow's configuration using full replacement semantics.
//
// Update Behavior:
//
// - All provided fields completely replace existing values
// - Optional fields that are not provided remain unchanged
// - Complex fields (triggers, action) are replaced entirely, not merged
// - To remove optional fields, explicitly set them to empty/default values
//
// Use this method to:
//
// - Modify workflow settings
// - Update triggers and actions
// - Change execution limits
// - Update workflow steps
//
// ### Examples
//
// - Update workflow name:
//
// Changes the workflow's display name.
//
// ```yaml
// workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// name: "Updated Workflow Name"
// ```
//
// - Replace all triggers:
//
// Completely replaces the workflow's trigger configuration.
//
// ```yaml
// workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// triggers:
// - manual: {}
// context:
// projects:
// projectIds: ["new-project-id"]
// ```
//
// - Update execution limits:
//
// Completely replaces the workflow's action configuration.
//
// ```yaml
// workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// action:
// limits:
// maxParallel: 10
// maxTotal: 100
// steps:
// - task:
// command: "npm test"
// ```
func (r *AutomationService) Update(ctx context.Context, body AutomationUpdateParams, opts ...option.RequestOption) (res *AutomationUpdateResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/UpdateWorkflow"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// ListWorkflows
func (r *AutomationService) List(ctx context.Context, params AutomationListParams, opts ...option.RequestOption) (res *pagination.WorkflowsPage[Workflow], err error) {
var raw *http.Response
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "gitpod.v1.WorkflowService/ListWorkflows"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodPost, path, params, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// ListWorkflows
func (r *AutomationService) ListAutoPaging(ctx context.Context, params AutomationListParams, opts ...option.RequestOption) *pagination.WorkflowsPageAutoPager[Workflow] {
return pagination.NewWorkflowsPageAutoPager(r.List(ctx, params, opts...))
}
// Deletes a workflow permanently.
//
// Use this method to:
//
// - Remove unused workflows
// - Clean up test workflows
// - Delete obsolete configurations
//
// ### Examples
//
// - Delete workflow:
//
// Permanently removes a workflow.
//
// ```yaml
// workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// ```
func (r *AutomationService) Delete(ctx context.Context, body AutomationDeleteParams, opts ...option.RequestOption) (res *AutomationDeleteResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/DeleteWorkflow"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Cancels a running workflow execution.
//
// Use this method to:
//
// - Stop long-running executions
// - Cancel failed executions
// - Manage resource usage
//
// ### Examples
//
// - Cancel execution:
//
// Stops a running workflow execution.
//
// ```yaml
// workflowExecutionId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
// ```
func (r *AutomationService) CancelExecution(ctx context.Context, body AutomationCancelExecutionParams, opts ...option.RequestOption) (res *AutomationCancelExecutionResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/CancelWorkflowExecution"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Cancels a running workflow execution action.
//
// Use this method to:
//
// - Stop long-running actions
// - Cancel failed actions
// - Manage resource usage
//
// ### Examples
//
// - Cancel execution action:
//
// Stops a running workflow execution action.
//
// ```yaml
// workflowExecutionActionId: "a1b2c3d4-5e6f-7890-abcd-ef1234567890"
// ```
func (r *AutomationService) CancelExecutionAction(ctx context.Context, body AutomationCancelExecutionActionParams, opts ...option.RequestOption) (res *AutomationCancelExecutionActionResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/CancelWorkflowExecutionAction"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Lists workflow execution actions with optional filtering.
//
// Use this method to:
//
// - Monitor individual action execution status
// - Debug action failures
// - Track resource usage per action
//
// ### Examples
//
// - List execution actions for workflow execution:
//
// Shows all execution actions for a specific workflow execution.
//
// ```yaml
// filter:
// workflowExecutionIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
// pagination:
// pageSize: 20
// ```
func (r *AutomationService) ListExecutionActions(ctx context.Context, params AutomationListExecutionActionsParams, opts ...option.RequestOption) (res *pagination.WorkflowExecutionActionsPage[WorkflowExecutionAction], err error) {
var raw *http.Response
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "gitpod.v1.WorkflowService/ListWorkflowExecutionActions"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodPost, path, params, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// Lists workflow execution actions with optional filtering.
//
// Use this method to:
//
// - Monitor individual action execution status
// - Debug action failures
// - Track resource usage per action
//
// ### Examples
//
// - List execution actions for workflow execution:
//
// Shows all execution actions for a specific workflow execution.
//
// ```yaml
// filter:
// workflowExecutionIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
// pagination:
// pageSize: 20
// ```
func (r *AutomationService) ListExecutionActionsAutoPaging(ctx context.Context, params AutomationListExecutionActionsParams, opts ...option.RequestOption) *pagination.WorkflowExecutionActionsPageAutoPager[WorkflowExecutionAction] {
return pagination.NewWorkflowExecutionActionsPageAutoPager(r.ListExecutionActions(ctx, params, opts...))
}
// Lists outputs produced by workflow execution actions.
//
// Use this method to:
//
// - Retrieve test results, coverage metrics, or other structured data from
// executions
// - Aggregate outputs across multiple workflow executions
// - Build dashboards or reports from execution data
//
// ### Examples
//
// - List outputs for a workflow execution:
//
// Retrieves all outputs produced by actions in the specified execution.
//
// ```yaml
// filter:
// workflowExecutionIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
// pagination:
// pageSize: 50
// ```
func (r *AutomationService) ListExecutionOutputs(ctx context.Context, params AutomationListExecutionOutputsParams, opts ...option.RequestOption) (res *pagination.OutputsPage[AutomationListExecutionOutputsResponse], err error) {
var raw *http.Response
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "gitpod.v1.WorkflowService/ListWorkflowExecutionOutputs"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodPost, path, params, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// Lists outputs produced by workflow execution actions.
//
// Use this method to:
//
// - Retrieve test results, coverage metrics, or other structured data from
// executions
// - Aggregate outputs across multiple workflow executions
// - Build dashboards or reports from execution data
//
// ### Examples
//
// - List outputs for a workflow execution:
//
// Retrieves all outputs produced by actions in the specified execution.
//
// ```yaml
// filter:
// workflowExecutionIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
// pagination:
// pageSize: 50
// ```
func (r *AutomationService) ListExecutionOutputsAutoPaging(ctx context.Context, params AutomationListExecutionOutputsParams, opts ...option.RequestOption) *pagination.OutputsPageAutoPager[AutomationListExecutionOutputsResponse] {
return pagination.NewOutputsPageAutoPager(r.ListExecutionOutputs(ctx, params, opts...))
}
// Lists workflow executions with optional filtering.
//
// Use this method to:
//
// - Monitor workflow execution history
// - Track execution status
// - Debug workflow issues
//
// ### Examples
//
// - List executions for workflow:
//
// Shows all executions for a specific workflow.
//
// ```yaml
// filter:
// workflowIds: ["b0e12f6c-4c67-429d-a4a6-d9838b5da047"]
// pagination:
// pageSize: 20
// ```
func (r *AutomationService) ListExecutions(ctx context.Context, params AutomationListExecutionsParams, opts ...option.RequestOption) (res *pagination.WorkflowExecutionsPage[WorkflowExecution], err error) {
var raw *http.Response
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "gitpod.v1.WorkflowService/ListWorkflowExecutions"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodPost, path, params, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// Lists workflow executions with optional filtering.
//
// Use this method to:
//
// - Monitor workflow execution history
// - Track execution status
// - Debug workflow issues
//
// ### Examples
//
// - List executions for workflow:
//
// Shows all executions for a specific workflow.
//
// ```yaml
// filter:
// workflowIds: ["b0e12f6c-4c67-429d-a4a6-d9838b5da047"]
// pagination:
// pageSize: 20
// ```
func (r *AutomationService) ListExecutionsAutoPaging(ctx context.Context, params AutomationListExecutionsParams, opts ...option.RequestOption) *pagination.WorkflowExecutionsPageAutoPager[WorkflowExecution] {
return pagination.NewWorkflowExecutionsPageAutoPager(r.ListExecutions(ctx, params, opts...))
}
// Gets details about a specific workflow execution.
//
// Use this method to:
//
// - Check execution status
// - View execution results
// - Monitor execution progress
//
// ### Examples
//
// - Get execution details:
//
// Retrieves information about a specific execution.
//
// ```yaml
// workflowExecutionId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
// ```
func (r *AutomationService) GetExecution(ctx context.Context, body AutomationGetExecutionParams, opts ...option.RequestOption) (res *AutomationGetExecutionResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/GetWorkflowExecution"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Gets details about a specific workflow execution action.
//
// Use this method to:
//
// - Check execution action status
// - View execution action results
// - Monitor execution action progress
//
// ### Examples
//
// - Get execution action details:
//
// Retrieves information about a specific execution action.
//
// ```yaml
// workflowExecutionActionId: "a1b2c3d4-5e6f-7890-abcd-ef1234567890"
// ```
func (r *AutomationService) GetExecutionAction(ctx context.Context, body AutomationGetExecutionActionParams, opts ...option.RequestOption) (res *AutomationGetExecutionActionResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/GetWorkflowExecutionAction"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Starts a workflow execution.
//
// Use this method to:
//
// - Start workflow execution on demand
// - Test workflow configurations
// - Run workflows outside of automatic triggers
//
// ### Examples
//
// - Start workflow:
//
// Starts a workflow execution manually.
//
// ```yaml
// workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
// ```
func (r *AutomationService) StartExecution(ctx context.Context, body AutomationStartExecutionParams, opts ...option.RequestOption) (res *AutomationStartExecutionResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "gitpod.v1.WorkflowService/StartWorkflow"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return res, err
}
// Workflow represents a workflow configuration.
type Workflow struct {
ID string `json:"id" format:"uuid"`
// WorkflowMetadata contains workflow metadata.
Metadata WorkflowMetadata `json:"metadata"`
Spec WorkflowSpec `json:"spec"`
// Webhook URL for triggering this workflow via HTTP POST Format:
// {base_url}/workflows/{workflow_id}/webhooks
WebhookURL string `json:"webhookUrl"`
JSON workflowJSON `json:"-"`
}
// workflowJSON contains the JSON metadata for the struct [Workflow]
type workflowJSON struct {
ID apijson.Field
Metadata apijson.Field
Spec apijson.Field
WebhookURL apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *Workflow) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r workflowJSON) RawJSON() string {
return r.raw
}
// WorkflowMetadata contains workflow metadata.
type WorkflowMetadata struct {
// A Timestamp represents a point in time independent of any time zone or local
// calendar, encoded as a count of seconds and fractions of seconds at nanosecond
// resolution. The count is relative to an epoch at UTC midnight on January 1,
// 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar
// backwards to year one.
//
// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
// second table is needed for interpretation, using a
// [24-hour linear smear](https://developers.google.com/time/smear).
//
// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
// restricting to that range, we ensure that we can convert to and from
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
//
// # Examples
//
// Example 1: Compute Timestamp from POSIX `time()`.
//
// Timestamp timestamp;
// timestamp.set_seconds(time(NULL));
// timestamp.set_nanos(0);
//
// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
//
// struct timeval tv;
// gettimeofday(&tv, NULL);
//
// Timestamp timestamp;
// timestamp.set_seconds(tv.tv_sec);
// timestamp.set_nanos(tv.tv_usec * 1000);
//
// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
//
// FILETIME ft;
// GetSystemTimeAsFileTime(&ft);
// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
//
// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
// Timestamp timestamp;
// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
//
// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
//
// long millis = System.currentTimeMillis();
//
// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
// .setNanos((int) ((millis % 1000) * 1000000)).build();
//
// Example 5: Compute Timestamp from Java `Instant.now()`.
//
// Instant now = Instant.now();
//
// Timestamp timestamp =
// Timestamp.newBuilder().setSeconds(now.getEpochSecond())
// .setNanos(now.getNano()).build();
//
// Example 6: Compute Timestamp from current time in Python.
//
// timestamp = Timestamp()
// timestamp.GetCurrentTime()
//
// # JSON Mapping
//
// In JSON format, the Timestamp type is encoded as a string in the
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is
// "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always
// expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are
// zero-padded to two digits each. The fractional seconds, which can go up to 9
// digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix
// indicates the timezone ("UTC"); the timezone is required. A proto3 JSON
// serializer should always use UTC (as indicated by "Z") when printing the
// Timestamp type and a proto3 JSON parser should be able to accept both UTC and
// other timezones (as indicated by an offset).
//
// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on
// January 15, 2017.
//
// In JavaScript, one can convert a Date object to this format using the standard
// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
// method. In Python, a standard `datetime.datetime` object can be converted to
// this format using
// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the
// time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the
// Joda Time's
// [`ISODateTimeFormat.dateTime()`](<http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()>)
// to obtain a formatter capable of generating timestamps in this format.
CreatedAt time.Time `json:"createdAt" format:"date-time"`
Creator shared.Subject `json:"creator"`
Description string `json:"description"`
Executor shared.Subject `json:"executor"`
Name string `json:"name"`
// A Timestamp represents a point in time independent of any time zone or local
// calendar, encoded as a count of seconds and fractions of seconds at nanosecond
// resolution. The count is relative to an epoch at UTC midnight on January 1,
// 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar
// backwards to year one.
//
// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
// second table is needed for interpretation, using a
// [24-hour linear smear](https://developers.google.com/time/smear).
//
// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
// restricting to that range, we ensure that we can convert to and from
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
//
// # Examples
//
// Example 1: Compute Timestamp from POSIX `time()`.
//
// Timestamp timestamp;
// timestamp.set_seconds(time(NULL));
// timestamp.set_nanos(0);
//
// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
//
// struct timeval tv;
// gettimeofday(&tv, NULL);
//
// Timestamp timestamp;
// timestamp.set_seconds(tv.tv_sec);
// timestamp.set_nanos(tv.tv_usec * 1000);
//
// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
//
// FILETIME ft;
// GetSystemTimeAsFileTime(&ft);
// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
//
// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
// Timestamp timestamp;
// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
//
// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
//
// long millis = System.currentTimeMillis();
//
// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
// .setNanos((int) ((millis % 1000) * 1000000)).build();
//
// Example 5: Compute Timestamp from Java `Instant.now()`.
//
// Instant now = Instant.now();
//
// Timestamp timestamp =
// Timestamp.newBuilder().setSeconds(now.getEpochSecond())
// .setNanos(now.getNano()).build();
//
// Example 6: Compute Timestamp from current time in Python.
//
// timestamp = Timestamp()
// timestamp.GetCurrentTime()
//
// # JSON Mapping
//
// In JSON format, the Timestamp type is encoded as a string in the
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is
// "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always
// expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are
// zero-padded to two digits each. The fractional seconds, which can go up to 9
// digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix
// indicates the timezone ("UTC"); the timezone is required. A proto3 JSON
// serializer should always use UTC (as indicated by "Z") when printing the
// Timestamp type and a proto3 JSON parser should be able to accept both UTC and
// other timezones (as indicated by an offset).
//
// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on
// January 15, 2017.
//
// In JavaScript, one can convert a Date object to this format using the standard
// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
// method. In Python, a standard `datetime.datetime` object can be converted to
// this format using
// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the
// time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the
// Joda Time's
// [`ISODateTimeFormat.dateTime()`](<http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()>)
// to obtain a formatter capable of generating timestamps in this format.
UpdatedAt time.Time `json:"updatedAt" format:"date-time"`
JSON workflowMetadataJSON `json:"-"`
}
// workflowMetadataJSON contains the JSON metadata for the struct
// [WorkflowMetadata]
type workflowMetadataJSON struct {
CreatedAt apijson.Field
Creator apijson.Field
Description apijson.Field
Executor apijson.Field
Name apijson.Field
UpdatedAt apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *WorkflowMetadata) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r workflowMetadataJSON) RawJSON() string {
return r.raw
}
type WorkflowSpec struct {
// WorkflowAction defines the actions to be executed in a workflow.
Action WorkflowAction `json:"action"`
// WorkflowAction defines the actions to be executed in a workflow.
Report WorkflowAction `json:"report"`
Triggers []WorkflowTrigger `json:"triggers"`
JSON workflowSpecJSON `json:"-"`
}
// workflowSpecJSON contains the JSON metadata for the struct [WorkflowSpec]
type workflowSpecJSON struct {
Action apijson.Field
Report apijson.Field
Triggers apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *WorkflowSpec) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r workflowSpecJSON) RawJSON() string {
return r.raw
}
// WorkflowAction defines the actions to be executed in a workflow.
type WorkflowAction struct {
// Limits defines execution limits for workflow actions. Concurrent actions limit
// cannot exceed total actions limit:
//
// ```
// this.max_parallel <= this.max_total
// ```
Limits WorkflowActionLimits `json:"limits" api:"required"`
// Automation must have between 1 and 50 steps:
//
// ```
// size(this) >= 1 && size(this) <= 50
// ```
Steps []WorkflowStep `json:"steps"`
JSON workflowActionJSON `json:"-"`
}
// workflowActionJSON contains the JSON metadata for the struct [WorkflowAction]
type workflowActionJSON struct {
Limits apijson.Field
Steps apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *WorkflowAction) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r workflowActionJSON) RawJSON() string {
return r.raw
}
// Limits defines execution limits for workflow actions. Concurrent actions limit
// cannot exceed total actions limit:
//
// ```
// this.max_parallel <= this.max_total
// ```
type WorkflowActionLimits struct {
// Maximum parallel actions must be between 1 and 25:
//
// ```
// this >= 1 && this <= 25
// ```
MaxParallel int64 `json:"maxParallel"`
// Maximum total actions must be between 1 and 100:
//
// ```
// this >= 1 && this <= 100
// ```
MaxTotal int64 `json:"maxTotal"`
// PerExecution defines limits per execution action.
PerExecution WorkflowActionLimitsPerExecution `json:"perExecution"`
JSON workflowActionLimitsJSON `json:"-"`
}
// workflowActionLimitsJSON contains the JSON metadata for the struct
// [WorkflowActionLimits]
type workflowActionLimitsJSON struct {
MaxParallel apijson.Field
MaxTotal apijson.Field
PerExecution apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *WorkflowActionLimits) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r workflowActionLimitsJSON) RawJSON() string {
return r.raw
}
// PerExecution defines limits per execution action.
type WorkflowActionLimitsPerExecution struct {
// Maximum time allowed for a single execution action. Use standard duration format
// (e.g., "30m" for 30 minutes, "2h" for 2 hours).
MaxTime string `json:"maxTime" format:"regex"`
JSON workflowActionLimitsPerExecutionJSON `json:"-"`
}
// workflowActionLimitsPerExecutionJSON contains the JSON metadata for the struct
// [WorkflowActionLimitsPerExecution]
type workflowActionLimitsPerExecutionJSON struct {
MaxTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *WorkflowActionLimitsPerExecution) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r workflowActionLimitsPerExecutionJSON) RawJSON() string {
return r.raw
}
// WorkflowAction defines the actions to be executed in a workflow.
type WorkflowActionParam struct {
// Limits defines execution limits for workflow actions. Concurrent actions limit
// cannot exceed total actions limit:
//
// ```
// this.max_parallel <= this.max_total
// ```
Limits param.Field[WorkflowActionLimitsParam] `json:"limits" api:"required"`
// Automation must have between 1 and 50 steps:
//
// ```
// size(this) >= 1 && size(this) <= 50
// ```
Steps param.Field[[]WorkflowStepParam] `json:"steps"`
}
func (r WorkflowActionParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Limits defines execution limits for workflow actions. Concurrent actions limit
// cannot exceed total actions limit:
//
// ```
// this.max_parallel <= this.max_total
// ```
type WorkflowActionLimitsParam struct {
// Maximum parallel actions must be between 1 and 25:
//
// ```
// this >= 1 && this <= 25
// ```
MaxParallel param.Field[int64] `json:"maxParallel"`
// Maximum total actions must be between 1 and 100:
//
// ```
// this >= 1 && this <= 100
// ```
MaxTotal param.Field[int64] `json:"maxTotal"`
// PerExecution defines limits per execution action.
PerExecution param.Field[WorkflowActionLimitsPerExecutionParam] `json:"perExecution"`
}
func (r WorkflowActionLimitsParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// PerExecution defines limits per execution action.
type WorkflowActionLimitsPerExecutionParam struct {
// Maximum time allowed for a single execution action. Use standard duration format
// (e.g., "30m" for 30 minutes, "2h" for 2 hours).
MaxTime param.Field[string] `json:"maxTime" format:"regex"`
}
func (r WorkflowActionLimitsPerExecutionParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// WorkflowExecution represents a workflow execution instance.
type WorkflowExecution struct {
ID string `json:"id" format:"uuid"`
// WorkflowExecutionMetadata contains workflow execution metadata.
Metadata WorkflowExecutionMetadata `json:"metadata"`
// WorkflowExecutionSpec contains the specification used for this execution.
Spec WorkflowExecutionSpec `json:"spec"`
// WorkflowExecutionStatus contains the current status of a workflow execution.
Status WorkflowExecutionStatus `json:"status"`
JSON workflowExecutionJSON `json:"-"`
}
// workflowExecutionJSON contains the JSON metadata for the struct
// [WorkflowExecution]
type workflowExecutionJSON struct {
ID apijson.Field
Metadata apijson.Field
Spec apijson.Field
Status apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *WorkflowExecution) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r workflowExecutionJSON) RawJSON() string {
return r.raw
}
// WorkflowExecutionMetadata contains workflow execution metadata.
type WorkflowExecutionMetadata struct {
Creator shared.Subject `json:"creator"`
Executor shared.Subject `json:"executor"`
// A Timestamp represents a point in time independent of any time zone or local
// calendar, encoded as a count of seconds and fractions of seconds at nanosecond
// resolution. The count is relative to an epoch at UTC midnight on January 1,
// 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar
// backwards to year one.
//
// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
// second table is needed for interpretation, using a
// [24-hour linear smear](https://developers.google.com/time/smear).
//
// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
// restricting to that range, we ensure that we can convert to and from
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
//
// # Examples
//
// Example 1: Compute Timestamp from POSIX `time()`.
//
// Timestamp timestamp;
// timestamp.set_seconds(time(NULL));
// timestamp.set_nanos(0);
//
// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
//
// struct timeval tv;
// gettimeofday(&tv, NULL);
//
// Timestamp timestamp;
// timestamp.set_seconds(tv.tv_sec);
// timestamp.set_nanos(tv.tv_usec * 1000);
//
// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
//
// FILETIME ft;
// GetSystemTimeAsFileTime(&ft);
// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
//
// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
// Timestamp timestamp;
// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
//
// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
//
// long millis = System.currentTimeMillis();
//
// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
// .setNanos((int) ((millis % 1000) * 1000000)).build();
//
// Example 5: Compute Timestamp from Java `Instant.now()`.