@flyteorg/flyteidl 0.24.8 → 0.24.11

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.
@@ -1,3742 +0,0 @@
1
- ######################
2
- Protocol Documentation
3
- ######################
4
-
5
-
6
-
7
-
8
- .. _ref_flyteidl/admin/cluster_assignment.proto:
9
-
10
- flyteidl/admin/cluster_assignment.proto
11
- ==================================================================
12
-
13
-
14
-
15
-
16
-
17
- .. _ref_flyteidl.admin.Affinity:
18
-
19
- Affinity
20
- ------------------------------------------------------------------
21
-
22
- Defines a set of constraints used to select eligible objects based on labels they possess.
23
-
24
-
25
-
26
- .. csv-table:: Affinity type fields
27
- :header: "Field", "Type", "Label", "Description"
28
- :widths: auto
29
-
30
- "selectors", ":ref:`ref_flyteidl.admin.Selector`", "repeated", "Multiples selectors are 'and'-ed together to produce the list of matching, eligible objects."
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
- .. _ref_flyteidl.admin.ClusterAssignment:
39
-
40
- ClusterAssignment
41
- ------------------------------------------------------------------
42
-
43
- Encapsulates specifications for routing an execution onto a specific cluster.
44
-
45
-
46
-
47
- .. csv-table:: ClusterAssignment type fields
48
- :header: "Field", "Type", "Label", "Description"
49
- :widths: auto
50
-
51
- "affinity", ":ref:`ref_flyteidl.admin.Affinity`", "", ""
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
- .. _ref_flyteidl.admin.Selector:
60
-
61
- Selector
62
- ------------------------------------------------------------------
63
-
64
- A Selector is a specification for identifying a set of objects with corresponding labels.
65
-
66
-
67
-
68
- .. csv-table:: Selector type fields
69
- :header: "Field", "Type", "Label", "Description"
70
- :widths: auto
71
-
72
- "key", ":ref:`ref_string`", "", "The label key."
73
- "value", ":ref:`ref_string`", "repeated", "One or more values used to match labels. For equality (or inequality) requirements, values must contain a single element. For set-based requirements, values may contain one or more elements."
74
- "operator", ":ref:`ref_flyteidl.admin.Selector.Operator`", "", ""
75
-
76
-
77
-
78
-
79
-
80
- <!-- end messages -->
81
-
82
-
83
-
84
- .. _ref_flyteidl.admin.Selector.Operator:
85
-
86
- Selector.Operator
87
- ------------------------------------------------------------------
88
-
89
- Defines how a label with a corresponding key and value is selected or excluded.
90
-
91
- .. csv-table:: Enum Selector.Operator values
92
- :header: "Name", "Number", "Description"
93
- :widths: auto
94
-
95
- "EQUALS", "0", ""
96
- "NOT_EQUALS", "1", ""
97
- "IN", "2", ""
98
- "NOT_IN", "3", ""
99
- "EXISTS", "4", "A label key with any value"
100
-
101
- <!-- end enums -->
102
-
103
- <!-- end HasExtensions -->
104
-
105
- <!-- end services -->
106
-
107
-
108
-
109
-
110
- .. _ref_flyteidl/admin/common.proto:
111
-
112
- flyteidl/admin/common.proto
113
- ==================================================================
114
-
115
-
116
-
117
-
118
-
119
- .. _ref_flyteidl.admin.Annotations:
120
-
121
- Annotations
122
- ------------------------------------------------------------------
123
-
124
- Annotation values to be applied to an execution resource.
125
- In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined
126
- to specify how to merge annotations defined at registration and execution time.
127
-
128
-
129
-
130
- .. csv-table:: Annotations type fields
131
- :header: "Field", "Type", "Label", "Description"
132
- :widths: auto
133
-
134
- "values", ":ref:`ref_flyteidl.admin.Annotations.ValuesEntry`", "repeated", "Map of custom annotations to be applied to the execution resource."
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
- .. _ref_flyteidl.admin.Annotations.ValuesEntry:
143
-
144
- Annotations.ValuesEntry
145
- ------------------------------------------------------------------
146
-
147
-
148
-
149
-
150
-
151
- .. csv-table:: Annotations.ValuesEntry type fields
152
- :header: "Field", "Type", "Label", "Description"
153
- :widths: auto
154
-
155
- "key", ":ref:`ref_string`", "", ""
156
- "value", ":ref:`ref_string`", "", ""
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
- .. _ref_flyteidl.admin.AuthRole:
165
-
166
- AuthRole
167
- ------------------------------------------------------------------
168
-
169
- Defines permissions associated with executions created by this launch plan spec.
170
- Use either of these roles when they have permissions required by your workflow execution.
171
- Deprecated.
172
-
173
-
174
-
175
- .. csv-table:: AuthRole type fields
176
- :header: "Field", "Type", "Label", "Description"
177
- :widths: auto
178
-
179
- "assumable_iam_role", ":ref:`ref_string`", "", "Defines an optional iam role which will be used for tasks run in executions created with this launch plan."
180
- "kubernetes_service_account", ":ref:`ref_string`", "", "Defines an optional kubernetes service account which will be used for tasks run in executions created with this launch plan."
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
- .. _ref_flyteidl.admin.EmailNotification:
189
-
190
- EmailNotification
191
- ------------------------------------------------------------------
192
-
193
- Defines an email notification specification.
194
-
195
-
196
-
197
- .. csv-table:: EmailNotification type fields
198
- :header: "Field", "Type", "Label", "Description"
199
- :widths: auto
200
-
201
- "recipients_email", ":ref:`ref_string`", "repeated", "The list of email addresses recipients for this notification. +required"
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
- .. _ref_flyteidl.admin.Labels:
210
-
211
- Labels
212
- ------------------------------------------------------------------
213
-
214
- Label values to be applied to an execution resource.
215
- In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined
216
- to specify how to merge labels defined at registration and execution time.
217
-
218
-
219
-
220
- .. csv-table:: Labels type fields
221
- :header: "Field", "Type", "Label", "Description"
222
- :widths: auto
223
-
224
- "values", ":ref:`ref_flyteidl.admin.Labels.ValuesEntry`", "repeated", "Map of custom labels to be applied to the execution resource."
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
- .. _ref_flyteidl.admin.Labels.ValuesEntry:
233
-
234
- Labels.ValuesEntry
235
- ------------------------------------------------------------------
236
-
237
-
238
-
239
-
240
-
241
- .. csv-table:: Labels.ValuesEntry type fields
242
- :header: "Field", "Type", "Label", "Description"
243
- :widths: auto
244
-
245
- "key", ":ref:`ref_string`", "", ""
246
- "value", ":ref:`ref_string`", "", ""
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
- .. _ref_flyteidl.admin.NamedEntity:
255
-
256
- NamedEntity
257
- ------------------------------------------------------------------
258
-
259
- Encapsulates information common to a NamedEntity, a Flyte resource such as a task,
260
- workflow or launch plan. A NamedEntity is exclusively identified by its resource type
261
- and identifier.
262
-
263
-
264
-
265
- .. csv-table:: NamedEntity type fields
266
- :header: "Field", "Type", "Label", "Description"
267
- :widths: auto
268
-
269
- "resource_type", ":ref:`ref_flyteidl.core.ResourceType`", "", "Resource type of the named entity. One of Task, Workflow or LaunchPlan."
270
- "id", ":ref:`ref_flyteidl.admin.NamedEntityIdentifier`", "", ""
271
- "metadata", ":ref:`ref_flyteidl.admin.NamedEntityMetadata`", "", "Additional metadata around a named entity."
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
- .. _ref_flyteidl.admin.NamedEntityGetRequest:
280
-
281
- NamedEntityGetRequest
282
- ------------------------------------------------------------------
283
-
284
- A request to retrieve the metadata associated with a NamedEntityIdentifier
285
-
286
-
287
-
288
- .. csv-table:: NamedEntityGetRequest type fields
289
- :header: "Field", "Type", "Label", "Description"
290
- :widths: auto
291
-
292
- "resource_type", ":ref:`ref_flyteidl.core.ResourceType`", "", "Resource type of the metadata to get. One of Task, Workflow or LaunchPlan. +required"
293
- "id", ":ref:`ref_flyteidl.admin.NamedEntityIdentifier`", "", "The identifier for the named entity for which to fetch metadata. +required"
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
- .. _ref_flyteidl.admin.NamedEntityIdentifier:
302
-
303
- NamedEntityIdentifier
304
- ------------------------------------------------------------------
305
-
306
- Encapsulation of fields that identifies a Flyte resource.
307
- A Flyte resource can be a task, workflow or launch plan.
308
- A resource can internally have multiple versions and is uniquely identified
309
- by project, domain, and name.
310
-
311
-
312
-
313
- .. csv-table:: NamedEntityIdentifier type fields
314
- :header: "Field", "Type", "Label", "Description"
315
- :widths: auto
316
-
317
- "project", ":ref:`ref_string`", "", "Name of the project the resource belongs to."
318
- "domain", ":ref:`ref_string`", "", "Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project."
319
- "name", ":ref:`ref_string`", "", "User provided value for the resource. The combination of project + domain + name uniquely identifies the resource. +optional - in certain contexts - like 'List API', 'Launch plans'"
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
- .. _ref_flyteidl.admin.NamedEntityIdentifierList:
328
-
329
- NamedEntityIdentifierList
330
- ------------------------------------------------------------------
331
-
332
- Represents a list of NamedEntityIdentifiers.
333
-
334
-
335
-
336
- .. csv-table:: NamedEntityIdentifierList type fields
337
- :header: "Field", "Type", "Label", "Description"
338
- :widths: auto
339
-
340
- "entities", ":ref:`ref_flyteidl.admin.NamedEntityIdentifier`", "repeated", "A list of identifiers."
341
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
- .. _ref_flyteidl.admin.NamedEntityIdentifierListRequest:
350
-
351
- NamedEntityIdentifierListRequest
352
- ------------------------------------------------------------------
353
-
354
- Represents a request structure to list NamedEntityIdentifiers.
355
-
356
-
357
-
358
- .. csv-table:: NamedEntityIdentifierListRequest type fields
359
- :header: "Field", "Type", "Label", "Description"
360
- :widths: auto
361
-
362
- "project", ":ref:`ref_string`", "", "Name of the project that contains the identifiers. +required"
363
- "domain", ":ref:`ref_string`", "", "Name of the domain the identifiers belongs to within the project. +required"
364
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
365
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional"
366
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Specifies how listed entities should be sorted in the response. +optional"
367
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. +optional"
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
- .. _ref_flyteidl.admin.NamedEntityList:
376
-
377
- NamedEntityList
378
- ------------------------------------------------------------------
379
-
380
- Represents a list of NamedEntityIdentifiers.
381
-
382
-
383
-
384
- .. csv-table:: NamedEntityList type fields
385
- :header: "Field", "Type", "Label", "Description"
386
- :widths: auto
387
-
388
- "entities", ":ref:`ref_flyteidl.admin.NamedEntity`", "repeated", "A list of NamedEntity objects"
389
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
- .. _ref_flyteidl.admin.NamedEntityListRequest:
398
-
399
- NamedEntityListRequest
400
- ------------------------------------------------------------------
401
-
402
- Represents a request structure to list NamedEntity objects
403
-
404
-
405
-
406
- .. csv-table:: NamedEntityListRequest type fields
407
- :header: "Field", "Type", "Label", "Description"
408
- :widths: auto
409
-
410
- "resource_type", ":ref:`ref_flyteidl.core.ResourceType`", "", "Resource type of the metadata to query. One of Task, Workflow or LaunchPlan. +required"
411
- "project", ":ref:`ref_string`", "", "Name of the project that contains the identifiers. +required"
412
- "domain", ":ref:`ref_string`", "", "Name of the domain the identifiers belongs to within the project."
413
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned."
414
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional"
415
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Specifies how listed entities should be sorted in the response. +optional"
416
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. +optional"
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
- .. _ref_flyteidl.admin.NamedEntityMetadata:
425
-
426
- NamedEntityMetadata
427
- ------------------------------------------------------------------
428
-
429
- Additional metadata around a named entity.
430
-
431
-
432
-
433
- .. csv-table:: NamedEntityMetadata type fields
434
- :header: "Field", "Type", "Label", "Description"
435
- :widths: auto
436
-
437
- "description", ":ref:`ref_string`", "", "Common description across all versions of the entity +optional"
438
- "state", ":ref:`ref_flyteidl.admin.NamedEntityState`", "", "Shared state across all version of the entity At this point in time, only workflow entities can have their state archived."
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
- .. _ref_flyteidl.admin.NamedEntityUpdateRequest:
447
-
448
- NamedEntityUpdateRequest
449
- ------------------------------------------------------------------
450
-
451
- Request to set the referenced named entity state to the configured value.
452
-
453
-
454
-
455
- .. csv-table:: NamedEntityUpdateRequest type fields
456
- :header: "Field", "Type", "Label", "Description"
457
- :widths: auto
458
-
459
- "resource_type", ":ref:`ref_flyteidl.core.ResourceType`", "", "Resource type of the metadata to update +required"
460
- "id", ":ref:`ref_flyteidl.admin.NamedEntityIdentifier`", "", "Identifier of the metadata to update +required"
461
- "metadata", ":ref:`ref_flyteidl.admin.NamedEntityMetadata`", "", "Metadata object to set as the new value +required"
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
- .. _ref_flyteidl.admin.NamedEntityUpdateResponse:
470
-
471
- NamedEntityUpdateResponse
472
- ------------------------------------------------------------------
473
-
474
- Purposefully empty, may be populated in the future.
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
- .. _ref_flyteidl.admin.Notification:
484
-
485
- Notification
486
- ------------------------------------------------------------------
487
-
488
- Represents a structure for notifications based on execution status.
489
- The notification content is configured within flyte admin but can be templatized.
490
- Future iterations could expose configuring notifications with custom content.
491
-
492
-
493
-
494
- .. csv-table:: Notification type fields
495
- :header: "Field", "Type", "Label", "Description"
496
- :widths: auto
497
-
498
- "phases", ":ref:`ref_flyteidl.core.WorkflowExecution.Phase`", "repeated", "A list of phases to which users can associate the notifications to. +required"
499
- "email", ":ref:`ref_flyteidl.admin.EmailNotification`", "", ""
500
- "pager_duty", ":ref:`ref_flyteidl.admin.PagerDutyNotification`", "", ""
501
- "slack", ":ref:`ref_flyteidl.admin.SlackNotification`", "", ""
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
- .. _ref_flyteidl.admin.ObjectGetRequest:
510
-
511
- ObjectGetRequest
512
- ------------------------------------------------------------------
513
-
514
- Shared request structure to fetch a single resource.
515
- Resources include: Task, Workflow, LaunchPlan
516
-
517
-
518
-
519
- .. csv-table:: ObjectGetRequest type fields
520
- :header: "Field", "Type", "Label", "Description"
521
- :widths: auto
522
-
523
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "Indicates a unique version of resource. +required"
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
- .. _ref_flyteidl.admin.PagerDutyNotification:
532
-
533
- PagerDutyNotification
534
- ------------------------------------------------------------------
535
-
536
- Defines a pager duty notification specification.
537
-
538
-
539
-
540
- .. csv-table:: PagerDutyNotification type fields
541
- :header: "Field", "Type", "Label", "Description"
542
- :widths: auto
543
-
544
- "recipients_email", ":ref:`ref_string`", "repeated", "Currently, PagerDuty notifications leverage email to trigger a notification. +required"
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
- .. _ref_flyteidl.admin.RawOutputDataConfig:
553
-
554
- RawOutputDataConfig
555
- ------------------------------------------------------------------
556
-
557
- Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
558
- See https://github.com/flyteorg/flyte/issues/211 for more background information.
559
-
560
-
561
-
562
- .. csv-table:: RawOutputDataConfig type fields
563
- :header: "Field", "Type", "Label", "Description"
564
- :widths: auto
565
-
566
- "output_location_prefix", ":ref:`ref_string`", "", "Prefix for where offloaded data from user workflows will be written e.g. s3://bucket/key or s3://bucket/"
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
- .. _ref_flyteidl.admin.ResourceListRequest:
575
-
576
- ResourceListRequest
577
- ------------------------------------------------------------------
578
-
579
- Shared request structure to retrieve a list of resources.
580
- Resources include: Task, Workflow, LaunchPlan
581
-
582
-
583
-
584
- .. csv-table:: ResourceListRequest type fields
585
- :header: "Field", "Type", "Label", "Description"
586
- :widths: auto
587
-
588
- "id", ":ref:`ref_flyteidl.admin.NamedEntityIdentifier`", "", "id represents the unique identifier of the resource. +required"
589
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
590
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional"
591
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
592
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
- .. _ref_flyteidl.admin.SlackNotification:
601
-
602
- SlackNotification
603
- ------------------------------------------------------------------
604
-
605
- Defines a slack notification specification.
606
-
607
-
608
-
609
- .. csv-table:: SlackNotification type fields
610
- :header: "Field", "Type", "Label", "Description"
611
- :widths: auto
612
-
613
- "recipients_email", ":ref:`ref_string`", "repeated", "Currently, Slack notifications leverage email to trigger a notification. +required"
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
- .. _ref_flyteidl.admin.Sort:
622
-
623
- Sort
624
- ------------------------------------------------------------------
625
-
626
- Specifies sort ordering in a list request.
627
-
628
-
629
-
630
- .. csv-table:: Sort type fields
631
- :header: "Field", "Type", "Label", "Description"
632
- :widths: auto
633
-
634
- "key", ":ref:`ref_string`", "", "Indicates an attribute to sort the response values. +required"
635
- "direction", ":ref:`ref_flyteidl.admin.Sort.Direction`", "", "Indicates the direction to apply sort key for response values. +optional"
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
- .. _ref_flyteidl.admin.UrlBlob:
644
-
645
- UrlBlob
646
- ------------------------------------------------------------------
647
-
648
- Represents a string url and associated metadata used throughout the platform.
649
-
650
-
651
-
652
- .. csv-table:: UrlBlob type fields
653
- :header: "Field", "Type", "Label", "Description"
654
- :widths: auto
655
-
656
- "url", ":ref:`ref_string`", "", "Actual url value."
657
- "bytes", ":ref:`ref_int64`", "", "Represents the size of the file accessible at the above url."
658
-
659
-
660
-
661
-
662
-
663
- <!-- end messages -->
664
-
665
-
666
-
667
- .. _ref_flyteidl.admin.NamedEntityState:
668
-
669
- NamedEntityState
670
- ------------------------------------------------------------------
671
-
672
- The status of the named entity is used to control its visibility in the UI.
673
-
674
- .. csv-table:: Enum NamedEntityState values
675
- :header: "Name", "Number", "Description"
676
- :widths: auto
677
-
678
- "NAMED_ENTITY_ACTIVE", "0", "By default, all named entities are considered active and under development."
679
- "NAMED_ENTITY_ARCHIVED", "1", "Archived named entities are no longer visible in the UI."
680
- "SYSTEM_GENERATED", "2", "System generated entities that aren't explicitly created or managed by a user."
681
-
682
-
683
-
684
- .. _ref_flyteidl.admin.Sort.Direction:
685
-
686
- Sort.Direction
687
- ------------------------------------------------------------------
688
-
689
-
690
-
691
- .. csv-table:: Enum Sort.Direction values
692
- :header: "Name", "Number", "Description"
693
- :widths: auto
694
-
695
- "DESCENDING", "0", "By default, fields are sorted in descending order."
696
- "ASCENDING", "1", ""
697
-
698
- <!-- end enums -->
699
-
700
- <!-- end HasExtensions -->
701
-
702
- <!-- end services -->
703
-
704
-
705
-
706
-
707
- .. _ref_flyteidl/admin/event.proto:
708
-
709
- flyteidl/admin/event.proto
710
- ==================================================================
711
-
712
-
713
-
714
-
715
-
716
- .. _ref_flyteidl.admin.EventErrorAlreadyInTerminalState:
717
-
718
- EventErrorAlreadyInTerminalState
719
- ------------------------------------------------------------------
720
-
721
- Indicates that a sent event was not used to update execution state due to
722
- the referenced execution already being terminated (and therefore ineligible
723
- for further state transitions).
724
-
725
-
726
-
727
- .. csv-table:: EventErrorAlreadyInTerminalState type fields
728
- :header: "Field", "Type", "Label", "Description"
729
- :widths: auto
730
-
731
- "current_phase", ":ref:`ref_string`", "", "+required"
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
- .. _ref_flyteidl.admin.EventErrorIncompatibleCluster:
740
-
741
- EventErrorIncompatibleCluster
742
- ------------------------------------------------------------------
743
-
744
- Indicates an event was rejected because it came from a different cluster than
745
- is on record as running the execution.
746
-
747
-
748
-
749
- .. csv-table:: EventErrorIncompatibleCluster type fields
750
- :header: "Field", "Type", "Label", "Description"
751
- :widths: auto
752
-
753
- "cluster", ":ref:`ref_string`", "", "The cluster which has been recorded as processing the execution. +required"
754
-
755
-
756
-
757
-
758
-
759
-
760
-
761
- .. _ref_flyteidl.admin.EventFailureReason:
762
-
763
- EventFailureReason
764
- ------------------------------------------------------------------
765
-
766
- Indicates why a sent event was not used to update execution.
767
-
768
-
769
-
770
- .. csv-table:: EventFailureReason type fields
771
- :header: "Field", "Type", "Label", "Description"
772
- :widths: auto
773
-
774
- "already_in_terminal_state", ":ref:`ref_flyteidl.admin.EventErrorAlreadyInTerminalState`", "", ""
775
- "incompatible_cluster", ":ref:`ref_flyteidl.admin.EventErrorIncompatibleCluster`", "", ""
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
- .. _ref_flyteidl.admin.NodeExecutionEventRequest:
784
-
785
- NodeExecutionEventRequest
786
- ------------------------------------------------------------------
787
-
788
- Request to send a notification that a node execution event has occurred.
789
-
790
-
791
-
792
- .. csv-table:: NodeExecutionEventRequest type fields
793
- :header: "Field", "Type", "Label", "Description"
794
- :widths: auto
795
-
796
- "request_id", ":ref:`ref_string`", "", "Unique ID for this request that can be traced between services"
797
- "event", ":ref:`ref_flyteidl.event.NodeExecutionEvent`", "", "Details about the event that occurred."
798
-
799
-
800
-
801
-
802
-
803
-
804
-
805
- .. _ref_flyteidl.admin.NodeExecutionEventResponse:
806
-
807
- NodeExecutionEventResponse
808
- ------------------------------------------------------------------
809
-
810
- Purposefully empty, may be populated in the future.
811
-
812
-
813
-
814
-
815
-
816
-
817
-
818
-
819
- .. _ref_flyteidl.admin.TaskExecutionEventRequest:
820
-
821
- TaskExecutionEventRequest
822
- ------------------------------------------------------------------
823
-
824
- Request to send a notification that a task execution event has occurred.
825
-
826
-
827
-
828
- .. csv-table:: TaskExecutionEventRequest type fields
829
- :header: "Field", "Type", "Label", "Description"
830
- :widths: auto
831
-
832
- "request_id", ":ref:`ref_string`", "", "Unique ID for this request that can be traced between services"
833
- "event", ":ref:`ref_flyteidl.event.TaskExecutionEvent`", "", "Details about the event that occurred."
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
- .. _ref_flyteidl.admin.TaskExecutionEventResponse:
842
-
843
- TaskExecutionEventResponse
844
- ------------------------------------------------------------------
845
-
846
- Purposefully empty, may be populated in the future.
847
-
848
-
849
-
850
-
851
-
852
-
853
-
854
-
855
- .. _ref_flyteidl.admin.WorkflowExecutionEventRequest:
856
-
857
- WorkflowExecutionEventRequest
858
- ------------------------------------------------------------------
859
-
860
- Request to send a notification that a workflow execution event has occurred.
861
-
862
-
863
-
864
- .. csv-table:: WorkflowExecutionEventRequest type fields
865
- :header: "Field", "Type", "Label", "Description"
866
- :widths: auto
867
-
868
- "request_id", ":ref:`ref_string`", "", "Unique ID for this request that can be traced between services"
869
- "event", ":ref:`ref_flyteidl.event.WorkflowExecutionEvent`", "", "Details about the event that occurred."
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
- .. _ref_flyteidl.admin.WorkflowExecutionEventResponse:
878
-
879
- WorkflowExecutionEventResponse
880
- ------------------------------------------------------------------
881
-
882
- Purposefully empty, may be populated in the future.
883
-
884
-
885
-
886
-
887
-
888
-
889
- <!-- end messages -->
890
-
891
- <!-- end enums -->
892
-
893
- <!-- end HasExtensions -->
894
-
895
- <!-- end services -->
896
-
897
-
898
-
899
-
900
- .. _ref_flyteidl/admin/execution.proto:
901
-
902
- flyteidl/admin/execution.proto
903
- ==================================================================
904
-
905
-
906
-
907
-
908
-
909
- .. _ref_flyteidl.admin.AbortMetadata:
910
-
911
- AbortMetadata
912
- ------------------------------------------------------------------
913
-
914
- Specifies metadata around an aborted workflow execution.
915
-
916
-
917
-
918
- .. csv-table:: AbortMetadata type fields
919
- :header: "Field", "Type", "Label", "Description"
920
- :widths: auto
921
-
922
- "cause", ":ref:`ref_string`", "", "In the case of a user-specified abort, this will pass along the user-supplied cause."
923
- "principal", ":ref:`ref_string`", "", "Identifies the entity (if any) responsible for terminating the execution"
924
-
925
-
926
-
927
-
928
-
929
-
930
-
931
- .. _ref_flyteidl.admin.Execution:
932
-
933
- Execution
934
- ------------------------------------------------------------------
935
-
936
- A workflow execution represents an instantiated workflow, including all inputs and additional
937
- metadata as well as computed results included state, outputs, and duration-based attributes.
938
- Used as a response object used in Get and List execution requests.
939
-
940
-
941
-
942
- .. csv-table:: Execution type fields
943
- :header: "Field", "Type", "Label", "Description"
944
- :widths: auto
945
-
946
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Unique identifier of the workflow execution."
947
- "spec", ":ref:`ref_flyteidl.admin.ExecutionSpec`", "", "User-provided configuration and inputs for launching the execution."
948
- "closure", ":ref:`ref_flyteidl.admin.ExecutionClosure`", "", "Execution results."
949
-
950
-
951
-
952
-
953
-
954
-
955
-
956
- .. _ref_flyteidl.admin.ExecutionClosure:
957
-
958
- ExecutionClosure
959
- ------------------------------------------------------------------
960
-
961
- Encapsulates the results of the Execution
962
-
963
-
964
-
965
- .. csv-table:: ExecutionClosure type fields
966
- :header: "Field", "Type", "Label", "Description"
967
- :widths: auto
968
-
969
- "outputs", ":ref:`ref_flyteidl.admin.LiteralMapBlob`", "", "**Deprecated.** Output URI in the case of a successful execution. DEPRECATED. Use GetExecutionData to fetch output data instead."
970
- "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information in the case of a failed execution."
971
- "abort_cause", ":ref:`ref_string`", "", "**Deprecated.** In the case of a user-specified abort, this will pass along the user-supplied cause."
972
- "abort_metadata", ":ref:`ref_flyteidl.admin.AbortMetadata`", "", "In the case of a user-specified abort, this will pass along the user and their supplied cause."
973
- "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this execution. DEPRECATED. Use GetExecutionData to fetch output data instead."
974
- "computed_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Inputs computed and passed for execution. computed_inputs depends on inputs in ExecutionSpec, fixed and default inputs in launch plan"
975
- "phase", ":ref:`ref_flyteidl.core.WorkflowExecution.Phase`", "", "Most recent recorded phase for the execution."
976
- "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Reported time at which the execution began running."
977
- "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the execution spent running."
978
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Reported time at which the execution was created."
979
- "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Reported time at which the execution was last updated."
980
- "notifications", ":ref:`ref_flyteidl.admin.Notification`", "repeated", "The notification settings to use after merging the CreateExecutionRequest and the launch plan notification settings. An execution launched with notifications will always prefer that definition to notifications defined statically in a launch plan."
981
- "workflow_id", ":ref:`ref_flyteidl.core.Identifier`", "", "Identifies the workflow definition for this execution."
982
- "state_change_details", ":ref:`ref_flyteidl.admin.ExecutionStateChangeDetails`", "", "Provides the details of the last stage change"
983
-
984
-
985
-
986
-
987
-
988
-
989
-
990
- .. _ref_flyteidl.admin.ExecutionCreateRequest:
991
-
992
- ExecutionCreateRequest
993
- ------------------------------------------------------------------
994
-
995
- Request to launch an execution with the given project, domain and optionally-assigned name.
996
-
997
-
998
-
999
- .. csv-table:: ExecutionCreateRequest type fields
1000
- :header: "Field", "Type", "Label", "Description"
1001
- :widths: auto
1002
-
1003
- "project", ":ref:`ref_string`", "", "Name of the project the execution belongs to. +required"
1004
- "domain", ":ref:`ref_string`", "", "Name of the domain the execution belongs to. A domain can be considered as a subset within a specific project. +required"
1005
- "name", ":ref:`ref_string`", "", "User provided value for the resource. If none is provided the system will generate a unique string. +optional"
1006
- "spec", ":ref:`ref_flyteidl.admin.ExecutionSpec`", "", "Additional fields necessary to launch the execution. +optional"
1007
- "inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "The inputs required to start the execution. All required inputs must be included in this map. If not required and not provided, defaults apply. +optional"
1008
-
1009
-
1010
-
1011
-
1012
-
1013
-
1014
-
1015
- .. _ref_flyteidl.admin.ExecutionCreateResponse:
1016
-
1017
- ExecutionCreateResponse
1018
- ------------------------------------------------------------------
1019
-
1020
- The unique identifier for a successfully created execution.
1021
- If the name was *not* specified in the create request, this identifier will include a generated name.
1022
-
1023
-
1024
-
1025
- .. csv-table:: ExecutionCreateResponse type fields
1026
- :header: "Field", "Type", "Label", "Description"
1027
- :widths: auto
1028
-
1029
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", ""
1030
-
1031
-
1032
-
1033
-
1034
-
1035
-
1036
-
1037
- .. _ref_flyteidl.admin.ExecutionList:
1038
-
1039
- ExecutionList
1040
- ------------------------------------------------------------------
1041
-
1042
- Used as a response for request to list executions.
1043
- See :ref:`ref_flyteidl.admin.Execution` for more details
1044
-
1045
-
1046
-
1047
- .. csv-table:: ExecutionList type fields
1048
- :header: "Field", "Type", "Label", "Description"
1049
- :widths: auto
1050
-
1051
- "executions", ":ref:`ref_flyteidl.admin.Execution`", "repeated", ""
1052
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
- .. _ref_flyteidl.admin.ExecutionMetadata:
1061
-
1062
- ExecutionMetadata
1063
- ------------------------------------------------------------------
1064
-
1065
- Represents attributes about an execution which are not required to launch the execution but are useful to record.
1066
- These attributes are assigned at launch time and do not change.
1067
-
1068
-
1069
-
1070
- .. csv-table:: ExecutionMetadata type fields
1071
- :header: "Field", "Type", "Label", "Description"
1072
- :widths: auto
1073
-
1074
- "mode", ":ref:`ref_flyteidl.admin.ExecutionMetadata.ExecutionMode`", "", ""
1075
- "principal", ":ref:`ref_string`", "", "Identifier of the entity that triggered this execution. For systems using back-end authentication any value set here will be discarded in favor of the authenticated user context."
1076
- "nesting", ":ref:`ref_uint32`", "", "Indicates the nestedness of this execution. If a user launches a workflow execution, the default nesting is 0. If this execution further launches a workflow (child workflow), the nesting level is incremented by 0 => 1 Generally, if workflow at nesting level k launches a workflow then the child workflow will have nesting = k + 1."
1077
- "scheduled_at", ":ref:`ref_google.protobuf.Timestamp`", "", "For scheduled executions, the requested time for execution for this specific schedule invocation."
1078
- "parent_node_execution", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Which subworkflow node (if any) launched this execution"
1079
- "reference_execution", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Optional, a reference workflow execution related to this execution. In the case of a relaunch, this references the original workflow execution."
1080
- "system_metadata", ":ref:`ref_flyteidl.admin.SystemMetadata`", "", "Optional, platform-specific metadata about the execution. In this the future this may be gated behind an ACL or some sort of authorization."
1081
-
1082
-
1083
-
1084
-
1085
-
1086
-
1087
-
1088
- .. _ref_flyteidl.admin.ExecutionRecoverRequest:
1089
-
1090
- ExecutionRecoverRequest
1091
- ------------------------------------------------------------------
1092
-
1093
- Request to recover the referenced execution.
1094
-
1095
-
1096
-
1097
- .. csv-table:: ExecutionRecoverRequest type fields
1098
- :header: "Field", "Type", "Label", "Description"
1099
- :widths: auto
1100
-
1101
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Identifier of the workflow execution to recover."
1102
- "name", ":ref:`ref_string`", "", "User provided value for the recovered execution. If none is provided the system will generate a unique string. +optional"
1103
- "metadata", ":ref:`ref_flyteidl.admin.ExecutionMetadata`", "", "Additional metadata which will be used to overwrite any metadata in the reference execution when triggering a recovery execution."
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
- .. _ref_flyteidl.admin.ExecutionRelaunchRequest:
1112
-
1113
- ExecutionRelaunchRequest
1114
- ------------------------------------------------------------------
1115
-
1116
- Request to relaunch the referenced execution.
1117
-
1118
-
1119
-
1120
- .. csv-table:: ExecutionRelaunchRequest type fields
1121
- :header: "Field", "Type", "Label", "Description"
1122
- :widths: auto
1123
-
1124
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Identifier of the workflow execution to relaunch. +required"
1125
- "name", ":ref:`ref_string`", "", "User provided value for the relaunched execution. If none is provided the system will generate a unique string. +optional"
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
-
1133
- .. _ref_flyteidl.admin.ExecutionSpec:
1134
-
1135
- ExecutionSpec
1136
- ------------------------------------------------------------------
1137
-
1138
- An ExecutionSpec encompasses all data used to launch this execution. The Spec does not change over the lifetime
1139
- of an execution as it progresses across phase changes.
1140
-
1141
-
1142
-
1143
- .. csv-table:: ExecutionSpec type fields
1144
- :header: "Field", "Type", "Label", "Description"
1145
- :widths: auto
1146
-
1147
- "launch_plan", ":ref:`ref_flyteidl.core.Identifier`", "", "Launch plan to be executed"
1148
- "inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Input values to be passed for the execution"
1149
- "metadata", ":ref:`ref_flyteidl.admin.ExecutionMetadata`", "", "Metadata for the execution"
1150
- "notifications", ":ref:`ref_flyteidl.admin.NotificationList`", "", "List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan. When this list is empty, the notifications defined for the launch plan will be applied."
1151
- "disable_all", ":ref:`ref_bool`", "", "This should be set to true if all notifications are intended to be disabled for this execution."
1152
- "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Labels to apply to the execution resource."
1153
- "annotations", ":ref:`ref_flyteidl.admin.Annotations`", "", "Annotations to apply to the execution resource."
1154
- "security_context", ":ref:`ref_flyteidl.core.SecurityContext`", "", "Optional: security context override to apply this execution."
1155
- "auth_role", ":ref:`ref_flyteidl.admin.AuthRole`", "", "**Deprecated.** Optional: auth override to apply this execution."
1156
- "quality_of_service", ":ref:`ref_flyteidl.core.QualityOfService`", "", "Indicates the runtime priority of the execution."
1157
- "max_parallelism", ":ref:`ref_int32`", "", "Controls the maximum number of task nodes that can be run in parallel for the entire workflow. This is useful to achieve fairness. Note: MapTasks are regarded as one unit, and parallelism/concurrency of MapTasks is independent from this."
1158
- "raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "User setting to configure where to store offloaded data (i.e. Blobs, structured datasets, query data, etc.). This should be a prefix like s3://my-bucket/my-data"
1159
- "cluster_assignment", ":ref:`ref_flyteidl.admin.ClusterAssignment`", "", "Controls how to select an available cluster on which this execution should run."
1160
-
1161
-
1162
-
1163
-
1164
-
1165
-
1166
-
1167
- .. _ref_flyteidl.admin.ExecutionStateChangeDetails:
1168
-
1169
- ExecutionStateChangeDetails
1170
- ------------------------------------------------------------------
1171
-
1172
-
1173
-
1174
-
1175
-
1176
- .. csv-table:: ExecutionStateChangeDetails type fields
1177
- :header: "Field", "Type", "Label", "Description"
1178
- :widths: auto
1179
-
1180
- "state", ":ref:`ref_flyteidl.admin.ExecutionState`", "", "The state of the execution is used to control its visibility in the UI/CLI."
1181
- "occurred_at", ":ref:`ref_google.protobuf.Timestamp`", "", "This timestamp represents when the state changed."
1182
- "principal", ":ref:`ref_string`", "", "Identifies the entity (if any) responsible for causing the state change of the execution"
1183
-
1184
-
1185
-
1186
-
1187
-
1188
-
1189
-
1190
- .. _ref_flyteidl.admin.ExecutionTerminateRequest:
1191
-
1192
- ExecutionTerminateRequest
1193
- ------------------------------------------------------------------
1194
-
1195
- Request to terminate an in-progress execution. This action is irreversible.
1196
- If an execution is already terminated, this request will simply be a no-op.
1197
- This request will fail if it references a non-existent execution.
1198
- If the request succeeds the phase "ABORTED" will be recorded for the termination
1199
- with the optional cause added to the output_result.
1200
-
1201
-
1202
-
1203
- .. csv-table:: ExecutionTerminateRequest type fields
1204
- :header: "Field", "Type", "Label", "Description"
1205
- :widths: auto
1206
-
1207
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Uniquely identifies the individual workflow execution to be terminated."
1208
- "cause", ":ref:`ref_string`", "", "Optional reason for aborting."
1209
-
1210
-
1211
-
1212
-
1213
-
1214
-
1215
-
1216
- .. _ref_flyteidl.admin.ExecutionTerminateResponse:
1217
-
1218
- ExecutionTerminateResponse
1219
- ------------------------------------------------------------------
1220
-
1221
- Purposefully empty, may be populated in the future.
1222
-
1223
-
1224
-
1225
-
1226
-
1227
-
1228
-
1229
-
1230
- .. _ref_flyteidl.admin.ExecutionUpdateRequest:
1231
-
1232
- ExecutionUpdateRequest
1233
- ------------------------------------------------------------------
1234
-
1235
-
1236
-
1237
-
1238
-
1239
- .. csv-table:: ExecutionUpdateRequest type fields
1240
- :header: "Field", "Type", "Label", "Description"
1241
- :widths: auto
1242
-
1243
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Identifier of the execution to update"
1244
- "state", ":ref:`ref_flyteidl.admin.ExecutionState`", "", "State to set as the new value active/archive"
1245
-
1246
-
1247
-
1248
-
1249
-
1250
-
1251
-
1252
- .. _ref_flyteidl.admin.ExecutionUpdateResponse:
1253
-
1254
- ExecutionUpdateResponse
1255
- ------------------------------------------------------------------
1256
-
1257
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
- .. _ref_flyteidl.admin.LiteralMapBlob:
1267
-
1268
- LiteralMapBlob
1269
- ------------------------------------------------------------------
1270
-
1271
- Input/output data can represented by actual values or a link to where values are stored
1272
-
1273
-
1274
-
1275
- .. csv-table:: LiteralMapBlob type fields
1276
- :header: "Field", "Type", "Label", "Description"
1277
- :widths: auto
1278
-
1279
- "values", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Data in LiteralMap format"
1280
- "uri", ":ref:`ref_string`", "", "In the event that the map is too large, we return a uri to the data"
1281
-
1282
-
1283
-
1284
-
1285
-
1286
-
1287
-
1288
- .. _ref_flyteidl.admin.NotificationList:
1289
-
1290
- NotificationList
1291
- ------------------------------------------------------------------
1292
-
1293
-
1294
-
1295
-
1296
-
1297
- .. csv-table:: NotificationList type fields
1298
- :header: "Field", "Type", "Label", "Description"
1299
- :widths: auto
1300
-
1301
- "notifications", ":ref:`ref_flyteidl.admin.Notification`", "repeated", ""
1302
-
1303
-
1304
-
1305
-
1306
-
1307
-
1308
-
1309
- .. _ref_flyteidl.admin.SystemMetadata:
1310
-
1311
- SystemMetadata
1312
- ------------------------------------------------------------------
1313
-
1314
- Represents system, rather than user-facing, metadata about an execution.
1315
-
1316
-
1317
-
1318
- .. csv-table:: SystemMetadata type fields
1319
- :header: "Field", "Type", "Label", "Description"
1320
- :widths: auto
1321
-
1322
- "execution_cluster", ":ref:`ref_string`", "", "Which execution cluster this execution ran on."
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
- .. _ref_flyteidl.admin.WorkflowExecutionGetDataRequest:
1331
-
1332
- WorkflowExecutionGetDataRequest
1333
- ------------------------------------------------------------------
1334
-
1335
- Request structure to fetch inputs, output and other data produced by an execution.
1336
- By default this data is not returned inline in :ref:`ref_flyteidl.admin.WorkflowExecutionGetRequest`
1337
-
1338
-
1339
-
1340
- .. csv-table:: WorkflowExecutionGetDataRequest type fields
1341
- :header: "Field", "Type", "Label", "Description"
1342
- :widths: auto
1343
-
1344
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "The identifier of the execution for which to fetch inputs and outputs."
1345
-
1346
-
1347
-
1348
-
1349
-
1350
-
1351
-
1352
- .. _ref_flyteidl.admin.WorkflowExecutionGetDataResponse:
1353
-
1354
- WorkflowExecutionGetDataResponse
1355
- ------------------------------------------------------------------
1356
-
1357
- Response structure for WorkflowExecutionGetDataRequest which contains inputs and outputs for an execution.
1358
-
1359
-
1360
-
1361
- .. csv-table:: WorkflowExecutionGetDataResponse type fields
1362
- :header: "Field", "Type", "Label", "Description"
1363
- :widths: auto
1364
-
1365
- "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of execution outputs. Deprecated: Please use full_outputs instead."
1366
- "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of execution inputs. Deprecated: Please use full_inputs instead."
1367
- "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
1368
- "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
1369
-
1370
-
1371
-
1372
-
1373
-
1374
-
1375
-
1376
- .. _ref_flyteidl.admin.WorkflowExecutionGetRequest:
1377
-
1378
- WorkflowExecutionGetRequest
1379
- ------------------------------------------------------------------
1380
-
1381
- A message used to fetch a single workflow execution entity.
1382
- See :ref:`ref_flyteidl.admin.Execution` for more details
1383
-
1384
-
1385
-
1386
- .. csv-table:: WorkflowExecutionGetRequest type fields
1387
- :header: "Field", "Type", "Label", "Description"
1388
- :widths: auto
1389
-
1390
- "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Uniquely identifies an individual workflow execution."
1391
-
1392
-
1393
-
1394
-
1395
-
1396
- <!-- end messages -->
1397
-
1398
-
1399
-
1400
- .. _ref_flyteidl.admin.ExecutionMetadata.ExecutionMode:
1401
-
1402
- ExecutionMetadata.ExecutionMode
1403
- ------------------------------------------------------------------
1404
-
1405
- The method by which this execution was launched.
1406
-
1407
- .. csv-table:: Enum ExecutionMetadata.ExecutionMode values
1408
- :header: "Name", "Number", "Description"
1409
- :widths: auto
1410
-
1411
- "MANUAL", "0", "The default execution mode, MANUAL implies that an execution was launched by an individual."
1412
- "SCHEDULED", "1", "A schedule triggered this execution launch."
1413
- "SYSTEM", "2", "A system process was responsible for launching this execution rather an individual."
1414
- "RELAUNCH", "3", "This execution was launched with identical inputs as a previous execution."
1415
- "CHILD_WORKFLOW", "4", "This execution was triggered by another execution."
1416
- "RECOVERED", "5", "This execution was recovered from another execution."
1417
-
1418
-
1419
-
1420
- .. _ref_flyteidl.admin.ExecutionState:
1421
-
1422
- ExecutionState
1423
- ------------------------------------------------------------------
1424
-
1425
- The state of the execution is used to control its visibility in the UI/CLI.
1426
-
1427
- .. csv-table:: Enum ExecutionState values
1428
- :header: "Name", "Number", "Description"
1429
- :widths: auto
1430
-
1431
- "EXECUTION_ACTIVE", "0", "By default, all executions are considered active."
1432
- "EXECUTION_ARCHIVED", "1", "Archived executions are no longer visible in the UI."
1433
-
1434
- <!-- end enums -->
1435
-
1436
- <!-- end HasExtensions -->
1437
-
1438
- <!-- end services -->
1439
-
1440
-
1441
-
1442
-
1443
- .. _ref_flyteidl/admin/launch_plan.proto:
1444
-
1445
- flyteidl/admin/launch_plan.proto
1446
- ==================================================================
1447
-
1448
-
1449
-
1450
-
1451
-
1452
- .. _ref_flyteidl.admin.ActiveLaunchPlanListRequest:
1453
-
1454
- ActiveLaunchPlanListRequest
1455
- ------------------------------------------------------------------
1456
-
1457
- Represents a request structure to list active launch plans within a project/domain.
1458
- See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
1459
-
1460
-
1461
-
1462
- .. csv-table:: ActiveLaunchPlanListRequest type fields
1463
- :header: "Field", "Type", "Label", "Description"
1464
- :widths: auto
1465
-
1466
- "project", ":ref:`ref_string`", "", "Name of the project that contains the identifiers. +required."
1467
- "domain", ":ref:`ref_string`", "", "Name of the domain the identifiers belongs to within the project. +required."
1468
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required."
1469
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional"
1470
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
1471
-
1472
-
1473
-
1474
-
1475
-
1476
-
1477
-
1478
- .. _ref_flyteidl.admin.ActiveLaunchPlanRequest:
1479
-
1480
- ActiveLaunchPlanRequest
1481
- ------------------------------------------------------------------
1482
-
1483
- Represents a request struct for finding an active launch plan for a given NamedEntityIdentifier
1484
- See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
1485
-
1486
-
1487
-
1488
- .. csv-table:: ActiveLaunchPlanRequest type fields
1489
- :header: "Field", "Type", "Label", "Description"
1490
- :widths: auto
1491
-
1492
- "id", ":ref:`ref_flyteidl.admin.NamedEntityIdentifier`", "", "+required."
1493
-
1494
-
1495
-
1496
-
1497
-
1498
-
1499
-
1500
- .. _ref_flyteidl.admin.Auth:
1501
-
1502
- Auth
1503
- ------------------------------------------------------------------
1504
-
1505
- Defines permissions associated with executions created by this launch plan spec.
1506
- Use either of these roles when they have permissions required by your workflow execution.
1507
- Deprecated.
1508
-
1509
-
1510
-
1511
- .. csv-table:: Auth type fields
1512
- :header: "Field", "Type", "Label", "Description"
1513
- :widths: auto
1514
-
1515
- "assumable_iam_role", ":ref:`ref_string`", "", "Defines an optional iam role which will be used for tasks run in executions created with this launch plan."
1516
- "kubernetes_service_account", ":ref:`ref_string`", "", "Defines an optional kubernetes service account which will be used for tasks run in executions created with this launch plan."
1517
-
1518
-
1519
-
1520
-
1521
-
1522
-
1523
-
1524
- .. _ref_flyteidl.admin.LaunchPlan:
1525
-
1526
- LaunchPlan
1527
- ------------------------------------------------------------------
1528
-
1529
- A LaunchPlan provides the capability to templatize workflow executions.
1530
- Launch plans simplify associating one or more schedules, inputs and notifications with your workflows.
1531
- Launch plans can be shared and used to trigger executions with predefined inputs even when a workflow
1532
- definition doesn't necessarily have a default value for said input.
1533
-
1534
-
1535
-
1536
- .. csv-table:: LaunchPlan type fields
1537
- :header: "Field", "Type", "Label", "Description"
1538
- :widths: auto
1539
-
1540
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "Uniquely identifies a launch plan entity."
1541
- "spec", ":ref:`ref_flyteidl.admin.LaunchPlanSpec`", "", "User-provided launch plan details, including reference workflow, inputs and other metadata."
1542
- "closure", ":ref:`ref_flyteidl.admin.LaunchPlanClosure`", "", "Values computed by the flyte platform after launch plan registration."
1543
-
1544
-
1545
-
1546
-
1547
-
1548
-
1549
-
1550
- .. _ref_flyteidl.admin.LaunchPlanClosure:
1551
-
1552
- LaunchPlanClosure
1553
- ------------------------------------------------------------------
1554
-
1555
- Values computed by the flyte platform after launch plan registration.
1556
- These include expected_inputs required to be present in a CreateExecutionRequest
1557
- to launch the reference workflow as well timestamp values associated with the launch plan.
1558
-
1559
-
1560
-
1561
- .. csv-table:: LaunchPlanClosure type fields
1562
- :header: "Field", "Type", "Label", "Description"
1563
- :widths: auto
1564
-
1565
- "state", ":ref:`ref_flyteidl.admin.LaunchPlanState`", "", "Indicate the Launch plan state."
1566
- "expected_inputs", ":ref:`ref_flyteidl.core.ParameterMap`", "", "Indicates the set of inputs expected when creating an execution with the Launch plan"
1567
- "expected_outputs", ":ref:`ref_flyteidl.core.VariableMap`", "", "Indicates the set of outputs expected to be produced by creating an execution with the Launch plan"
1568
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the launch plan was created."
1569
- "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the launch plan was last updated."
1570
-
1571
-
1572
-
1573
-
1574
-
1575
-
1576
-
1577
- .. _ref_flyteidl.admin.LaunchPlanCreateRequest:
1578
-
1579
- LaunchPlanCreateRequest
1580
- ------------------------------------------------------------------
1581
-
1582
- Request to register a launch plan. The included LaunchPlanSpec may have a complete or incomplete set of inputs required
1583
- to launch a workflow execution. By default all launch plans are registered in state INACTIVE. If you wish to
1584
- set the state to ACTIVE, you must submit a LaunchPlanUpdateRequest, after you have successfully created a launch plan.
1585
-
1586
-
1587
-
1588
- .. csv-table:: LaunchPlanCreateRequest type fields
1589
- :header: "Field", "Type", "Label", "Description"
1590
- :widths: auto
1591
-
1592
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "Uniquely identifies a launch plan entity."
1593
- "spec", ":ref:`ref_flyteidl.admin.LaunchPlanSpec`", "", "User-provided launch plan details, including reference workflow, inputs and other metadata."
1594
-
1595
-
1596
-
1597
-
1598
-
1599
-
1600
-
1601
- .. _ref_flyteidl.admin.LaunchPlanCreateResponse:
1602
-
1603
- LaunchPlanCreateResponse
1604
- ------------------------------------------------------------------
1605
-
1606
- Purposefully empty, may be populated in the future.
1607
-
1608
-
1609
-
1610
-
1611
-
1612
-
1613
-
1614
-
1615
- .. _ref_flyteidl.admin.LaunchPlanList:
1616
-
1617
- LaunchPlanList
1618
- ------------------------------------------------------------------
1619
-
1620
- Response object for list launch plan requests.
1621
- See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
1622
-
1623
-
1624
-
1625
- .. csv-table:: LaunchPlanList type fields
1626
- :header: "Field", "Type", "Label", "Description"
1627
- :widths: auto
1628
-
1629
- "launch_plans", ":ref:`ref_flyteidl.admin.LaunchPlan`", "repeated", ""
1630
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
1631
-
1632
-
1633
-
1634
-
1635
-
1636
-
1637
-
1638
- .. _ref_flyteidl.admin.LaunchPlanMetadata:
1639
-
1640
- LaunchPlanMetadata
1641
- ------------------------------------------------------------------
1642
-
1643
- Additional launch plan attributes included in the LaunchPlanSpec not strictly required to launch
1644
- the reference workflow.
1645
-
1646
-
1647
-
1648
- .. csv-table:: LaunchPlanMetadata type fields
1649
- :header: "Field", "Type", "Label", "Description"
1650
- :widths: auto
1651
-
1652
- "schedule", ":ref:`ref_flyteidl.admin.Schedule`", "", "Schedule to execute the Launch Plan"
1653
- "notifications", ":ref:`ref_flyteidl.admin.Notification`", "repeated", "List of notifications based on Execution status transitions"
1654
-
1655
-
1656
-
1657
-
1658
-
1659
-
1660
-
1661
- .. _ref_flyteidl.admin.LaunchPlanSpec:
1662
-
1663
- LaunchPlanSpec
1664
- ------------------------------------------------------------------
1665
-
1666
- User-provided launch plan definition and configuration values.
1667
-
1668
-
1669
-
1670
- .. csv-table:: LaunchPlanSpec type fields
1671
- :header: "Field", "Type", "Label", "Description"
1672
- :widths: auto
1673
-
1674
- "workflow_id", ":ref:`ref_flyteidl.core.Identifier`", "", "Reference to the Workflow template that the launch plan references"
1675
- "entity_metadata", ":ref:`ref_flyteidl.admin.LaunchPlanMetadata`", "", "Metadata for the Launch Plan"
1676
- "default_inputs", ":ref:`ref_flyteidl.core.ParameterMap`", "", "Input values to be passed for the execution. These can be overriden when an execution is created with this launch plan."
1677
- "fixed_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Fixed, non-overridable inputs for the Launch Plan. These can not be overriden when an execution is created with this launch plan."
1678
- "role", ":ref:`ref_string`", "", "**Deprecated.** String to indicate the role to use to execute the workflow underneath"
1679
- "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Custom labels to be applied to the execution resource."
1680
- "annotations", ":ref:`ref_flyteidl.admin.Annotations`", "", "Custom annotations to be applied to the execution resource."
1681
- "auth", ":ref:`ref_flyteidl.admin.Auth`", "", "**Deprecated.** Indicates the permission associated with workflow executions triggered with this launch plan."
1682
- "auth_role", ":ref:`ref_flyteidl.admin.AuthRole`", "", "**Deprecated.** "
1683
- "security_context", ":ref:`ref_flyteidl.core.SecurityContext`", "", "Indicates security context for permissions triggered with this launch plan"
1684
- "quality_of_service", ":ref:`ref_flyteidl.core.QualityOfService`", "", "Indicates the runtime priority of the execution."
1685
- "raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.)."
1686
- "max_parallelism", ":ref:`ref_int32`", "", "Controls the maximum number of tasknodes that can be run in parallel for the entire workflow. This is useful to achieve fairness. Note: MapTasks are regarded as one unit, and parallelism/concurrency of MapTasks is independent from this."
1687
-
1688
-
1689
-
1690
-
1691
-
1692
-
1693
-
1694
- .. _ref_flyteidl.admin.LaunchPlanUpdateRequest:
1695
-
1696
- LaunchPlanUpdateRequest
1697
- ------------------------------------------------------------------
1698
-
1699
- Request to set the referenced launch plan state to the configured value.
1700
- See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
1701
-
1702
-
1703
-
1704
- .. csv-table:: LaunchPlanUpdateRequest type fields
1705
- :header: "Field", "Type", "Label", "Description"
1706
- :widths: auto
1707
-
1708
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "Identifier of launch plan for which to change state. +required."
1709
- "state", ":ref:`ref_flyteidl.admin.LaunchPlanState`", "", "Desired state to apply to the launch plan. +required."
1710
-
1711
-
1712
-
1713
-
1714
-
1715
-
1716
-
1717
- .. _ref_flyteidl.admin.LaunchPlanUpdateResponse:
1718
-
1719
- LaunchPlanUpdateResponse
1720
- ------------------------------------------------------------------
1721
-
1722
- Purposefully empty, may be populated in the future.
1723
-
1724
-
1725
-
1726
-
1727
-
1728
-
1729
- <!-- end messages -->
1730
-
1731
-
1732
-
1733
- .. _ref_flyteidl.admin.LaunchPlanState:
1734
-
1735
- LaunchPlanState
1736
- ------------------------------------------------------------------
1737
-
1738
- By default any launch plan regardless of state can be used to launch a workflow execution.
1739
- However, at most one version of a launch plan
1740
- (e.g. a NamedEntityIdentifier set of shared project, domain and name values) can be
1741
- active at a time in regards to *schedules*. That is, at most one schedule in a NamedEntityIdentifier
1742
- group will be observed and trigger executions at a defined cadence.
1743
-
1744
- .. csv-table:: Enum LaunchPlanState values
1745
- :header: "Name", "Number", "Description"
1746
- :widths: auto
1747
-
1748
- "INACTIVE", "0", ""
1749
- "ACTIVE", "1", ""
1750
-
1751
- <!-- end enums -->
1752
-
1753
- <!-- end HasExtensions -->
1754
-
1755
- <!-- end services -->
1756
-
1757
-
1758
-
1759
-
1760
- .. _ref_flyteidl/admin/matchable_resource.proto:
1761
-
1762
- flyteidl/admin/matchable_resource.proto
1763
- ==================================================================
1764
-
1765
-
1766
-
1767
-
1768
-
1769
- .. _ref_flyteidl.admin.ClusterResourceAttributes:
1770
-
1771
- ClusterResourceAttributes
1772
- ------------------------------------------------------------------
1773
-
1774
-
1775
-
1776
-
1777
-
1778
- .. csv-table:: ClusterResourceAttributes type fields
1779
- :header: "Field", "Type", "Label", "Description"
1780
- :widths: auto
1781
-
1782
- "attributes", ":ref:`ref_flyteidl.admin.ClusterResourceAttributes.AttributesEntry`", "repeated", "Custom resource attributes which will be applied in cluster resource creation (e.g. quotas). Map keys are the *case-sensitive* names of variables in templatized resource files. Map values should be the custom values which get substituted during resource creation."
1783
-
1784
-
1785
-
1786
-
1787
-
1788
-
1789
-
1790
- .. _ref_flyteidl.admin.ClusterResourceAttributes.AttributesEntry:
1791
-
1792
- ClusterResourceAttributes.AttributesEntry
1793
- ------------------------------------------------------------------
1794
-
1795
-
1796
-
1797
-
1798
-
1799
- .. csv-table:: ClusterResourceAttributes.AttributesEntry type fields
1800
- :header: "Field", "Type", "Label", "Description"
1801
- :widths: auto
1802
-
1803
- "key", ":ref:`ref_string`", "", ""
1804
- "value", ":ref:`ref_string`", "", ""
1805
-
1806
-
1807
-
1808
-
1809
-
1810
-
1811
-
1812
- .. _ref_flyteidl.admin.ExecutionClusterLabel:
1813
-
1814
- ExecutionClusterLabel
1815
- ------------------------------------------------------------------
1816
-
1817
-
1818
-
1819
-
1820
-
1821
- .. csv-table:: ExecutionClusterLabel type fields
1822
- :header: "Field", "Type", "Label", "Description"
1823
- :widths: auto
1824
-
1825
- "value", ":ref:`ref_string`", "", "Label value to determine where the execution will be run"
1826
-
1827
-
1828
-
1829
-
1830
-
1831
-
1832
-
1833
- .. _ref_flyteidl.admin.ExecutionQueueAttributes:
1834
-
1835
- ExecutionQueueAttributes
1836
- ------------------------------------------------------------------
1837
-
1838
-
1839
-
1840
-
1841
-
1842
- .. csv-table:: ExecutionQueueAttributes type fields
1843
- :header: "Field", "Type", "Label", "Description"
1844
- :widths: auto
1845
-
1846
- "tags", ":ref:`ref_string`", "repeated", "Tags used for assigning execution queues for tasks defined within this project."
1847
-
1848
-
1849
-
1850
-
1851
-
1852
-
1853
-
1854
- .. _ref_flyteidl.admin.ListMatchableAttributesRequest:
1855
-
1856
- ListMatchableAttributesRequest
1857
- ------------------------------------------------------------------
1858
-
1859
- Request all matching resource attributes for a resource type.
1860
- See :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for more details
1861
-
1862
-
1863
-
1864
- .. csv-table:: ListMatchableAttributesRequest type fields
1865
- :header: "Field", "Type", "Label", "Description"
1866
- :widths: auto
1867
-
1868
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "+required"
1869
-
1870
-
1871
-
1872
-
1873
-
1874
-
1875
-
1876
- .. _ref_flyteidl.admin.ListMatchableAttributesResponse:
1877
-
1878
- ListMatchableAttributesResponse
1879
- ------------------------------------------------------------------
1880
-
1881
- Response for a request for all matching resource attributes for a resource type.
1882
- See :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for more details
1883
-
1884
-
1885
-
1886
- .. csv-table:: ListMatchableAttributesResponse type fields
1887
- :header: "Field", "Type", "Label", "Description"
1888
- :widths: auto
1889
-
1890
- "configurations", ":ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`", "repeated", ""
1891
-
1892
-
1893
-
1894
-
1895
-
1896
-
1897
-
1898
- .. _ref_flyteidl.admin.MatchableAttributesConfiguration:
1899
-
1900
- MatchableAttributesConfiguration
1901
- ------------------------------------------------------------------
1902
-
1903
- Represents a custom set of attributes applied for either a domain; a domain and project; or
1904
- domain, project and workflow name.
1905
- These are used to override system level defaults for kubernetes cluster resource management,
1906
- default execution values, and more all across different levels of specificity.
1907
-
1908
-
1909
-
1910
- .. csv-table:: MatchableAttributesConfiguration type fields
1911
- :header: "Field", "Type", "Label", "Description"
1912
- :widths: auto
1913
-
1914
- "attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
1915
- "domain", ":ref:`ref_string`", "", ""
1916
- "project", ":ref:`ref_string`", "", ""
1917
- "workflow", ":ref:`ref_string`", "", ""
1918
- "launch_plan", ":ref:`ref_string`", "", ""
1919
-
1920
-
1921
-
1922
-
1923
-
1924
-
1925
-
1926
- .. _ref_flyteidl.admin.MatchingAttributes:
1927
-
1928
- MatchingAttributes
1929
- ------------------------------------------------------------------
1930
-
1931
- Generic container for encapsulating all types of the above attributes messages.
1932
-
1933
-
1934
-
1935
- .. csv-table:: MatchingAttributes type fields
1936
- :header: "Field", "Type", "Label", "Description"
1937
- :widths: auto
1938
-
1939
- "task_resource_attributes", ":ref:`ref_flyteidl.admin.TaskResourceAttributes`", "", ""
1940
- "cluster_resource_attributes", ":ref:`ref_flyteidl.admin.ClusterResourceAttributes`", "", ""
1941
- "execution_queue_attributes", ":ref:`ref_flyteidl.admin.ExecutionQueueAttributes`", "", ""
1942
- "execution_cluster_label", ":ref:`ref_flyteidl.admin.ExecutionClusterLabel`", "", ""
1943
- "quality_of_service", ":ref:`ref_flyteidl.core.QualityOfService`", "", ""
1944
- "plugin_overrides", ":ref:`ref_flyteidl.admin.PluginOverrides`", "", ""
1945
- "workflow_execution_config", ":ref:`ref_flyteidl.admin.WorkflowExecutionConfig`", "", ""
1946
- "cluster_assignment", ":ref:`ref_flyteidl.admin.ClusterAssignment`", "", ""
1947
-
1948
-
1949
-
1950
-
1951
-
1952
-
1953
-
1954
- .. _ref_flyteidl.admin.PluginOverride:
1955
-
1956
- PluginOverride
1957
- ------------------------------------------------------------------
1958
-
1959
- This MatchableAttribute configures selecting alternate plugin implementations for a given task type.
1960
- In addition to an override implementation a selection of fallbacks can be provided or other modes
1961
- for handling cases where the desired plugin override is not enabled in a given Flyte deployment.
1962
-
1963
-
1964
-
1965
- .. csv-table:: PluginOverride type fields
1966
- :header: "Field", "Type", "Label", "Description"
1967
- :widths: auto
1968
-
1969
- "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
1970
- "plugin_id", ":ref:`ref_string`", "repeated", "A set of plugin ids which should handle tasks of this type instead of the default registered plugin. The list will be tried in order until a plugin is found with that id."
1971
- "missing_plugin_behavior", ":ref:`ref_flyteidl.admin.PluginOverride.MissingPluginBehavior`", "", "Defines the behavior when no plugin from the plugin_id list is not found."
1972
-
1973
-
1974
-
1975
-
1976
-
1977
-
1978
-
1979
- .. _ref_flyteidl.admin.PluginOverrides:
1980
-
1981
- PluginOverrides
1982
- ------------------------------------------------------------------
1983
-
1984
-
1985
-
1986
-
1987
-
1988
- .. csv-table:: PluginOverrides type fields
1989
- :header: "Field", "Type", "Label", "Description"
1990
- :widths: auto
1991
-
1992
- "overrides", ":ref:`ref_flyteidl.admin.PluginOverride`", "repeated", ""
1993
-
1994
-
1995
-
1996
-
1997
-
1998
-
1999
-
2000
- .. _ref_flyteidl.admin.TaskResourceAttributes:
2001
-
2002
- TaskResourceAttributes
2003
- ------------------------------------------------------------------
2004
-
2005
- Defines task resource defaults and limits that will be applied at task registration.
2006
-
2007
-
2008
-
2009
- .. csv-table:: TaskResourceAttributes type fields
2010
- :header: "Field", "Type", "Label", "Description"
2011
- :widths: auto
2012
-
2013
- "defaults", ":ref:`ref_flyteidl.admin.TaskResourceSpec`", "", ""
2014
- "limits", ":ref:`ref_flyteidl.admin.TaskResourceSpec`", "", ""
2015
-
2016
-
2017
-
2018
-
2019
-
2020
-
2021
-
2022
- .. _ref_flyteidl.admin.TaskResourceSpec:
2023
-
2024
- TaskResourceSpec
2025
- ------------------------------------------------------------------
2026
-
2027
- Defines a set of overridable task resource attributes set during task registration.
2028
-
2029
-
2030
-
2031
- .. csv-table:: TaskResourceSpec type fields
2032
- :header: "Field", "Type", "Label", "Description"
2033
- :widths: auto
2034
-
2035
- "cpu", ":ref:`ref_string`", "", ""
2036
- "gpu", ":ref:`ref_string`", "", ""
2037
- "memory", ":ref:`ref_string`", "", ""
2038
- "storage", ":ref:`ref_string`", "", ""
2039
- "ephemeral_storage", ":ref:`ref_string`", "", ""
2040
-
2041
-
2042
-
2043
-
2044
-
2045
-
2046
-
2047
- .. _ref_flyteidl.admin.WorkflowExecutionConfig:
2048
-
2049
- WorkflowExecutionConfig
2050
- ------------------------------------------------------------------
2051
-
2052
- Adds defaults for customizable workflow-execution specifications and overrides.
2053
-
2054
-
2055
-
2056
- .. csv-table:: WorkflowExecutionConfig type fields
2057
- :header: "Field", "Type", "Label", "Description"
2058
- :widths: auto
2059
-
2060
- "max_parallelism", ":ref:`ref_int32`", "", "Can be used to control the number of parallel nodes to run within the workflow. This is useful to achieve fairness."
2061
- "security_context", ":ref:`ref_flyteidl.core.SecurityContext`", "", "Indicates security context permissions for executions triggered with this matchable attribute."
2062
- "raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.)."
2063
- "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Custom labels to be applied to a triggered execution resource."
2064
- "annotations", ":ref:`ref_flyteidl.admin.Annotations`", "", "Custom annotations to be applied to a triggered execution resource."
2065
-
2066
-
2067
-
2068
-
2069
-
2070
- <!-- end messages -->
2071
-
2072
-
2073
-
2074
- .. _ref_flyteidl.admin.MatchableResource:
2075
-
2076
- MatchableResource
2077
- ------------------------------------------------------------------
2078
-
2079
- Defines a resource that can be configured by customizable Project-, ProjectDomain- or WorkflowAttributes
2080
- based on matching tags.
2081
-
2082
- .. csv-table:: Enum MatchableResource values
2083
- :header: "Name", "Number", "Description"
2084
- :widths: auto
2085
-
2086
- "TASK_RESOURCE", "0", "Applies to customizable task resource requests and limits."
2087
- "CLUSTER_RESOURCE", "1", "Applies to configuring templated kubernetes cluster resources."
2088
- "EXECUTION_QUEUE", "2", "Configures task and dynamic task execution queue assignment."
2089
- "EXECUTION_CLUSTER_LABEL", "3", "Configures the K8s cluster label to be used for execution to be run"
2090
- "QUALITY_OF_SERVICE_SPECIFICATION", "4", "Configures default quality of service when undefined in an execution spec."
2091
- "PLUGIN_OVERRIDE", "5", "Selects configurable plugin implementation behavior for a given task type."
2092
- "WORKFLOW_EXECUTION_CONFIG", "6", "Adds defaults for customizable workflow-execution specifications and overrides."
2093
- "CLUSTER_ASSIGNMENT", "7", "Controls how to select an available cluster on which this execution should run."
2094
-
2095
-
2096
-
2097
- .. _ref_flyteidl.admin.PluginOverride.MissingPluginBehavior:
2098
-
2099
- PluginOverride.MissingPluginBehavior
2100
- ------------------------------------------------------------------
2101
-
2102
-
2103
-
2104
- .. csv-table:: Enum PluginOverride.MissingPluginBehavior values
2105
- :header: "Name", "Number", "Description"
2106
- :widths: auto
2107
-
2108
- "FAIL", "0", "By default, if this plugin is not enabled for a Flyte deployment then execution will fail."
2109
- "USE_DEFAULT", "1", "Uses the system-configured default implementation."
2110
-
2111
- <!-- end enums -->
2112
-
2113
- <!-- end HasExtensions -->
2114
-
2115
- <!-- end services -->
2116
-
2117
-
2118
-
2119
-
2120
- .. _ref_flyteidl/admin/node_execution.proto:
2121
-
2122
- flyteidl/admin/node_execution.proto
2123
- ==================================================================
2124
-
2125
-
2126
-
2127
-
2128
-
2129
- .. _ref_flyteidl.admin.DynamicWorkflowNodeMetadata:
2130
-
2131
- DynamicWorkflowNodeMetadata
2132
- ------------------------------------------------------------------
2133
-
2134
- For dynamic workflow nodes we capture information about the dynamic workflow definition that gets generated.
2135
-
2136
-
2137
-
2138
- .. csv-table:: DynamicWorkflowNodeMetadata type fields
2139
- :header: "Field", "Type", "Label", "Description"
2140
- :widths: auto
2141
-
2142
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
2143
- "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the embedded dynamic workflow."
2144
-
2145
-
2146
-
2147
-
2148
-
2149
-
2150
-
2151
- .. _ref_flyteidl.admin.NodeExecution:
2152
-
2153
- NodeExecution
2154
- ------------------------------------------------------------------
2155
-
2156
- Encapsulates all details for a single node execution entity.
2157
- A node represents a component in the overall workflow graph. A node launch a task, multiple tasks, an entire nested
2158
- sub-workflow, or even a separate child-workflow execution.
2159
- The same task can be called repeatedly in a single workflow but each node is unique.
2160
-
2161
-
2162
-
2163
- .. csv-table:: NodeExecution type fields
2164
- :header: "Field", "Type", "Label", "Description"
2165
- :widths: auto
2166
-
2167
- "id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Uniquely identifies an individual node execution."
2168
- "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
2169
- "closure", ":ref:`ref_flyteidl.admin.NodeExecutionClosure`", "", "Computed results associated with this node execution."
2170
- "metadata", ":ref:`ref_flyteidl.admin.NodeExecutionMetaData`", "", "Metadata for Node Execution"
2171
-
2172
-
2173
-
2174
-
2175
-
2176
-
2177
-
2178
- .. _ref_flyteidl.admin.NodeExecutionClosure:
2179
-
2180
- NodeExecutionClosure
2181
- ------------------------------------------------------------------
2182
-
2183
- Container for node execution details and results.
2184
-
2185
-
2186
-
2187
- .. csv-table:: NodeExecutionClosure type fields
2188
- :header: "Field", "Type", "Label", "Description"
2189
- :widths: auto
2190
-
2191
- "output_uri", ":ref:`ref_string`", "", "**Deprecated.** Links to a remotely stored, serialized core.LiteralMap of node execution outputs. DEPRECATED. Use GetNodeExecutionData to fetch output data instead."
2192
- "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the Node"
2193
- "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this node execution. DEPRECATED. Use GetNodeExecutionData to fetch output data instead."
2194
- "phase", ":ref:`ref_flyteidl.core.NodeExecution.Phase`", "", "The last recorded phase for this node execution."
2195
- "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the node execution began running."
2196
- "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the node execution spent running."
2197
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the node execution was created."
2198
- "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the node execution was last updated."
2199
- "workflow_node_metadata", ":ref:`ref_flyteidl.admin.WorkflowNodeMetadata`", "", ""
2200
- "task_node_metadata", ":ref:`ref_flyteidl.admin.TaskNodeMetadata`", "", ""
2201
-
2202
-
2203
-
2204
-
2205
-
2206
-
2207
-
2208
- .. _ref_flyteidl.admin.NodeExecutionForTaskListRequest:
2209
-
2210
- NodeExecutionForTaskListRequest
2211
- ------------------------------------------------------------------
2212
-
2213
- Represents a request structure to retrieve a list of node execution entities launched by a specific task.
2214
- This can arise when a task yields a subworkflow.
2215
-
2216
-
2217
-
2218
- .. csv-table:: NodeExecutionForTaskListRequest type fields
2219
- :header: "Field", "Type", "Label", "Description"
2220
- :widths: auto
2221
-
2222
- "task_execution_id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
2223
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
2224
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the, server-provided token can be used to fetch the next page in a query. +optional"
2225
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2226
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
2227
-
2228
-
2229
-
2230
-
2231
-
2232
-
2233
-
2234
- .. _ref_flyteidl.admin.NodeExecutionGetDataRequest:
2235
-
2236
- NodeExecutionGetDataRequest
2237
- ------------------------------------------------------------------
2238
-
2239
- Request structure to fetch inputs and output for a node execution.
2240
- By default, these are not returned in :ref:`ref_flyteidl.admin.NodeExecutionGetRequest`
2241
-
2242
-
2243
-
2244
- .. csv-table:: NodeExecutionGetDataRequest type fields
2245
- :header: "Field", "Type", "Label", "Description"
2246
- :widths: auto
2247
-
2248
- "id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "The identifier of the node execution for which to fetch inputs and outputs."
2249
-
2250
-
2251
-
2252
-
2253
-
2254
-
2255
-
2256
- .. _ref_flyteidl.admin.NodeExecutionGetDataResponse:
2257
-
2258
- NodeExecutionGetDataResponse
2259
- ------------------------------------------------------------------
2260
-
2261
- Response structure for NodeExecutionGetDataRequest which contains inputs and outputs for a node execution.
2262
-
2263
-
2264
-
2265
- .. csv-table:: NodeExecutionGetDataResponse type fields
2266
- :header: "Field", "Type", "Label", "Description"
2267
- :widths: auto
2268
-
2269
- "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of node execution inputs. Deprecated: Please use full_inputs instead."
2270
- "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of node execution outputs. Deprecated: Please use full_outputs instead."
2271
- "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
2272
- "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
2273
- "dynamic_workflow", ":ref:`ref_flyteidl.admin.DynamicWorkflowNodeMetadata`", "", "Optional Workflow closure for a dynamically generated workflow, in the case this node yields a dynamic workflow we return its structure here."
2274
-
2275
-
2276
-
2277
-
2278
-
2279
-
2280
-
2281
- .. _ref_flyteidl.admin.NodeExecutionGetRequest:
2282
-
2283
- NodeExecutionGetRequest
2284
- ------------------------------------------------------------------
2285
-
2286
- A message used to fetch a single node execution entity.
2287
- See :ref:`ref_flyteidl.admin.NodeExecution` for more details
2288
-
2289
-
2290
-
2291
- .. csv-table:: NodeExecutionGetRequest type fields
2292
- :header: "Field", "Type", "Label", "Description"
2293
- :widths: auto
2294
-
2295
- "id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Uniquely identifies an individual node execution. +required"
2296
-
2297
-
2298
-
2299
-
2300
-
2301
-
2302
-
2303
- .. _ref_flyteidl.admin.NodeExecutionList:
2304
-
2305
- NodeExecutionList
2306
- ------------------------------------------------------------------
2307
-
2308
- Request structure to retrieve a list of node execution entities.
2309
- See :ref:`ref_flyteidl.admin.NodeExecution` for more details
2310
-
2311
-
2312
-
2313
- .. csv-table:: NodeExecutionList type fields
2314
- :header: "Field", "Type", "Label", "Description"
2315
- :widths: auto
2316
-
2317
- "node_executions", ":ref:`ref_flyteidl.admin.NodeExecution`", "repeated", ""
2318
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
2319
-
2320
-
2321
-
2322
-
2323
-
2324
-
2325
-
2326
- .. _ref_flyteidl.admin.NodeExecutionListRequest:
2327
-
2328
- NodeExecutionListRequest
2329
- ------------------------------------------------------------------
2330
-
2331
- Represents a request structure to retrieve a list of node execution entities.
2332
- See :ref:`ref_flyteidl.admin.NodeExecution` for more details
2333
-
2334
-
2335
-
2336
- .. csv-table:: NodeExecutionListRequest type fields
2337
- :header: "Field", "Type", "Label", "Description"
2338
- :widths: auto
2339
-
2340
- "workflow_execution_id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Indicates the workflow execution to filter by. +required"
2341
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
2342
- "token", ":ref:`ref_string`", "", ""
2343
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2344
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
2345
- "unique_parent_id", ":ref:`ref_string`", "", "Unique identifier of the parent node in the execution +optional"
2346
-
2347
-
2348
-
2349
-
2350
-
2351
-
2352
-
2353
- .. _ref_flyteidl.admin.NodeExecutionMetaData:
2354
-
2355
- NodeExecutionMetaData
2356
- ------------------------------------------------------------------
2357
-
2358
- Represents additional attributes related to a Node Execution
2359
-
2360
-
2361
-
2362
- .. csv-table:: NodeExecutionMetaData type fields
2363
- :header: "Field", "Type", "Label", "Description"
2364
- :widths: auto
2365
-
2366
- "retry_group", ":ref:`ref_string`", "", "Node executions are grouped depending on retries of the parent Retry group is unique within the context of a parent node."
2367
- "is_parent_node", ":ref:`ref_bool`", "", "Boolean flag indicating if the node has child nodes under it This can be true when a node contains a dynamic workflow which then produces child nodes."
2368
- "spec_node_id", ":ref:`ref_string`", "", "Node id of the node in the original workflow This maps to value of WorkflowTemplate.nodes[X].id"
2369
- "is_dynamic", ":ref:`ref_bool`", "", "Boolean flag indicating if the node has contains a dynamic workflow which then produces child nodes. This is to distinguish between subworkflows and dynamic workflows which can both have is_parent_node as true."
2370
-
2371
-
2372
-
2373
-
2374
-
2375
-
2376
-
2377
- .. _ref_flyteidl.admin.TaskNodeMetadata:
2378
-
2379
- TaskNodeMetadata
2380
- ------------------------------------------------------------------
2381
-
2382
- Metadata for the case in which the node is a TaskNode
2383
-
2384
-
2385
-
2386
- .. csv-table:: TaskNodeMetadata type fields
2387
- :header: "Field", "Type", "Label", "Description"
2388
- :widths: auto
2389
-
2390
- "cache_status", ":ref:`ref_flyteidl.core.CatalogCacheStatus`", "", "Captures the status of caching for this execution."
2391
- "catalog_key", ":ref:`ref_flyteidl.core.CatalogMetadata`", "", "This structure carries the catalog artifact information"
2392
-
2393
-
2394
-
2395
-
2396
-
2397
-
2398
-
2399
- .. _ref_flyteidl.admin.WorkflowNodeMetadata:
2400
-
2401
- WorkflowNodeMetadata
2402
- ------------------------------------------------------------------
2403
-
2404
- Metadata for a WorkflowNode
2405
-
2406
-
2407
-
2408
- .. csv-table:: WorkflowNodeMetadata type fields
2409
- :header: "Field", "Type", "Label", "Description"
2410
- :widths: auto
2411
-
2412
- "executionId", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "The identifier for a workflow execution launched by a node."
2413
-
2414
-
2415
-
2416
-
2417
-
2418
- <!-- end messages -->
2419
-
2420
- <!-- end enums -->
2421
-
2422
- <!-- end HasExtensions -->
2423
-
2424
- <!-- end services -->
2425
-
2426
-
2427
-
2428
-
2429
- .. _ref_flyteidl/admin/notification.proto:
2430
-
2431
- flyteidl/admin/notification.proto
2432
- ==================================================================
2433
-
2434
-
2435
-
2436
-
2437
-
2438
- .. _ref_flyteidl.admin.EmailMessage:
2439
-
2440
- EmailMessage
2441
- ------------------------------------------------------------------
2442
-
2443
- Represents the Email object that is sent to a publisher/subscriber
2444
- to forward the notification.
2445
- Note: This is internal to Admin and doesn't need to be exposed to other components.
2446
-
2447
-
2448
-
2449
- .. csv-table:: EmailMessage type fields
2450
- :header: "Field", "Type", "Label", "Description"
2451
- :widths: auto
2452
-
2453
- "recipients_email", ":ref:`ref_string`", "repeated", "The list of email addresses to receive an email with the content populated in the other fields. Currently, each email recipient will receive its own email. This populates the TO field."
2454
- "sender_email", ":ref:`ref_string`", "", "The email of the sender. This populates the FROM field."
2455
- "subject_line", ":ref:`ref_string`", "", "The content of the subject line. This populates the SUBJECT field."
2456
- "body", ":ref:`ref_string`", "", "The content of the email body. This populates the BODY field."
2457
-
2458
-
2459
-
2460
-
2461
-
2462
- <!-- end messages -->
2463
-
2464
- <!-- end enums -->
2465
-
2466
- <!-- end HasExtensions -->
2467
-
2468
- <!-- end services -->
2469
-
2470
-
2471
-
2472
-
2473
- .. _ref_flyteidl/admin/project_domain_attributes.proto:
2474
-
2475
- flyteidl/admin/project_domain_attributes.proto
2476
- ==================================================================
2477
-
2478
-
2479
-
2480
-
2481
-
2482
- .. _ref_flyteidl.admin.ProjectDomainAttributes:
2483
-
2484
- ProjectDomainAttributes
2485
- ------------------------------------------------------------------
2486
-
2487
- Defines a set of custom matching attributes which defines resource defaults for a project and domain.
2488
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2489
-
2490
-
2491
-
2492
- .. csv-table:: ProjectDomainAttributes type fields
2493
- :header: "Field", "Type", "Label", "Description"
2494
- :widths: auto
2495
-
2496
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
2497
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
2498
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
2499
-
2500
-
2501
-
2502
-
2503
-
2504
-
2505
-
2506
- .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
2507
-
2508
- ProjectDomainAttributesDeleteRequest
2509
- ------------------------------------------------------------------
2510
-
2511
- Request to delete a set matchable project domain attribute override.
2512
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2513
-
2514
-
2515
-
2516
- .. csv-table:: ProjectDomainAttributesDeleteRequest type fields
2517
- :header: "Field", "Type", "Label", "Description"
2518
- :widths: auto
2519
-
2520
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2521
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2522
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
2523
-
2524
-
2525
-
2526
-
2527
-
2528
-
2529
-
2530
- .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
2531
-
2532
- ProjectDomainAttributesDeleteResponse
2533
- ------------------------------------------------------------------
2534
-
2535
- Purposefully empty, may be populated in the future.
2536
-
2537
-
2538
-
2539
-
2540
-
2541
-
2542
-
2543
-
2544
- .. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
2545
-
2546
- ProjectDomainAttributesGetRequest
2547
- ------------------------------------------------------------------
2548
-
2549
- Request to get an individual project domain attribute override.
2550
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2551
-
2552
-
2553
-
2554
- .. csv-table:: ProjectDomainAttributesGetRequest type fields
2555
- :header: "Field", "Type", "Label", "Description"
2556
- :widths: auto
2557
-
2558
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2559
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2560
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
2561
-
2562
-
2563
-
2564
-
2565
-
2566
-
2567
-
2568
- .. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
2569
-
2570
- ProjectDomainAttributesGetResponse
2571
- ------------------------------------------------------------------
2572
-
2573
- Response to get an individual project domain attribute override.
2574
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2575
-
2576
-
2577
-
2578
- .. csv-table:: ProjectDomainAttributesGetResponse type fields
2579
- :header: "Field", "Type", "Label", "Description"
2580
- :widths: auto
2581
-
2582
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
2583
-
2584
-
2585
-
2586
-
2587
-
2588
-
2589
-
2590
- .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
2591
-
2592
- ProjectDomainAttributesUpdateRequest
2593
- ------------------------------------------------------------------
2594
-
2595
- Sets custom attributes for a project-domain combination.
2596
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2597
-
2598
-
2599
-
2600
- .. csv-table:: ProjectDomainAttributesUpdateRequest type fields
2601
- :header: "Field", "Type", "Label", "Description"
2602
- :widths: auto
2603
-
2604
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
2605
-
2606
-
2607
-
2608
-
2609
-
2610
-
2611
-
2612
- .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
2613
-
2614
- ProjectDomainAttributesUpdateResponse
2615
- ------------------------------------------------------------------
2616
-
2617
- Purposefully empty, may be populated in the future.
2618
-
2619
-
2620
-
2621
-
2622
-
2623
-
2624
- <!-- end messages -->
2625
-
2626
- <!-- end enums -->
2627
-
2628
- <!-- end HasExtensions -->
2629
-
2630
- <!-- end services -->
2631
-
2632
-
2633
-
2634
-
2635
- .. _ref_flyteidl/admin/project.proto:
2636
-
2637
- flyteidl/admin/project.proto
2638
- ==================================================================
2639
-
2640
-
2641
-
2642
-
2643
-
2644
- .. _ref_flyteidl.admin.Domain:
2645
-
2646
- Domain
2647
- ------------------------------------------------------------------
2648
-
2649
- Namespace within a project commonly used to differentiate between different service instances.
2650
- e.g. "production", "development", etc.
2651
-
2652
-
2653
-
2654
- .. csv-table:: Domain type fields
2655
- :header: "Field", "Type", "Label", "Description"
2656
- :widths: auto
2657
-
2658
- "id", ":ref:`ref_string`", "", "Globally unique domain name."
2659
- "name", ":ref:`ref_string`", "", "Display name."
2660
-
2661
-
2662
-
2663
-
2664
-
2665
-
2666
-
2667
- .. _ref_flyteidl.admin.Project:
2668
-
2669
- Project
2670
- ------------------------------------------------------------------
2671
-
2672
- Top-level namespace used to classify different entities like workflows and executions.
2673
-
2674
-
2675
-
2676
- .. csv-table:: Project type fields
2677
- :header: "Field", "Type", "Label", "Description"
2678
- :widths: auto
2679
-
2680
- "id", ":ref:`ref_string`", "", "Globally unique project name."
2681
- "name", ":ref:`ref_string`", "", "Display name."
2682
- "domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
2683
- "description", ":ref:`ref_string`", "", ""
2684
- "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
2685
- "state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
2686
-
2687
-
2688
-
2689
-
2690
-
2691
-
2692
-
2693
- .. _ref_flyteidl.admin.ProjectListRequest:
2694
-
2695
- ProjectListRequest
2696
- ------------------------------------------------------------------
2697
-
2698
- Request to retrieve a list of projects matching specified filters.
2699
- See :ref:`ref_flyteidl.admin.Project` for more details
2700
-
2701
-
2702
-
2703
- .. csv-table:: ProjectListRequest type fields
2704
- :header: "Field", "Type", "Label", "Description"
2705
- :widths: auto
2706
-
2707
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
2708
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional"
2709
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2710
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
2711
-
2712
-
2713
-
2714
-
2715
-
2716
-
2717
-
2718
- .. _ref_flyteidl.admin.ProjectRegisterRequest:
2719
-
2720
- ProjectRegisterRequest
2721
- ------------------------------------------------------------------
2722
-
2723
- Adds a new user-project within the Flyte deployment.
2724
- See :ref:`ref_flyteidl.admin.Project` for more details
2725
-
2726
-
2727
-
2728
- .. csv-table:: ProjectRegisterRequest type fields
2729
- :header: "Field", "Type", "Label", "Description"
2730
- :widths: auto
2731
-
2732
- "project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
2733
-
2734
-
2735
-
2736
-
2737
-
2738
-
2739
-
2740
- .. _ref_flyteidl.admin.ProjectRegisterResponse:
2741
-
2742
- ProjectRegisterResponse
2743
- ------------------------------------------------------------------
2744
-
2745
- Purposefully empty, may be updated in the future.
2746
-
2747
-
2748
-
2749
-
2750
-
2751
-
2752
-
2753
-
2754
- .. _ref_flyteidl.admin.ProjectUpdateResponse:
2755
-
2756
- ProjectUpdateResponse
2757
- ------------------------------------------------------------------
2758
-
2759
- Purposefully empty, may be updated in the future.
2760
-
2761
-
2762
-
2763
-
2764
-
2765
-
2766
-
2767
-
2768
- .. _ref_flyteidl.admin.Projects:
2769
-
2770
- Projects
2771
- ------------------------------------------------------------------
2772
-
2773
- Represents a list of projects.
2774
- See :ref:`ref_flyteidl.admin.Project` for more details
2775
-
2776
-
2777
-
2778
- .. csv-table:: Projects type fields
2779
- :header: "Field", "Type", "Label", "Description"
2780
- :widths: auto
2781
-
2782
- "projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
2783
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
2784
-
2785
-
2786
-
2787
-
2788
-
2789
- <!-- end messages -->
2790
-
2791
-
2792
-
2793
- .. _ref_flyteidl.admin.Project.ProjectState:
2794
-
2795
- Project.ProjectState
2796
- ------------------------------------------------------------------
2797
-
2798
- The state of the project is used to control its visibility in the UI and validity.
2799
-
2800
- .. csv-table:: Enum Project.ProjectState values
2801
- :header: "Name", "Number", "Description"
2802
- :widths: auto
2803
-
2804
- "ACTIVE", "0", "By default, all projects are considered active."
2805
- "ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
2806
- "SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
2807
-
2808
- <!-- end enums -->
2809
-
2810
- <!-- end HasExtensions -->
2811
-
2812
- <!-- end services -->
2813
-
2814
-
2815
-
2816
-
2817
- .. _ref_flyteidl/admin/schedule.proto:
2818
-
2819
- flyteidl/admin/schedule.proto
2820
- ==================================================================
2821
-
2822
-
2823
-
2824
-
2825
-
2826
- .. _ref_flyteidl.admin.CronSchedule:
2827
-
2828
- CronSchedule
2829
- ------------------------------------------------------------------
2830
-
2831
- Options for schedules to run according to a cron expression.
2832
-
2833
-
2834
-
2835
- .. csv-table:: CronSchedule type fields
2836
- :header: "Field", "Type", "Label", "Description"
2837
- :widths: auto
2838
-
2839
- "schedule", ":ref:`ref_string`", "", "Standard/default cron implementation as described by https://en.wikipedia.org/wiki/Cron#CRON_expression; Also supports nonstandard predefined scheduling definitions as described by https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions except @reboot"
2840
- "offset", ":ref:`ref_string`", "", "ISO 8601 duration as described by https://en.wikipedia.org/wiki/ISO_8601#Durations"
2841
-
2842
-
2843
-
2844
-
2845
-
2846
-
2847
-
2848
- .. _ref_flyteidl.admin.FixedRate:
2849
-
2850
- FixedRate
2851
- ------------------------------------------------------------------
2852
-
2853
- Option for schedules run at a certain frequency e.g. every 2 minutes.
2854
-
2855
-
2856
-
2857
- .. csv-table:: FixedRate type fields
2858
- :header: "Field", "Type", "Label", "Description"
2859
- :widths: auto
2860
-
2861
- "value", ":ref:`ref_uint32`", "", ""
2862
- "unit", ":ref:`ref_flyteidl.admin.FixedRateUnit`", "", ""
2863
-
2864
-
2865
-
2866
-
2867
-
2868
-
2869
-
2870
- .. _ref_flyteidl.admin.Schedule:
2871
-
2872
- Schedule
2873
- ------------------------------------------------------------------
2874
-
2875
- Defines complete set of information required to trigger an execution on a schedule.
2876
-
2877
-
2878
-
2879
- .. csv-table:: Schedule type fields
2880
- :header: "Field", "Type", "Label", "Description"
2881
- :widths: auto
2882
-
2883
- "cron_expression", ":ref:`ref_string`", "", "**Deprecated.** Uses AWS syntax: Minutes Hours Day-of-month Month Day-of-week Year e.g. for a schedule that runs every 15 minutes: 0/15 * * * ? *"
2884
- "rate", ":ref:`ref_flyteidl.admin.FixedRate`", "", ""
2885
- "cron_schedule", ":ref:`ref_flyteidl.admin.CronSchedule`", "", ""
2886
- "kickoff_time_input_arg", ":ref:`ref_string`", "", "Name of the input variable that the kickoff time will be supplied to when the workflow is kicked off."
2887
-
2888
-
2889
-
2890
-
2891
-
2892
- <!-- end messages -->
2893
-
2894
-
2895
-
2896
- .. _ref_flyteidl.admin.FixedRateUnit:
2897
-
2898
- FixedRateUnit
2899
- ------------------------------------------------------------------
2900
-
2901
- Represents a frequency at which to run a schedule.
2902
-
2903
- .. csv-table:: Enum FixedRateUnit values
2904
- :header: "Name", "Number", "Description"
2905
- :widths: auto
2906
-
2907
- "MINUTE", "0", ""
2908
- "HOUR", "1", ""
2909
- "DAY", "2", ""
2910
-
2911
- <!-- end enums -->
2912
-
2913
- <!-- end HasExtensions -->
2914
-
2915
- <!-- end services -->
2916
-
2917
-
2918
-
2919
-
2920
- .. _ref_flyteidl/admin/task_execution.proto:
2921
-
2922
- flyteidl/admin/task_execution.proto
2923
- ==================================================================
2924
-
2925
-
2926
-
2927
-
2928
-
2929
- .. _ref_flyteidl.admin.TaskExecution:
2930
-
2931
- TaskExecution
2932
- ------------------------------------------------------------------
2933
-
2934
- Encapsulates all details for a single task execution entity.
2935
- A task execution represents an instantiated task, including all inputs and additional
2936
- metadata as well as computed results included state, outputs, and duration-based attributes.
2937
-
2938
-
2939
-
2940
- .. csv-table:: TaskExecution type fields
2941
- :header: "Field", "Type", "Label", "Description"
2942
- :widths: auto
2943
-
2944
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
2945
- "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
2946
- "closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
2947
- "is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
2948
-
2949
-
2950
-
2951
-
2952
-
2953
-
2954
-
2955
- .. _ref_flyteidl.admin.TaskExecutionClosure:
2956
-
2957
- TaskExecutionClosure
2958
- ------------------------------------------------------------------
2959
-
2960
- Container for task execution details and results.
2961
-
2962
-
2963
-
2964
- .. csv-table:: TaskExecutionClosure type fields
2965
- :header: "Field", "Type", "Label", "Description"
2966
- :widths: auto
2967
-
2968
- "output_uri", ":ref:`ref_string`", "", "**Deprecated.** Path to remote data store where output blob is stored if the execution succeeded (and produced outputs). DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
2969
- "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
2970
- "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
2971
- "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
2972
- "logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
2973
- "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
2974
- "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
2975
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
2976
- "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
2977
- "custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
2978
- "reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
2979
- "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
2980
- "metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
2981
-
2982
-
2983
-
2984
-
2985
-
2986
-
2987
-
2988
- .. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
2989
-
2990
- TaskExecutionGetDataRequest
2991
- ------------------------------------------------------------------
2992
-
2993
- Request structure to fetch inputs and output for a task execution.
2994
- By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
2995
-
2996
-
2997
-
2998
- .. csv-table:: TaskExecutionGetDataRequest type fields
2999
- :header: "Field", "Type", "Label", "Description"
3000
- :widths: auto
3001
-
3002
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
3003
-
3004
-
3005
-
3006
-
3007
-
3008
-
3009
-
3010
- .. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
3011
-
3012
- TaskExecutionGetDataResponse
3013
- ------------------------------------------------------------------
3014
-
3015
- Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
3016
-
3017
-
3018
-
3019
- .. csv-table:: TaskExecutionGetDataResponse type fields
3020
- :header: "Field", "Type", "Label", "Description"
3021
- :widths: auto
3022
-
3023
- "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
3024
- "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
3025
- "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
3026
- "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
3027
-
3028
-
3029
-
3030
-
3031
-
3032
-
3033
-
3034
- .. _ref_flyteidl.admin.TaskExecutionGetRequest:
3035
-
3036
- TaskExecutionGetRequest
3037
- ------------------------------------------------------------------
3038
-
3039
- A message used to fetch a single task execution entity.
3040
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3041
-
3042
-
3043
-
3044
- .. csv-table:: TaskExecutionGetRequest type fields
3045
- :header: "Field", "Type", "Label", "Description"
3046
- :widths: auto
3047
-
3048
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
3049
-
3050
-
3051
-
3052
-
3053
-
3054
-
3055
-
3056
- .. _ref_flyteidl.admin.TaskExecutionList:
3057
-
3058
- TaskExecutionList
3059
- ------------------------------------------------------------------
3060
-
3061
- Response structure for a query to list of task execution entities.
3062
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3063
-
3064
-
3065
-
3066
- .. csv-table:: TaskExecutionList type fields
3067
- :header: "Field", "Type", "Label", "Description"
3068
- :widths: auto
3069
-
3070
- "task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
3071
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
3072
-
3073
-
3074
-
3075
-
3076
-
3077
-
3078
-
3079
- .. _ref_flyteidl.admin.TaskExecutionListRequest:
3080
-
3081
- TaskExecutionListRequest
3082
- ------------------------------------------------------------------
3083
-
3084
- Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
3085
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3086
-
3087
-
3088
-
3089
- .. csv-table:: TaskExecutionListRequest type fields
3090
- :header: "Field", "Type", "Label", "Description"
3091
- :widths: auto
3092
-
3093
- "node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
3094
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
3095
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional"
3096
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
3097
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
3098
-
3099
-
3100
-
3101
-
3102
-
3103
- <!-- end messages -->
3104
-
3105
- <!-- end enums -->
3106
-
3107
- <!-- end HasExtensions -->
3108
-
3109
- <!-- end services -->
3110
-
3111
-
3112
-
3113
-
3114
- .. _ref_flyteidl/admin/task.proto:
3115
-
3116
- flyteidl/admin/task.proto
3117
- ==================================================================
3118
-
3119
-
3120
-
3121
-
3122
-
3123
- .. _ref_flyteidl.admin.Task:
3124
-
3125
- Task
3126
- ------------------------------------------------------------------
3127
-
3128
- Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
3129
- arranged to process workflow inputs and produce a deterministic set of outputs.
3130
- Tasks can come in many varieties tuned for specialized behavior.
3131
-
3132
-
3133
-
3134
- .. csv-table:: Task type fields
3135
- :header: "Field", "Type", "Label", "Description"
3136
- :widths: auto
3137
-
3138
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
3139
- "closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
3140
-
3141
-
3142
-
3143
-
3144
-
3145
-
3146
-
3147
- .. _ref_flyteidl.admin.TaskClosure:
3148
-
3149
- TaskClosure
3150
- ------------------------------------------------------------------
3151
-
3152
- Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
3153
- and task metadata.
3154
-
3155
-
3156
-
3157
- .. csv-table:: TaskClosure type fields
3158
- :header: "Field", "Type", "Label", "Description"
3159
- :widths: auto
3160
-
3161
- "compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
3162
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
3163
-
3164
-
3165
-
3166
-
3167
-
3168
-
3169
-
3170
- .. _ref_flyteidl.admin.TaskCreateRequest:
3171
-
3172
- TaskCreateRequest
3173
- ------------------------------------------------------------------
3174
-
3175
- Represents a request structure to create a revision of a task.
3176
- See :ref:`ref_flyteidl.admin.Task` for more details
3177
-
3178
-
3179
-
3180
- .. csv-table:: TaskCreateRequest type fields
3181
- :header: "Field", "Type", "Label", "Description"
3182
- :widths: auto
3183
-
3184
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
3185
- "spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
3186
-
3187
-
3188
-
3189
-
3190
-
3191
-
3192
-
3193
- .. _ref_flyteidl.admin.TaskCreateResponse:
3194
-
3195
- TaskCreateResponse
3196
- ------------------------------------------------------------------
3197
-
3198
- Represents a response structure if task creation succeeds.
3199
-
3200
- Purposefully empty, may be populated in the future.
3201
-
3202
-
3203
-
3204
-
3205
-
3206
-
3207
-
3208
-
3209
- .. _ref_flyteidl.admin.TaskList:
3210
-
3211
- TaskList
3212
- ------------------------------------------------------------------
3213
-
3214
- Represents a list of tasks returned from the admin.
3215
- See :ref:`ref_flyteidl.admin.Task` for more details
3216
-
3217
-
3218
-
3219
- .. csv-table:: TaskList type fields
3220
- :header: "Field", "Type", "Label", "Description"
3221
- :widths: auto
3222
-
3223
- "tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
3224
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
3225
-
3226
-
3227
-
3228
-
3229
-
3230
-
3231
-
3232
- .. _ref_flyteidl.admin.TaskSpec:
3233
-
3234
- TaskSpec
3235
- ------------------------------------------------------------------
3236
-
3237
- Represents a structure that encapsulates the user-configured specification of the task.
3238
-
3239
-
3240
-
3241
- .. csv-table:: TaskSpec type fields
3242
- :header: "Field", "Type", "Label", "Description"
3243
- :widths: auto
3244
-
3245
- "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
3246
-
3247
-
3248
-
3249
-
3250
-
3251
- <!-- end messages -->
3252
-
3253
- <!-- end enums -->
3254
-
3255
- <!-- end HasExtensions -->
3256
-
3257
- <!-- end services -->
3258
-
3259
-
3260
-
3261
-
3262
- .. _ref_flyteidl/admin/version.proto:
3263
-
3264
- flyteidl/admin/version.proto
3265
- ==================================================================
3266
-
3267
-
3268
-
3269
-
3270
-
3271
- .. _ref_flyteidl.admin.GetVersionRequest:
3272
-
3273
- GetVersionRequest
3274
- ------------------------------------------------------------------
3275
-
3276
- Empty request for GetVersion
3277
-
3278
-
3279
-
3280
-
3281
-
3282
-
3283
-
3284
-
3285
- .. _ref_flyteidl.admin.GetVersionResponse:
3286
-
3287
- GetVersionResponse
3288
- ------------------------------------------------------------------
3289
-
3290
- Response for the GetVersion API
3291
-
3292
-
3293
-
3294
- .. csv-table:: GetVersionResponse type fields
3295
- :header: "Field", "Type", "Label", "Description"
3296
- :widths: auto
3297
-
3298
- "control_plane_version", ":ref:`ref_flyteidl.admin.Version`", "", "The control plane version information. FlyteAdmin and related components form the control plane of Flyte"
3299
-
3300
-
3301
-
3302
-
3303
-
3304
-
3305
-
3306
- .. _ref_flyteidl.admin.Version:
3307
-
3308
- Version
3309
- ------------------------------------------------------------------
3310
-
3311
- Provides Version information for a component
3312
-
3313
-
3314
-
3315
- .. csv-table:: Version type fields
3316
- :header: "Field", "Type", "Label", "Description"
3317
- :widths: auto
3318
-
3319
- "Build", ":ref:`ref_string`", "", "Specifies the GIT sha of the build"
3320
- "Version", ":ref:`ref_string`", "", "Version for the build, should follow a semver"
3321
- "BuildTime", ":ref:`ref_string`", "", "Build timestamp"
3322
-
3323
-
3324
-
3325
-
3326
-
3327
- <!-- end messages -->
3328
-
3329
- <!-- end enums -->
3330
-
3331
- <!-- end HasExtensions -->
3332
-
3333
- <!-- end services -->
3334
-
3335
-
3336
-
3337
-
3338
- .. _ref_flyteidl/admin/workflow_attributes.proto:
3339
-
3340
- flyteidl/admin/workflow_attributes.proto
3341
- ==================================================================
3342
-
3343
-
3344
-
3345
-
3346
-
3347
- .. _ref_flyteidl.admin.WorkflowAttributes:
3348
-
3349
- WorkflowAttributes
3350
- ------------------------------------------------------------------
3351
-
3352
- Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
3353
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3354
-
3355
-
3356
-
3357
- .. csv-table:: WorkflowAttributes type fields
3358
- :header: "Field", "Type", "Label", "Description"
3359
- :widths: auto
3360
-
3361
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
3362
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
3363
- "workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
3364
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
3365
-
3366
-
3367
-
3368
-
3369
-
3370
-
3371
-
3372
- .. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
3373
-
3374
- WorkflowAttributesDeleteRequest
3375
- ------------------------------------------------------------------
3376
-
3377
- Request to delete a set matchable workflow attribute override.
3378
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3379
-
3380
-
3381
-
3382
- .. csv-table:: WorkflowAttributesDeleteRequest type fields
3383
- :header: "Field", "Type", "Label", "Description"
3384
- :widths: auto
3385
-
3386
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3387
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3388
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3389
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
3390
-
3391
-
3392
-
3393
-
3394
-
3395
-
3396
-
3397
- .. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
3398
-
3399
- WorkflowAttributesDeleteResponse
3400
- ------------------------------------------------------------------
3401
-
3402
- Purposefully empty, may be populated in the future.
3403
-
3404
-
3405
-
3406
-
3407
-
3408
-
3409
-
3410
-
3411
- .. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
3412
-
3413
- WorkflowAttributesGetRequest
3414
- ------------------------------------------------------------------
3415
-
3416
- Request to get an individual workflow attribute override.
3417
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3418
-
3419
-
3420
-
3421
- .. csv-table:: WorkflowAttributesGetRequest type fields
3422
- :header: "Field", "Type", "Label", "Description"
3423
- :widths: auto
3424
-
3425
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3426
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3427
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3428
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
3429
-
3430
-
3431
-
3432
-
3433
-
3434
-
3435
-
3436
- .. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
3437
-
3438
- WorkflowAttributesGetResponse
3439
- ------------------------------------------------------------------
3440
-
3441
- Response to get an individual workflow attribute override.
3442
-
3443
-
3444
-
3445
- .. csv-table:: WorkflowAttributesGetResponse type fields
3446
- :header: "Field", "Type", "Label", "Description"
3447
- :widths: auto
3448
-
3449
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3450
-
3451
-
3452
-
3453
-
3454
-
3455
-
3456
-
3457
- .. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
3458
-
3459
- WorkflowAttributesUpdateRequest
3460
- ------------------------------------------------------------------
3461
-
3462
- Sets custom attributes for a project, domain and workflow combination.
3463
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3464
-
3465
-
3466
-
3467
- .. csv-table:: WorkflowAttributesUpdateRequest type fields
3468
- :header: "Field", "Type", "Label", "Description"
3469
- :widths: auto
3470
-
3471
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3472
-
3473
-
3474
-
3475
-
3476
-
3477
-
3478
-
3479
- .. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
3480
-
3481
- WorkflowAttributesUpdateResponse
3482
- ------------------------------------------------------------------
3483
-
3484
- Purposefully empty, may be populated in the future.
3485
-
3486
-
3487
-
3488
-
3489
-
3490
-
3491
- <!-- end messages -->
3492
-
3493
- <!-- end enums -->
3494
-
3495
- <!-- end HasExtensions -->
3496
-
3497
- <!-- end services -->
3498
-
3499
-
3500
-
3501
-
3502
- .. _ref_flyteidl/admin/workflow.proto:
3503
-
3504
- flyteidl/admin/workflow.proto
3505
- ==================================================================
3506
-
3507
-
3508
-
3509
-
3510
-
3511
- .. _ref_flyteidl.admin.Workflow:
3512
-
3513
- Workflow
3514
- ------------------------------------------------------------------
3515
-
3516
- Represents the workflow structure stored in the Admin
3517
- A workflow is created by ordering tasks and associating outputs to inputs
3518
- in order to produce a directed-acyclic execution graph.
3519
-
3520
-
3521
-
3522
- .. csv-table:: Workflow type fields
3523
- :header: "Field", "Type", "Label", "Description"
3524
- :widths: auto
3525
-
3526
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
3527
- "closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
3528
-
3529
-
3530
-
3531
-
3532
-
3533
-
3534
-
3535
- .. _ref_flyteidl.admin.WorkflowClosure:
3536
-
3537
- WorkflowClosure
3538
- ------------------------------------------------------------------
3539
-
3540
- A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
3541
-
3542
-
3543
-
3544
- .. csv-table:: WorkflowClosure type fields
3545
- :header: "Field", "Type", "Label", "Description"
3546
- :widths: auto
3547
-
3548
- "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
3549
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
3550
-
3551
-
3552
-
3553
-
3554
-
3555
-
3556
-
3557
- .. _ref_flyteidl.admin.WorkflowCreateRequest:
3558
-
3559
- WorkflowCreateRequest
3560
- ------------------------------------------------------------------
3561
-
3562
- Represents a request structure to create a revision of a workflow.
3563
- See :ref:`ref_flyteidl.admin.Workflow` for more details
3564
-
3565
-
3566
-
3567
- .. csv-table:: WorkflowCreateRequest type fields
3568
- :header: "Field", "Type", "Label", "Description"
3569
- :widths: auto
3570
-
3571
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
3572
- "spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
3573
-
3574
-
3575
-
3576
-
3577
-
3578
-
3579
-
3580
- .. _ref_flyteidl.admin.WorkflowCreateResponse:
3581
-
3582
- WorkflowCreateResponse
3583
- ------------------------------------------------------------------
3584
-
3585
- Purposefully empty, may be populated in the future.
3586
-
3587
-
3588
-
3589
-
3590
-
3591
-
3592
-
3593
-
3594
- .. _ref_flyteidl.admin.WorkflowList:
3595
-
3596
- WorkflowList
3597
- ------------------------------------------------------------------
3598
-
3599
- Represents a list of workflows returned from the admin.
3600
- See :ref:`ref_flyteidl.admin.Workflow` for more details
3601
-
3602
-
3603
-
3604
- .. csv-table:: WorkflowList type fields
3605
- :header: "Field", "Type", "Label", "Description"
3606
- :widths: auto
3607
-
3608
- "workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
3609
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
3610
-
3611
-
3612
-
3613
-
3614
-
3615
-
3616
-
3617
- .. _ref_flyteidl.admin.WorkflowSpec:
3618
-
3619
- WorkflowSpec
3620
- ------------------------------------------------------------------
3621
-
3622
- Represents a structure that encapsulates the specification of the workflow.
3623
-
3624
-
3625
-
3626
- .. csv-table:: WorkflowSpec type fields
3627
- :header: "Field", "Type", "Label", "Description"
3628
- :widths: auto
3629
-
3630
- "template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
3631
- "sub_workflows", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "repeated", "Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out to Admin to see other registered workflows). In fact, subworkflows do not even need to be registered."
3632
-
3633
-
3634
-
3635
-
3636
-
3637
- <!-- end messages -->
3638
-
3639
- <!-- end enums -->
3640
-
3641
- <!-- end HasExtensions -->
3642
-
3643
- <!-- end services -->
3644
-
3645
-
3646
-
3647
-
3648
- .. _ref_google/protobuf/duration.proto:
3649
-
3650
- google/protobuf/duration.proto
3651
- ==================================================================
3652
-
3653
-
3654
-
3655
-
3656
-
3657
- .. _ref_google.protobuf.Duration:
3658
-
3659
- Duration
3660
- ------------------------------------------------------------------
3661
-
3662
- A Duration represents a signed, fixed-length span of time represented
3663
- as a count of seconds and fractions of seconds at nanosecond
3664
- resolution. It is independent of any calendar and concepts like "day"
3665
- or "month". It is related to Timestamp in that the difference between
3666
- two Timestamp values is a Duration and it can be added or subtracted
3667
- from a Timestamp. Range is approximately +-10,000 years.
3668
-
3669
- # Examples
3670
-
3671
- Example 1: Compute Duration from two Timestamps in pseudo code.
3672
-
3673
- Timestamp start = ...;
3674
- Timestamp end = ...;
3675
- Duration duration = ...;
3676
-
3677
- duration.seconds = end.seconds - start.seconds;
3678
- duration.nanos = end.nanos - start.nanos;
3679
-
3680
- if (duration.seconds < 0 && duration.nanos > 0) {
3681
- duration.seconds += 1;
3682
- duration.nanos -= 1000000000;
3683
- } else if (duration.seconds > 0 && duration.nanos < 0) {
3684
- duration.seconds -= 1;
3685
- duration.nanos += 1000000000;
3686
- }
3687
-
3688
- Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
3689
-
3690
- Timestamp start = ...;
3691
- Duration duration = ...;
3692
- Timestamp end = ...;
3693
-
3694
- end.seconds = start.seconds + duration.seconds;
3695
- end.nanos = start.nanos + duration.nanos;
3696
-
3697
- if (end.nanos < 0) {
3698
- end.seconds -= 1;
3699
- end.nanos += 1000000000;
3700
- } else if (end.nanos >= 1000000000) {
3701
- end.seconds += 1;
3702
- end.nanos -= 1000000000;
3703
- }
3704
-
3705
- Example 3: Compute Duration from datetime.timedelta in Python.
3706
-
3707
- td = datetime.timedelta(days=3, minutes=10)
3708
- duration = Duration()
3709
- duration.FromTimedelta(td)
3710
-
3711
- # JSON Mapping
3712
-
3713
- In JSON format, the Duration type is encoded as a string rather than an
3714
- object, where the string ends in the suffix "s" (indicating seconds) and
3715
- is preceded by the number of seconds, with nanoseconds expressed as
3716
- fractional seconds. For example, 3 seconds with 0 nanoseconds should be
3717
- encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
3718
- be expressed in JSON format as "3.000000001s", and 3 seconds and 1
3719
- microsecond should be expressed in JSON format as "3.000001s".
3720
-
3721
-
3722
-
3723
- .. csv-table:: Duration type fields
3724
- :header: "Field", "Type", "Label", "Description"
3725
- :widths: auto
3726
-
3727
- "seconds", ":ref:`ref_int64`", "", "Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years"
3728
- "nanos", ":ref:`ref_int32`", "", "Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive."
3729
-
3730
-
3731
-
3732
-
3733
-
3734
- <!-- end messages -->
3735
-
3736
- <!-- end enums -->
3737
-
3738
- <!-- end HasExtensions -->
3739
-
3740
- <!-- end services -->
3741
-
3742
-