-
Notifications
You must be signed in to change notification settings - Fork 251
/
tcqueue.go
1545 lines (1469 loc) · 59 KB
/
tcqueue.go
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
// The following code is AUTO-GENERATED. Please DO NOT edit.
// To update this generated code, run the following command:
// in the /codegenerator/model subdirectory of this project,
// making sure that `${GOPATH}/bin` is in your `PATH`:
//
// go install && go generate
// This package was generated from the schema defined at
// /references/queue/v1/api.json
// The queue service is responsible for accepting tasks and tracking their state
// as they are executed by workers, in order to ensure they are eventually
// resolved.
//
// ## Artifact Storage Types
//
// * **Object artifacts** contain arbitrary data, stored via the object service.
// * **Redirect artifacts**, will redirect the caller to URL when fetched
// with a a 303 (See Other) response. Clients will not apply any kind of
// authentication to that URL.
// * **Link artifacts**, will be treated as if the caller requested the linked
// artifact on the same task. Links may be chained, but cycles are forbidden.
// The caller must have scopes for the linked artifact, or a 403 response will
// be returned.
// * **Error artifacts**, only consists of meta-data which the queue will
// store for you. These artifacts are only meant to indicate that you the
// worker or the task failed to generate a specific artifact, that you
// would otherwise have uploaded. For example docker-worker will upload an
// error artifact, if the file it was supposed to upload doesn't exists or
// turns out to be a directory. Clients requesting an error artifact will
// get a `424` (Failed Dependency) response. This is mainly designed to
// ensure that dependent tasks can distinguish between artifacts that were
// suppose to be generated and artifacts for which the name is misspelled.
// * **S3 artifacts** are used for static files which will be
// stored on S3. When creating an S3 artifact the queue will return a
// pre-signed URL to which you can do a `PUT` request to upload your
// artifact. Note that `PUT` request **must** specify the `content-length`
// header and **must** give the `content-type` header the same value as in
// the request to `createArtifact`. S3 artifacts will be deprecated soon,
// and users should prefer object artifacts instead.
//
// ## Artifact immutability
//
// Generally speaking you cannot overwrite an artifact when created.
// But if you repeat the request with the same properties the request will
// succeed as the operation is idempotent.
// This is useful if you need to refresh a signed URL while uploading.
// Do not abuse this to overwrite artifacts created by another entity!
// Such as worker-host overwriting artifact created by worker-code.
//
// The queue defines the following *immutability special cases*:
//
// * A `reference` artifact can replace an existing `reference` artifact.
// * A `link` artifact can replace an existing `reference` artifact.
// * Any artifact's `expires` can be extended (made later, but not earlier).
//
// See:
//
// # How to use this package
//
// First create a Queue object:
//
// queue := tcqueue.New(nil)
//
// and then call one or more of queue's methods, e.g.:
//
// err := queue.Ping(.....)
//
// handling any errors...
//
// if err != nil {
// // handle error...
// }
//
// # Taskcluster Schema
//
// The source code of this go package was auto-generated from the API definition at
// <rootUrl>/references/queue/v1/api.json together with the input and output schemas it references,
package tcqueue
import (
"net/url"
"time"
tcclient "github.com/taskcluster/taskcluster/v58/clients/client-go"
)
type Queue tcclient.Client
// New returns a Queue client, configured to run against production. Pass in
// nil credentials to create a client without authentication. The
// returned client is mutable, so returned settings can be altered.
//
// queue := tcqueue.New(
// nil, // client without authentication
// "http://localhost:1234/my/taskcluster", // taskcluster hosted at this root URL on local machine
// )
// err := queue.Ping(.....) // for example, call the Ping(.....) API endpoint (described further down)...
// if err != nil {
// // handle errors...
// }
func New(credentials *tcclient.Credentials, rootURL string) *Queue {
return &Queue{
Credentials: credentials,
RootURL: rootURL,
ServiceName: "queue",
APIVersion: "v1",
Authenticate: credentials != nil,
}
}
// NewFromEnv returns a *Queue configured from environment variables.
//
// The root URL is taken from TASKCLUSTER_PROXY_URL if set to a non-empty
// string, otherwise from TASKCLUSTER_ROOT_URL if set, otherwise the empty
// string.
//
// The credentials are taken from environment variables:
//
// TASKCLUSTER_CLIENT_ID
// TASKCLUSTER_ACCESS_TOKEN
// TASKCLUSTER_CERTIFICATE
//
// If TASKCLUSTER_CLIENT_ID is empty/unset, authentication will be
// disabled.
func NewFromEnv() *Queue {
c := tcclient.CredentialsFromEnvVars()
rootURL := tcclient.RootURLFromEnvVars()
return &Queue{
Credentials: c,
RootURL: rootURL,
ServiceName: "queue",
APIVersion: "v1",
Authenticate: c.ClientID != "",
}
}
// Respond without doing anything.
// This endpoint is used to check that the service is up.
//
// See #ping
func (queue *Queue) Ping() error {
cd := tcclient.Client(*queue)
_, _, err := (&cd).APICall(nil, "GET", "/ping", nil, nil)
return err
}
// Respond without doing anything.
// This endpoint is used to check that the service is up.
//
// See #lbheartbeat
func (queue *Queue) Lbheartbeat() error {
cd := tcclient.Client(*queue)
_, _, err := (&cd).APICall(nil, "GET", "/__lbheartbeat__", nil, nil)
return err
}
// Respond with the JSON version object.
// https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
//
// See #version
func (queue *Queue) Version() error {
cd := tcclient.Client(*queue)
_, _, err := (&cd).APICall(nil, "GET", "/__version__", nil, nil)
return err
}
// This end-point will return the task-definition. Notice that the task
// definition may have been modified by queue, if an optional property is
// not specified the queue may provide a default value.
//
// Required scopes:
//
// queue:get-task:<taskId>
//
// See #task
func (queue *Queue) Task(taskId string) (*TaskDefinitionResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId), new(TaskDefinitionResponse), nil)
return responseObject.(*TaskDefinitionResponse), err
}
// Returns a signed URL for Task, valid for the specified duration.
//
// Required scopes:
//
// queue:get-task:<taskId>
//
// See Task for more details.
func (queue *Queue) Task_SignedURL(taskId string, duration time.Duration) (*url.URL, error) {
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId), nil, duration)
}
// Get task status structure from `taskId`
//
// Required scopes:
//
// queue:status:<taskId>
//
// See #status
func (queue *Queue) Status(taskId string) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/status", new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// Returns a signed URL for Status, valid for the specified duration.
//
// Required scopes:
//
// queue:status:<taskId>
//
// See Status for more details.
func (queue *Queue) Status_SignedURL(taskId string, duration time.Duration) (*url.URL, error) {
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/status", nil, duration)
}
// List tasks sharing the same `taskGroupId`.
//
// As a task-group may contain an unbounded number of tasks, this end-point
// may return a `continuationToken`. To continue listing tasks you must call
// the `listTaskGroup` again with the `continuationToken` as the
// query-string option `continuationToken`.
//
// By default this end-point will try to return up to 1000 members in one
// request. But it **may return less**, even if more tasks are available.
// It may also return a `continuationToken` even though there are no more
// results. However, you can only be sure to have seen all results if you
// keep calling `listTaskGroup` with the last `continuationToken` until you
// get a result without a `continuationToken`.
//
// If you are not interested in listing all the members at once, you may
// use the query-string option `limit` to return fewer.
//
// If you only want to to fetch task group metadata without the tasks,
// you can call the `getTaskGroup` method.
//
// Required scopes:
//
// queue:list-task-group:<taskGroupId>
//
// See #listTaskGroup
func (queue *Queue) ListTaskGroup(taskGroupId, continuationToken, limit string) (*ListTaskGroupResponse, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task-group/"+url.QueryEscape(taskGroupId)+"/list", new(ListTaskGroupResponse), v)
return responseObject.(*ListTaskGroupResponse), err
}
// Returns a signed URL for ListTaskGroup, valid for the specified duration.
//
// Required scopes:
//
// queue:list-task-group:<taskGroupId>
//
// See ListTaskGroup for more details.
func (queue *Queue) ListTaskGroup_SignedURL(taskGroupId, continuationToken, limit string, duration time.Duration) (*url.URL, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task-group/"+url.QueryEscape(taskGroupId)+"/list", v, duration)
}
// Stability: *** EXPERIMENTAL ***
//
// This method will cancel all unresolved tasks (`unscheduled`, `pending` or `running` states)
// with the given `taskGroupId`. Behaviour is similar to the `cancelTask` method.
//
// It is only possible to cancel a task group if it has been sealed using `sealTaskGroup`.
// If the task group is not sealed, this method will return a 409 response.
//
// It is possible to rerun a canceled task which will result in a new run.
// Calling `cancelTaskGroup` again in this case will only cancel the new run.
// Other tasks that were already canceled would not be canceled again.
//
// Required scopes:
//
// queue:cancel-task-group:<schedulerId>/<taskGroupId>
//
// See #cancelTaskGroup
func (queue *Queue) CancelTaskGroup(taskGroupId string) (*CancelTaskGroupResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task-group/"+url.QueryEscape(taskGroupId)+"/cancel", new(CancelTaskGroupResponse), nil)
return responseObject.(*CancelTaskGroupResponse), err
}
// Get task group information by `taskGroupId`.
//
// This will return meta-information associated with the task group.
// It contains information about task group expiry date or if it is sealed.
//
// If you also want to see which tasks belong to this task group, you can call
// `listTaskGroup` method.
//
// Required scopes:
//
// queue:list-task-group:<taskGroupId>
//
// See #getTaskGroup
func (queue *Queue) GetTaskGroup(taskGroupId string) (*TaskGroupDefinitionResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task-group/"+url.QueryEscape(taskGroupId), new(TaskGroupDefinitionResponse), nil)
return responseObject.(*TaskGroupDefinitionResponse), err
}
// Returns a signed URL for GetTaskGroup, valid for the specified duration.
//
// Required scopes:
//
// queue:list-task-group:<taskGroupId>
//
// See GetTaskGroup for more details.
func (queue *Queue) GetTaskGroup_SignedURL(taskGroupId string, duration time.Duration) (*url.URL, error) {
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task-group/"+url.QueryEscape(taskGroupId), nil, duration)
}
// Stability: *** EXPERIMENTAL ***
//
// Seal task group to prevent creation of new tasks.
//
// Task group can be sealed once and is irreversible. Calling it multiple times
// will return same result and will not update it again.
//
// Required scopes:
//
// queue:seal-task-group:<schedulerId>/<taskGroupId>
//
// See #sealTaskGroup
func (queue *Queue) SealTaskGroup(taskGroupId string) (*TaskGroupDefinitionResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task-group/"+url.QueryEscape(taskGroupId)+"/seal", new(TaskGroupDefinitionResponse), nil)
return responseObject.(*TaskGroupDefinitionResponse), err
}
// List tasks that depend on the given `taskId`.
//
// As many tasks from different task-groups may dependent on a single tasks,
// this end-point may return a `continuationToken`. To continue listing
// tasks you must call `listDependentTasks` again with the
// `continuationToken` as the query-string option `continuationToken`.
//
// By default this end-point will try to return up to 1000 tasks in one
// request. But it **may return less**, even if more tasks are available.
// It may also return a `continuationToken` even though there are no more
// results. However, you can only be sure to have seen all results if you
// keep calling `listDependentTasks` with the last `continuationToken` until
// you get a result without a `continuationToken`.
//
// If you are not interested in listing all the tasks at once, you may
// use the query-string option `limit` to return fewer.
//
// Required scopes:
//
// queue:list-dependent-tasks:<taskId>
//
// See #listDependentTasks
func (queue *Queue) ListDependentTasks(taskId, continuationToken, limit string) (*ListDependentTasksResponse, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/dependents", new(ListDependentTasksResponse), v)
return responseObject.(*ListDependentTasksResponse), err
}
// Returns a signed URL for ListDependentTasks, valid for the specified duration.
//
// Required scopes:
//
// queue:list-dependent-tasks:<taskId>
//
// See ListDependentTasks for more details.
func (queue *Queue) ListDependentTasks_SignedURL(taskId, continuationToken, limit string, duration time.Duration) (*url.URL, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/dependents", v, duration)
}
// Create a new task, this is an **idempotent** operation, so repeat it if
// you get an internal server error or network connection is dropped.
//
// **Task `deadline`**: the deadline property can be no more than 5 days
// into the future. This is to limit the amount of pending tasks not being
// taken care of. Ideally, you should use a much shorter deadline.
//
// **Task expiration**: the `expires` property must be greater than the
// task `deadline`. If not provided it will default to `deadline` + one
// year. Notice that artifacts created by a task must expire before the
// task's expiration.
//
// **Task specific routing-keys**: using the `task.routes` property you may
// define task specific routing-keys. If a task has a task specific
// routing-key: `<route>`, then when the AMQP message about the task is
// published, the message will be CC'ed with the routing-key:
// `route.<route>`. This is useful if you want another component to listen
// for completed tasks you have posted. The caller must have scope
// `queue:route:<route>` for each route.
//
// **Dependencies**: any tasks referenced in `task.dependencies` must have
// already been created at the time of this call.
//
// **Scopes**: Note that the scopes required to complete this API call depend
// on the content of the `scopes`, `routes`, `schedulerId`, `priority`,
// `provisionerId`, and `workerType` properties of the task definition.
//
// If the task group was sealed, this end-point will return `409` reporting
// `RequestConflict` to indicate that it is no longer possible to add new tasks
// for this `taskGroupId`.
//
// Required scopes:
//
// All of:
// * For scope in scopes each <scope>
// * For route in routes each queue:route:<route>
// * queue:create-task:project:<projectId>
// * queue:scheduler-id:<schedulerId>
// * For priority in priorities each queue:create-task:<priority>:<provisionerId>/<workerType>
//
// See #createTask
func (queue *Queue) CreateTask(taskId string, payload *TaskDefinitionRequest) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(payload, "PUT", "/task/"+url.QueryEscape(taskId), new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// scheduleTask will schedule a task to be executed, even if it has
// unresolved dependencies. A task would otherwise only be scheduled if
// its dependencies were resolved.
//
// This is useful if you have defined a task that depends on itself or on
// some other task that has not been resolved, but you wish the task to be
// scheduled immediately.
//
// This will announce the task as pending and workers will be allowed to
// claim it and resolve the task.
//
// **Note** this operation is **idempotent** and will not fail or complain
// if called with a `taskId` that is already scheduled, or even resolved.
// To reschedule a task previously resolved, use `rerunTask`.
//
// Required scopes:
//
// Any of:
// - queue:schedule-task:<schedulerId>/<taskGroupId>/<taskId>
// - queue:schedule-task-in-project:<projectId>
// - All of:
// * queue:schedule-task
// * assume:scheduler-id:<schedulerId>/<taskGroupId>
//
// See #scheduleTask
func (queue *Queue) ScheduleTask(taskId string) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task/"+url.QueryEscape(taskId)+"/schedule", new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// This method _reruns_ a previously resolved task, even if it was
// _completed_. This is useful if your task completes unsuccessfully, and
// you just want to run it from scratch again. This will also reset the
// number of `retries` allowed. It will schedule a task that is _unscheduled_
// regardless of the state of its dependencies.
//
// Remember that `retries` in the task status counts the number of runs that
// the queue have started because the worker stopped responding, for example
// because a spot node died.
//
// **Remark** this operation is idempotent: if it is invoked for a task that
// is `pending` or `running`, it will just return the current task status.
//
// Required scopes:
//
// Any of:
// - queue:rerun-task:<schedulerId>/<taskGroupId>/<taskId>
// - queue:rerun-task-in-project:<projectId>
// - All of:
// * queue:rerun-task
// * assume:scheduler-id:<schedulerId>/<taskGroupId>
//
// See #rerunTask
func (queue *Queue) RerunTask(taskId string) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task/"+url.QueryEscape(taskId)+"/rerun", new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// This method will cancel a task that is either `unscheduled`, `pending` or
// `running`. It will resolve the current run as `exception` with
// `reasonResolved` set to `canceled`. If the task isn't scheduled yet, ie.
// it doesn't have any runs, an initial run will be added and resolved as
// described above. Hence, after canceling a task, it cannot be scheduled
// with `queue.scheduleTask`, but a new run can be created with
// `queue.rerun`. These semantics is equivalent to calling
// `queue.scheduleTask` immediately followed by `queue.cancelTask`.
//
// **Remark** this operation is idempotent, if you try to cancel a task that
// isn't `unscheduled`, `pending` or `running`, this operation will just
// return the current task status.
//
// Required scopes:
//
// Any of:
// - queue:cancel-task:<schedulerId>/<taskGroupId>/<taskId>
// - queue:cancel-task-in-project:<projectId>
// - All of:
// * queue:cancel-task
// * assume:scheduler-id:<schedulerId>/<taskGroupId>
//
// See #cancelTask
func (queue *Queue) CancelTask(taskId string) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task/"+url.QueryEscape(taskId)+"/cancel", new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// Claim pending task(s) for the given task queue.
//
// If any work is available (even if fewer than the requested number of
// tasks, this will return immediately. Otherwise, it will block for tens of
// seconds waiting for work. If no work appears, it will return an emtpy
// list of tasks. Callers should sleep a short while (to avoid denial of
// service in an error condition) and call the endpoint again. This is a
// simple implementation of "long polling".
//
// Required scopes:
//
// All of:
// * queue:claim-work:<taskQueueId>
// * queue:worker-id:<workerGroup>/<workerId>
//
// See #claimWork
func (queue *Queue) ClaimWork(taskQueueId string, payload *ClaimWorkRequest) (*ClaimWorkResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(payload, "POST", "/claim-work/"+url.QueryEscape(taskQueueId), new(ClaimWorkResponse), nil)
return responseObject.(*ClaimWorkResponse), err
}
// Stability: *** DEPRECATED ***
//
// claim a task - never documented
//
// Required scopes:
//
// All of:
// * queue:claim-task:<provisionerId>/<workerType>
// * queue:worker-id:<workerGroup>/<workerId>
//
// See #claimTask
func (queue *Queue) ClaimTask(taskId, runId string, payload *TaskClaimRequest) (*TaskClaimResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(payload, "POST", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/claim", new(TaskClaimResponse), nil)
return responseObject.(*TaskClaimResponse), err
}
// Refresh the claim for a specific `runId` for given `taskId`. This updates
// the `takenUntil` property and returns a new set of temporary credentials
// for performing requests on behalf of the task. These credentials should
// be used in-place of the credentials returned by `claimWork`.
//
// The `reclaimTask` requests serves to:
// - Postpone `takenUntil` preventing the queue from resolving
// `claim-expired`,
// - Refresh temporary credentials used for processing the task, and
// - Abort execution if the task/run have been resolved.
//
// If the `takenUntil` timestamp is exceeded the queue will resolve the run
// as _exception_ with reason `claim-expired`, and proceeded to retry to the
// task. This ensures that tasks are retried, even if workers disappear
// without warning.
//
// If the task is resolved, this end-point will return `409` reporting
// `RequestConflict`. This typically happens if the task have been canceled
// or the `task.deadline` have been exceeded. If reclaiming fails, workers
// should abort the task and forget about the given `runId`. There is no
// need to resolve the run or upload artifacts.
//
// Required scopes:
//
// queue:reclaim-task:<taskId>/<runId>
//
// See #reclaimTask
func (queue *Queue) ReclaimTask(taskId, runId string) (*TaskReclaimResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/reclaim", new(TaskReclaimResponse), nil)
return responseObject.(*TaskReclaimResponse), err
}
// Report a task completed, resolving the run as `completed`.
//
// Required scopes:
//
// queue:resolve-task:<taskId>/<runId>
//
// See #reportCompleted
func (queue *Queue) ReportCompleted(taskId, runId string) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/completed", new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// Report a run failed, resolving the run as `failed`. Use this to resolve
// a run that failed because the task specific code behaved unexpectedly.
// For example the task exited non-zero, or didn't produce expected output.
//
// Do not use this if the task couldn't be run because if malformed
// payload, or other unexpected condition. In these cases we have a task
// exception, which should be reported with `reportException`.
//
// Required scopes:
//
// queue:resolve-task:<taskId>/<runId>
//
// See #reportFailed
func (queue *Queue) ReportFailed(taskId, runId string) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "POST", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/failed", new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// Resolve a run as _exception_. Generally, you will want to report tasks as
// failed instead of exception. You should `reportException` if,
//
// - The `task.payload` is invalid,
// - Non-existent resources are referenced,
// - Declared actions cannot be executed due to unavailable resources,
// - The worker had to shutdown prematurely,
// - The worker experienced an unknown error, or,
// - The task explicitly requested a retry.
//
// Do not use this to signal that some user-specified code crashed for any
// reason specific to this code. If user-specific code hits a resource that
// is temporarily unavailable worker should report task _failed_.
//
// Required scopes:
//
// queue:resolve-task:<taskId>/<runId>
//
// See #reportException
func (queue *Queue) ReportException(taskId, runId string, payload *TaskExceptionRequest) (*TaskStatusResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(payload, "POST", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/exception", new(TaskStatusResponse), nil)
return responseObject.(*TaskStatusResponse), err
}
// This API end-point creates an artifact for a specific run of a task. This
// should **only** be used by a worker currently operating on this task, or
// from a process running within the task (ie. on the worker).
//
// All artifacts must specify when they expire. The queue will
// automatically take care of deleting artifacts past their
// expiration point. This feature makes it feasible to upload large
// intermediate artifacts from data processing applications, as the
// artifacts can be set to expire a few days later.
//
// Required scopes:
//
// queue:create-artifact:<taskId>/<runId>
//
// See #createArtifact
func (queue *Queue) CreateArtifact(taskId, runId, name string, payload *PostArtifactRequest) (*PostArtifactResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(payload, "POST", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifacts/"+url.QueryEscape(name), new(PostArtifactResponse), nil)
return responseObject.(*PostArtifactResponse), err
}
// This endpoint marks an artifact as present for the given task, and
// should be called when the artifact data is fully uploaded.
//
// The storage types `reference`, `link`, and `error` do not need to
// be finished, as they are finished immediately by `createArtifact`.
// The storage type `s3` does not support this functionality and cannot
// be finished. In all such cases, calling this method is an input error
// (400).
//
// Required scopes:
//
// queue:create-artifact:<taskId>/<runId>
//
// See #finishArtifact
func (queue *Queue) FinishArtifact(taskId, runId, name string, payload *FinishArtifactRequest) error {
cd := tcclient.Client(*queue)
_, _, err := (&cd).APICall(payload, "PUT", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifacts/"+url.QueryEscape(name), nil, nil)
return err
}
// Get artifact by `<name>` from a specific run.
//
// **Artifact Access**, in order to get an artifact you need the scope
// `queue:get-artifact:<name>`, where `<name>` is the name of the artifact.
// To allow access to fetch artifacts with a client like `curl` or a web
// browser, without using Taskcluster credentials, include a scope in the
// `anonymous` role. The convention is to include
// `queue:get-artifact:public/*`.
//
// **Response**: the HTTP response to this method is a 303 redirect to the
// URL from which the artifact can be downloaded. The body of that response
// contains the data described in the output schema, contianing the same URL.
// Callers are encouraged to use whichever method of gathering the URL is
// most convenient. Standard HTTP clients will follow the redirect, while
// API client libraries will return the JSON body.
//
// In order to download an artifact the following must be done:
//
// 1. Obtain queue url. Building a signed url with a taskcluster client is
// recommended
// 1. Make a GET request which does not follow redirects
// 1. In all cases, if specified, the
// x-taskcluster-location-{content,transfer}-{sha256,length} values must be
// validated to be equal to the Content-Length and Sha256 checksum of the
// final artifact downloaded. as well as any intermediate redirects
// 1. If this response is a 500-series error, retry using an exponential
// backoff. No more than 5 retries should be attempted
// 1. If this response is a 400-series error, treat it appropriately for
// your context. This might be an error in responding to this request or
// an Error storage type body. This request should not be retried.
// 1. If this response is a 200-series response, the response body is the artifact.
// If the x-taskcluster-location-{content,transfer}-{sha256,length} and
// x-taskcluster-location-content-encoding are specified, they should match
// this response body
// 1. If the response type is a 300-series redirect, the artifact will be at the
// location specified by the `Location` header. There are multiple artifact storage
// types which use a 300-series redirect.
// 1. For all redirects followed, the user must verify that the content-sha256, content-length,
// transfer-sha256, transfer-length and content-encoding match every further request. The final
// artifact must also be validated against the values specified in the original queue response
// 1. Caching of requests with an x-taskcluster-artifact-storage-type value of `reference`
// must not occur
//
// **Headers**
// The following important headers are set on the response to this method:
//
// * location: the url of the artifact if a redirect is to be performed
// * x-taskcluster-artifact-storage-type: the storage type. Example: s3
//
// Required scopes:
//
// For name in names each queue:get-artifact:<name>
//
// See #getArtifact
func (queue *Queue) GetArtifact(taskId, runId, name string) (*GetArtifactResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifacts/"+url.QueryEscape(name), new(GetArtifactResponse), nil)
return responseObject.(*GetArtifactResponse), err
}
// Returns a signed URL for GetArtifact, valid for the specified duration.
//
// Required scopes:
//
// For name in names each queue:get-artifact:<name>
//
// See GetArtifact for more details.
func (queue *Queue) GetArtifact_SignedURL(taskId, runId, name string, duration time.Duration) (*url.URL, error) {
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifacts/"+url.QueryEscape(name), nil, duration)
}
// Get artifact by `<name>` from the last run of a task.
//
// **Artifact Access**, in order to get an artifact you need the scope
// `queue:get-artifact:<name>`, where `<name>` is the name of the artifact.
// To allow access to fetch artifacts with a client like `curl` or a web
// browser, without using Taskcluster credentials, include a scope in the
// `anonymous` role. The convention is to include
// `queue:get-artifact:public/*`.
//
// **API Clients**, this method will redirect you to the artifact, if it is
// stored externally. Either way, the response may not be JSON. So API
// client users might want to generate a signed URL for this end-point and
// use that URL with a normal HTTP client.
//
// **Remark**, this end-point is slightly slower than
// `queue.getArtifact`, so consider that if you already know the `runId` of
// the latest run. Otherwise, just us the most convenient API end-point.
//
// Required scopes:
//
// For name in names each queue:get-artifact:<name>
//
// See #getLatestArtifact
func (queue *Queue) GetLatestArtifact(taskId, name string) (*GetArtifactResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/artifacts/"+url.QueryEscape(name), new(GetArtifactResponse), nil)
return responseObject.(*GetArtifactResponse), err
}
// Returns a signed URL for GetLatestArtifact, valid for the specified duration.
//
// Required scopes:
//
// For name in names each queue:get-artifact:<name>
//
// See GetLatestArtifact for more details.
func (queue *Queue) GetLatestArtifact_SignedURL(taskId, name string, duration time.Duration) (*url.URL, error) {
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/artifacts/"+url.QueryEscape(name), nil, duration)
}
// Returns a list of artifacts and associated meta-data for a given run.
//
// As a task may have many artifacts paging may be necessary. If this
// end-point returns a `continuationToken`, you should call the end-point
// again with the `continuationToken` as the query-string option:
// `continuationToken`.
//
// By default this end-point will list up-to 1000 artifacts in a single page
// you may limit this with the query-string parameter `limit`.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>:<runId>
//
// See #listArtifacts
func (queue *Queue) ListArtifacts(taskId, runId, continuationToken, limit string) (*ListArtifactsResponse, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifacts", new(ListArtifactsResponse), v)
return responseObject.(*ListArtifactsResponse), err
}
// Returns a signed URL for ListArtifacts, valid for the specified duration.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>:<runId>
//
// See ListArtifacts for more details.
func (queue *Queue) ListArtifacts_SignedURL(taskId, runId, continuationToken, limit string, duration time.Duration) (*url.URL, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifacts", v, duration)
}
// Returns a list of artifacts and associated meta-data for the latest run
// from the given task.
//
// As a task may have many artifacts paging may be necessary. If this
// end-point returns a `continuationToken`, you should call the end-point
// again with the `continuationToken` as the query-string option:
// `continuationToken`.
//
// By default this end-point will list up-to 1000 artifacts in a single page
// you may limit this with the query-string parameter `limit`.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>
//
// See #listLatestArtifacts
func (queue *Queue) ListLatestArtifacts(taskId, continuationToken, limit string) (*ListArtifactsResponse, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/artifacts", new(ListArtifactsResponse), v)
return responseObject.(*ListArtifactsResponse), err
}
// Returns a signed URL for ListLatestArtifacts, valid for the specified duration.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>
//
// See ListLatestArtifacts for more details.
func (queue *Queue) ListLatestArtifacts_SignedURL(taskId, continuationToken, limit string, duration time.Duration) (*url.URL, error) {
v := url.Values{}
if continuationToken != "" {
v.Add("continuationToken", continuationToken)
}
if limit != "" {
v.Add("limit", limit)
}
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/artifacts", v, duration)
}
// Returns associated metadata for a given artifact, in the given task run.
// The metadata is the same as that returned from `listArtifacts`, and does
// not grant access to the artifact data.
//
// Note that this method does *not* automatically follow link artifacts.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>:<runId>
//
// See #artifactInfo
func (queue *Queue) ArtifactInfo(taskId, runId, name string) (*Artifact, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifact-info/"+url.QueryEscape(name), new(Artifact), nil)
return responseObject.(*Artifact), err
}
// Returns a signed URL for ArtifactInfo, valid for the specified duration.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>:<runId>
//
// See ArtifactInfo for more details.
func (queue *Queue) ArtifactInfo_SignedURL(taskId, runId, name string, duration time.Duration) (*url.URL, error) {
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifact-info/"+url.QueryEscape(name), nil, duration)
}
// Returns associated metadata for a given artifact, in the latest run of the
// task. The metadata is the same as that returned from `listArtifacts`,
// and does not grant access to the artifact data.
//
// Note that this method does *not* automatically follow link artifacts.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>
//
// See #latestArtifactInfo
func (queue *Queue) LatestArtifactInfo(taskId, name string) (*Artifact, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/artifact-info/"+url.QueryEscape(name), new(Artifact), nil)
return responseObject.(*Artifact), err
}
// Returns a signed URL for LatestArtifactInfo, valid for the specified duration.
//
// Required scopes:
//
// queue:list-artifacts:<taskId>
//
// See LatestArtifactInfo for more details.
func (queue *Queue) LatestArtifactInfo_SignedURL(taskId, name string, duration time.Duration) (*url.URL, error) {
cd := tcclient.Client(*queue)
return (&cd).SignedURL("/task/"+url.QueryEscape(taskId)+"/artifact-info/"+url.QueryEscape(name), nil, duration)
}
// Returns information about the content of the artifact, in the given task run.
//
// Depending on the storage type, the endpoint returns the content of the artifact
// or enough information to access that content.
//
// This method follows link artifacts, so it will not return content
// for a link artifact.
//
// Required scopes:
//
// For name in names each queue:get-artifact:<name>
//
// See #artifact
func (queue *Queue) Artifact(taskId, runId, name string) (*GetArtifactContentResponse, error) {
cd := tcclient.Client(*queue)
responseObject, _, err := (&cd).APICall(nil, "GET", "/task/"+url.QueryEscape(taskId)+"/runs/"+url.QueryEscape(runId)+"/artifact-content/"+url.QueryEscape(name), new(GetArtifactContentResponse), nil)
return responseObject.(*GetArtifactContentResponse), err
}
// Returns a signed URL for Artifact, valid for the specified duration.
//
// Required scopes:
//
// For name in names each queue:get-artifact:<name>
//
// See Artifact for more details.
func (queue *Queue) Artifact_SignedURL(taskId, runId, name string, duration time.Duration) (*url.URL, error) {