@flyteorg/flyteidl 0.23.1 → 0.24.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/gen/pb-js/flyteidl.d.ts +435 -4
- package/gen/pb-js/flyteidl.js +1283 -262
- package/package.json +1 -1
- package/protos/docs/admin/admin.rst +466 -360
- package/protos/docs/core/core.rst +143 -40
- package/protos/flyteidl/admin/cluster_assignment.proto +41 -0
- package/protos/flyteidl/admin/execution.proto +5 -1
- package/protos/flyteidl/admin/matchable_resource.proto +6 -0
- package/protos/flyteidl/core/literals.proto +13 -0
- package/protos/flyteidl/core/types.proto +32 -0
|
@@ -5,6 +5,108 @@ Protocol Documentation
|
|
|
5
5
|
|
|
6
6
|
|
|
7
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
|
+
|
|
8
110
|
.. _ref_flyteidl/admin/common.proto:
|
|
9
111
|
|
|
10
112
|
flyteidl/admin/common.proto
|
|
@@ -1053,6 +1155,8 @@ of an execution as it progresses across phase changes.
|
|
|
1053
1155
|
"auth_role", ":ref:`ref_flyteidl.admin.AuthRole`", "", "**Deprecated.** Optional: auth override to apply this execution."
|
|
1054
1156
|
"quality_of_service", ":ref:`ref_flyteidl.core.QualityOfService`", "", "Indicates the runtime priority of the execution."
|
|
1055
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."
|
|
1056
1160
|
|
|
1057
1161
|
|
|
1058
1162
|
|
|
@@ -1839,6 +1943,7 @@ Generic container for encapsulating all types of the above attributes messages.
|
|
|
1839
1943
|
"quality_of_service", ":ref:`ref_flyteidl.core.QualityOfService`", "", ""
|
|
1840
1944
|
"plugin_overrides", ":ref:`ref_flyteidl.admin.PluginOverrides`", "", ""
|
|
1841
1945
|
"workflow_execution_config", ":ref:`ref_flyteidl.admin.WorkflowExecutionConfig`", "", ""
|
|
1946
|
+
"cluster_assignment", ":ref:`ref_flyteidl.admin.ClusterAssignment`", "", ""
|
|
1842
1947
|
|
|
1843
1948
|
|
|
1844
1949
|
|
|
@@ -1981,6 +2086,7 @@ based on matching tags.
|
|
|
1981
2086
|
"QUALITY_OF_SERVICE_SPECIFICATION", "4", "Configures default quality of service when undefined in an execution spec."
|
|
1982
2087
|
"PLUGIN_OVERRIDE", "5", "Selects configurable plugin implementation behavior for a given task type."
|
|
1983
2088
|
"WORKFLOW_EXECUTION_CONFIG", "6", "Adds defaults for customizable workflow-execution specifications and overrides."
|
|
2089
|
+
"CLUSTER_ASSIGNMENT", "7", "Controls how to select an available cluster on which this execution should run."
|
|
1984
2090
|
|
|
1985
2091
|
|
|
1986
2092
|
|
|
@@ -2349,168 +2455,6 @@ Note: This is internal to Admin and doesn't need to be exposed to other componen
|
|
|
2349
2455
|
|
|
2350
2456
|
|
|
2351
2457
|
|
|
2352
|
-
<!-- end messages -->
|
|
2353
|
-
|
|
2354
|
-
<!-- end enums -->
|
|
2355
|
-
|
|
2356
|
-
<!-- end HasExtensions -->
|
|
2357
|
-
|
|
2358
|
-
<!-- end services -->
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
.. _ref_flyteidl/admin/project_domain_attributes.proto:
|
|
2364
|
-
|
|
2365
|
-
flyteidl/admin/project_domain_attributes.proto
|
|
2366
|
-
==================================================================
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributes:
|
|
2373
|
-
|
|
2374
|
-
ProjectDomainAttributes
|
|
2375
|
-
------------------------------------------------------------------
|
|
2376
|
-
|
|
2377
|
-
Defines a set of custom matching attributes which defines resource defaults for a project and domain.
|
|
2378
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
.. csv-table:: ProjectDomainAttributes type fields
|
|
2383
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2384
|
-
:widths: auto
|
|
2385
|
-
|
|
2386
|
-
"project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
|
|
2387
|
-
"domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
|
|
2388
|
-
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
|
|
2397
|
-
|
|
2398
|
-
ProjectDomainAttributesDeleteRequest
|
|
2399
|
-
------------------------------------------------------------------
|
|
2400
|
-
|
|
2401
|
-
Request to delete a set matchable project domain attribute override.
|
|
2402
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
.. csv-table:: ProjectDomainAttributesDeleteRequest type fields
|
|
2407
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2408
|
-
:widths: auto
|
|
2409
|
-
|
|
2410
|
-
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
2411
|
-
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
2412
|
-
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
|
|
2421
|
-
|
|
2422
|
-
ProjectDomainAttributesDeleteResponse
|
|
2423
|
-
------------------------------------------------------------------
|
|
2424
|
-
|
|
2425
|
-
Purposefully empty, may be populated in the future.
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
|
|
2434
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
|
|
2435
|
-
|
|
2436
|
-
ProjectDomainAttributesGetRequest
|
|
2437
|
-
------------------------------------------------------------------
|
|
2438
|
-
|
|
2439
|
-
Request to get an individual project domain attribute override.
|
|
2440
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
.. csv-table:: ProjectDomainAttributesGetRequest type fields
|
|
2445
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2446
|
-
:widths: auto
|
|
2447
|
-
|
|
2448
|
-
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
2449
|
-
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
2450
|
-
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
|
|
2459
|
-
|
|
2460
|
-
ProjectDomainAttributesGetResponse
|
|
2461
|
-
------------------------------------------------------------------
|
|
2462
|
-
|
|
2463
|
-
Response to get an individual project domain attribute override.
|
|
2464
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
|
|
2468
|
-
.. csv-table:: ProjectDomainAttributesGetResponse type fields
|
|
2469
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2470
|
-
:widths: auto
|
|
2471
|
-
|
|
2472
|
-
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
|
|
2478
|
-
|
|
2479
|
-
|
|
2480
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
|
|
2481
|
-
|
|
2482
|
-
ProjectDomainAttributesUpdateRequest
|
|
2483
|
-
------------------------------------------------------------------
|
|
2484
|
-
|
|
2485
|
-
Sets custom attributes for a project-domain combination.
|
|
2486
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
.. csv-table:: ProjectDomainAttributesUpdateRequest type fields
|
|
2491
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2492
|
-
:widths: auto
|
|
2493
|
-
|
|
2494
|
-
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
|
|
2503
|
-
|
|
2504
|
-
ProjectDomainAttributesUpdateResponse
|
|
2505
|
-
------------------------------------------------------------------
|
|
2506
|
-
|
|
2507
|
-
Purposefully empty, may be populated in the future.
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
2458
|
<!-- end messages -->
|
|
2515
2459
|
|
|
2516
2460
|
<!-- end enums -->
|
|
@@ -2704,30 +2648,32 @@ The state of the project is used to control its visibility in the UI and validit
|
|
|
2704
2648
|
|
|
2705
2649
|
|
|
2706
2650
|
|
|
2707
|
-
.. _ref_flyteidl/admin/
|
|
2651
|
+
.. _ref_flyteidl/admin/project_domain_attributes.proto:
|
|
2708
2652
|
|
|
2709
|
-
flyteidl/admin/
|
|
2653
|
+
flyteidl/admin/project_domain_attributes.proto
|
|
2710
2654
|
==================================================================
|
|
2711
2655
|
|
|
2712
2656
|
|
|
2713
2657
|
|
|
2714
2658
|
|
|
2715
2659
|
|
|
2716
|
-
.. _ref_flyteidl.admin.
|
|
2660
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributes:
|
|
2717
2661
|
|
|
2718
|
-
|
|
2662
|
+
ProjectDomainAttributes
|
|
2719
2663
|
------------------------------------------------------------------
|
|
2720
2664
|
|
|
2721
|
-
|
|
2665
|
+
Defines a set of custom matching attributes which defines resource defaults for a project and domain.
|
|
2666
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2722
2667
|
|
|
2723
2668
|
|
|
2724
2669
|
|
|
2725
|
-
.. csv-table::
|
|
2670
|
+
.. csv-table:: ProjectDomainAttributes type fields
|
|
2726
2671
|
:header: "Field", "Type", "Label", "Description"
|
|
2727
2672
|
:widths: auto
|
|
2728
2673
|
|
|
2729
|
-
"
|
|
2730
|
-
"
|
|
2674
|
+
"project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
|
|
2675
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
|
|
2676
|
+
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
2731
2677
|
|
|
2732
2678
|
|
|
2733
2679
|
|
|
@@ -2735,21 +2681,23 @@ Options for schedules to run according to a cron expression.
|
|
|
2735
2681
|
|
|
2736
2682
|
|
|
2737
2683
|
|
|
2738
|
-
.. _ref_flyteidl.admin.
|
|
2684
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
|
|
2739
2685
|
|
|
2740
|
-
|
|
2686
|
+
ProjectDomainAttributesDeleteRequest
|
|
2741
2687
|
------------------------------------------------------------------
|
|
2742
2688
|
|
|
2743
|
-
|
|
2689
|
+
Request to delete a set matchable project domain attribute override.
|
|
2690
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2744
2691
|
|
|
2745
2692
|
|
|
2746
2693
|
|
|
2747
|
-
.. csv-table::
|
|
2694
|
+
.. csv-table:: ProjectDomainAttributesDeleteRequest type fields
|
|
2748
2695
|
:header: "Field", "Type", "Label", "Description"
|
|
2749
2696
|
:widths: auto
|
|
2750
2697
|
|
|
2751
|
-
"
|
|
2752
|
-
"
|
|
2698
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
2699
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
2700
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
|
|
2753
2701
|
|
|
2754
2702
|
|
|
2755
2703
|
|
|
@@ -2757,84 +2705,59 @@ Option for schedules run at a certain frequency e.g. every 2 minutes.
|
|
|
2757
2705
|
|
|
2758
2706
|
|
|
2759
2707
|
|
|
2760
|
-
.. _ref_flyteidl.admin.
|
|
2708
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
|
|
2761
2709
|
|
|
2762
|
-
|
|
2710
|
+
ProjectDomainAttributesDeleteResponse
|
|
2763
2711
|
------------------------------------------------------------------
|
|
2764
2712
|
|
|
2765
|
-
|
|
2766
|
-
|
|
2767
|
-
|
|
2768
|
-
|
|
2769
|
-
.. csv-table:: Schedule type fields
|
|
2770
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2771
|
-
:widths: auto
|
|
2772
|
-
|
|
2773
|
-
"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 * * * ? *"
|
|
2774
|
-
"rate", ":ref:`ref_flyteidl.admin.FixedRate`", "", ""
|
|
2775
|
-
"cron_schedule", ":ref:`ref_flyteidl.admin.CronSchedule`", "", ""
|
|
2776
|
-
"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."
|
|
2713
|
+
Purposefully empty, may be populated in the future.
|
|
2777
2714
|
|
|
2778
2715
|
|
|
2779
2716
|
|
|
2780
2717
|
|
|
2781
2718
|
|
|
2782
|
-
<!-- end messages -->
|
|
2783
2719
|
|
|
2784
2720
|
|
|
2785
2721
|
|
|
2786
|
-
.. _ref_flyteidl.admin.
|
|
2722
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
|
|
2787
2723
|
|
|
2788
|
-
|
|
2724
|
+
ProjectDomainAttributesGetRequest
|
|
2789
2725
|
------------------------------------------------------------------
|
|
2790
2726
|
|
|
2791
|
-
|
|
2792
|
-
|
|
2793
|
-
.. csv-table:: Enum FixedRateUnit values
|
|
2794
|
-
:header: "Name", "Number", "Description"
|
|
2795
|
-
:widths: auto
|
|
2796
|
-
|
|
2797
|
-
"MINUTE", "0", ""
|
|
2798
|
-
"HOUR", "1", ""
|
|
2799
|
-
"DAY", "2", ""
|
|
2800
|
-
|
|
2801
|
-
<!-- end enums -->
|
|
2802
|
-
|
|
2803
|
-
<!-- end HasExtensions -->
|
|
2727
|
+
Request to get an individual project domain attribute override.
|
|
2728
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2804
2729
|
|
|
2805
|
-
<!-- end services -->
|
|
2806
2730
|
|
|
2807
2731
|
|
|
2732
|
+
.. csv-table:: ProjectDomainAttributesGetRequest type fields
|
|
2733
|
+
:header: "Field", "Type", "Label", "Description"
|
|
2734
|
+
:widths: auto
|
|
2808
2735
|
|
|
2736
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
2737
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
2738
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
|
|
2809
2739
|
|
|
2810
|
-
.. _ref_flyteidl/admin/task_execution.proto:
|
|
2811
2740
|
|
|
2812
|
-
flyteidl/admin/task_execution.proto
|
|
2813
|
-
==================================================================
|
|
2814
2741
|
|
|
2815
2742
|
|
|
2816
2743
|
|
|
2817
2744
|
|
|
2818
2745
|
|
|
2819
|
-
.. _ref_flyteidl.admin.
|
|
2746
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
|
|
2820
2747
|
|
|
2821
|
-
|
|
2748
|
+
ProjectDomainAttributesGetResponse
|
|
2822
2749
|
------------------------------------------------------------------
|
|
2823
2750
|
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
metadata as well as computed results included state, outputs, and duration-based attributes.
|
|
2751
|
+
Response to get an individual project domain attribute override.
|
|
2752
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2827
2753
|
|
|
2828
2754
|
|
|
2829
2755
|
|
|
2830
|
-
.. csv-table::
|
|
2756
|
+
.. csv-table:: ProjectDomainAttributesGetResponse type fields
|
|
2831
2757
|
:header: "Field", "Type", "Label", "Description"
|
|
2832
2758
|
:widths: auto
|
|
2833
2759
|
|
|
2834
|
-
"
|
|
2835
|
-
"input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
|
|
2836
|
-
"closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
|
|
2837
|
-
"is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
|
|
2760
|
+
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
|
|
2838
2761
|
|
|
2839
2762
|
|
|
2840
2763
|
|
|
@@ -2842,32 +2765,21 @@ metadata as well as computed results included state, outputs, and duration-based
|
|
|
2842
2765
|
|
|
2843
2766
|
|
|
2844
2767
|
|
|
2845
|
-
.. _ref_flyteidl.admin.
|
|
2768
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
|
|
2846
2769
|
|
|
2847
|
-
|
|
2770
|
+
ProjectDomainAttributesUpdateRequest
|
|
2848
2771
|
------------------------------------------------------------------
|
|
2849
2772
|
|
|
2850
|
-
|
|
2773
|
+
Sets custom attributes for a project-domain combination.
|
|
2774
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2851
2775
|
|
|
2852
2776
|
|
|
2853
2777
|
|
|
2854
|
-
.. csv-table::
|
|
2778
|
+
.. csv-table:: ProjectDomainAttributesUpdateRequest type fields
|
|
2855
2779
|
:header: "Field", "Type", "Label", "Description"
|
|
2856
2780
|
:widths: auto
|
|
2857
2781
|
|
|
2858
|
-
"
|
|
2859
|
-
"error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
|
|
2860
|
-
"output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
|
|
2861
|
-
"phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
|
|
2862
|
-
"logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
|
|
2863
|
-
"started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
|
|
2864
|
-
"duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
|
|
2865
|
-
"created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
|
|
2866
|
-
"updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
|
|
2867
|
-
"custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
|
|
2868
|
-
"reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
|
|
2869
|
-
"task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
|
|
2870
|
-
"metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
|
|
2782
|
+
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
|
|
2871
2783
|
|
|
2872
2784
|
|
|
2873
2785
|
|
|
@@ -2875,67 +2787,53 @@ Container for task execution details and results.
|
|
|
2875
2787
|
|
|
2876
2788
|
|
|
2877
2789
|
|
|
2878
|
-
.. _ref_flyteidl.admin.
|
|
2790
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
|
|
2879
2791
|
|
|
2880
|
-
|
|
2792
|
+
ProjectDomainAttributesUpdateResponse
|
|
2881
2793
|
------------------------------------------------------------------
|
|
2882
2794
|
|
|
2883
|
-
|
|
2884
|
-
By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
.. csv-table:: TaskExecutionGetDataRequest type fields
|
|
2889
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2890
|
-
:widths: auto
|
|
2891
|
-
|
|
2892
|
-
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
|
|
2893
|
-
|
|
2795
|
+
Purposefully empty, may be populated in the future.
|
|
2894
2796
|
|
|
2895
2797
|
|
|
2896
2798
|
|
|
2897
2799
|
|
|
2898
2800
|
|
|
2899
2801
|
|
|
2900
|
-
|
|
2802
|
+
<!-- end messages -->
|
|
2901
2803
|
|
|
2902
|
-
|
|
2903
|
-
------------------------------------------------------------------
|
|
2804
|
+
<!-- end enums -->
|
|
2904
2805
|
|
|
2905
|
-
|
|
2806
|
+
<!-- end HasExtensions -->
|
|
2906
2807
|
|
|
2808
|
+
<!-- end services -->
|
|
2907
2809
|
|
|
2908
2810
|
|
|
2909
|
-
.. csv-table:: TaskExecutionGetDataResponse type fields
|
|
2910
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2911
|
-
:widths: auto
|
|
2912
2811
|
|
|
2913
|
-
"inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
|
|
2914
|
-
"outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
|
|
2915
|
-
"full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
|
|
2916
|
-
"full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
|
|
2917
2812
|
|
|
2813
|
+
.. _ref_flyteidl/admin/schedule.proto:
|
|
2918
2814
|
|
|
2815
|
+
flyteidl/admin/schedule.proto
|
|
2816
|
+
==================================================================
|
|
2919
2817
|
|
|
2920
2818
|
|
|
2921
2819
|
|
|
2922
2820
|
|
|
2923
2821
|
|
|
2924
|
-
.. _ref_flyteidl.admin.
|
|
2822
|
+
.. _ref_flyteidl.admin.CronSchedule:
|
|
2925
2823
|
|
|
2926
|
-
|
|
2824
|
+
CronSchedule
|
|
2927
2825
|
------------------------------------------------------------------
|
|
2928
2826
|
|
|
2929
|
-
|
|
2930
|
-
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
2827
|
+
Options for schedules to run according to a cron expression.
|
|
2931
2828
|
|
|
2932
2829
|
|
|
2933
2830
|
|
|
2934
|
-
.. csv-table::
|
|
2831
|
+
.. csv-table:: CronSchedule type fields
|
|
2935
2832
|
:header: "Field", "Type", "Label", "Description"
|
|
2936
2833
|
:widths: auto
|
|
2937
2834
|
|
|
2938
|
-
"
|
|
2835
|
+
"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"
|
|
2836
|
+
"offset", ":ref:`ref_string`", "", "ISO 8601 duration as described by https://en.wikipedia.org/wiki/ISO_8601#Durations"
|
|
2939
2837
|
|
|
2940
2838
|
|
|
2941
2839
|
|
|
@@ -2943,22 +2841,21 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
|
2943
2841
|
|
|
2944
2842
|
|
|
2945
2843
|
|
|
2946
|
-
.. _ref_flyteidl.admin.
|
|
2844
|
+
.. _ref_flyteidl.admin.FixedRate:
|
|
2947
2845
|
|
|
2948
|
-
|
|
2846
|
+
FixedRate
|
|
2949
2847
|
------------------------------------------------------------------
|
|
2950
2848
|
|
|
2951
|
-
|
|
2952
|
-
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
2849
|
+
Option for schedules run at a certain frequency e.g. every 2 minutes.
|
|
2953
2850
|
|
|
2954
2851
|
|
|
2955
2852
|
|
|
2956
|
-
.. csv-table::
|
|
2853
|
+
.. csv-table:: FixedRate type fields
|
|
2957
2854
|
:header: "Field", "Type", "Label", "Description"
|
|
2958
2855
|
:widths: auto
|
|
2959
2856
|
|
|
2960
|
-
"
|
|
2961
|
-
"
|
|
2857
|
+
"value", ":ref:`ref_uint32`", "", ""
|
|
2858
|
+
"unit", ":ref:`ref_flyteidl.admin.FixedRateUnit`", "", ""
|
|
2962
2859
|
|
|
2963
2860
|
|
|
2964
2861
|
|
|
@@ -2966,25 +2863,23 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
|
2966
2863
|
|
|
2967
2864
|
|
|
2968
2865
|
|
|
2969
|
-
.. _ref_flyteidl.admin.
|
|
2866
|
+
.. _ref_flyteidl.admin.Schedule:
|
|
2970
2867
|
|
|
2971
|
-
|
|
2868
|
+
Schedule
|
|
2972
2869
|
------------------------------------------------------------------
|
|
2973
2870
|
|
|
2974
|
-
|
|
2975
|
-
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
2871
|
+
Defines complete set of information required to trigger an execution on a schedule.
|
|
2976
2872
|
|
|
2977
2873
|
|
|
2978
2874
|
|
|
2979
|
-
.. csv-table::
|
|
2875
|
+
.. csv-table:: Schedule type fields
|
|
2980
2876
|
:header: "Field", "Type", "Label", "Description"
|
|
2981
2877
|
:widths: auto
|
|
2982
2878
|
|
|
2983
|
-
"
|
|
2984
|
-
"
|
|
2985
|
-
"
|
|
2986
|
-
"
|
|
2987
|
-
"sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
|
|
2879
|
+
"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 * * * ? *"
|
|
2880
|
+
"rate", ":ref:`ref_flyteidl.admin.FixedRate`", "", ""
|
|
2881
|
+
"cron_schedule", ":ref:`ref_flyteidl.admin.CronSchedule`", "", ""
|
|
2882
|
+
"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."
|
|
2988
2883
|
|
|
2989
2884
|
|
|
2990
2885
|
|
|
@@ -2992,6 +2887,23 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
|
2992
2887
|
|
|
2993
2888
|
<!-- end messages -->
|
|
2994
2889
|
|
|
2890
|
+
|
|
2891
|
+
|
|
2892
|
+
.. _ref_flyteidl.admin.FixedRateUnit:
|
|
2893
|
+
|
|
2894
|
+
FixedRateUnit
|
|
2895
|
+
------------------------------------------------------------------
|
|
2896
|
+
|
|
2897
|
+
Represents a frequency at which to run a schedule.
|
|
2898
|
+
|
|
2899
|
+
.. csv-table:: Enum FixedRateUnit values
|
|
2900
|
+
:header: "Name", "Number", "Description"
|
|
2901
|
+
:widths: auto
|
|
2902
|
+
|
|
2903
|
+
"MINUTE", "0", ""
|
|
2904
|
+
"HOUR", "1", ""
|
|
2905
|
+
"DAY", "2", ""
|
|
2906
|
+
|
|
2995
2907
|
<!-- end enums -->
|
|
2996
2908
|
|
|
2997
2909
|
<!-- end HasExtensions -->
|
|
@@ -3149,22 +3061,34 @@ Represents a structure that encapsulates the user-configured specification of th
|
|
|
3149
3061
|
|
|
3150
3062
|
|
|
3151
3063
|
|
|
3152
|
-
.. _ref_flyteidl/admin/
|
|
3064
|
+
.. _ref_flyteidl/admin/task_execution.proto:
|
|
3153
3065
|
|
|
3154
|
-
flyteidl/admin/
|
|
3066
|
+
flyteidl/admin/task_execution.proto
|
|
3155
3067
|
==================================================================
|
|
3156
3068
|
|
|
3157
3069
|
|
|
3158
3070
|
|
|
3159
3071
|
|
|
3160
3072
|
|
|
3161
|
-
.. _ref_flyteidl.admin.
|
|
3073
|
+
.. _ref_flyteidl.admin.TaskExecution:
|
|
3162
3074
|
|
|
3163
|
-
|
|
3075
|
+
TaskExecution
|
|
3164
3076
|
------------------------------------------------------------------
|
|
3165
3077
|
|
|
3166
|
-
|
|
3078
|
+
Encapsulates all details for a single task execution entity.
|
|
3079
|
+
A task execution represents an instantiated task, including all inputs and additional
|
|
3080
|
+
metadata as well as computed results included state, outputs, and duration-based attributes.
|
|
3081
|
+
|
|
3082
|
+
|
|
3083
|
+
|
|
3084
|
+
.. csv-table:: TaskExecution type fields
|
|
3085
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3086
|
+
:widths: auto
|
|
3167
3087
|
|
|
3088
|
+
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
|
|
3089
|
+
"input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
|
|
3090
|
+
"closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
|
|
3091
|
+
"is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
|
|
3168
3092
|
|
|
3169
3093
|
|
|
3170
3094
|
|
|
@@ -3172,20 +3096,32 @@ Empty request for GetVersion
|
|
|
3172
3096
|
|
|
3173
3097
|
|
|
3174
3098
|
|
|
3175
|
-
.. _ref_flyteidl.admin.
|
|
3099
|
+
.. _ref_flyteidl.admin.TaskExecutionClosure:
|
|
3176
3100
|
|
|
3177
|
-
|
|
3101
|
+
TaskExecutionClosure
|
|
3178
3102
|
------------------------------------------------------------------
|
|
3179
3103
|
|
|
3180
|
-
|
|
3104
|
+
Container for task execution details and results.
|
|
3181
3105
|
|
|
3182
3106
|
|
|
3183
3107
|
|
|
3184
|
-
.. csv-table::
|
|
3108
|
+
.. csv-table:: TaskExecutionClosure type fields
|
|
3185
3109
|
:header: "Field", "Type", "Label", "Description"
|
|
3186
3110
|
:widths: auto
|
|
3187
3111
|
|
|
3188
|
-
"
|
|
3112
|
+
"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."
|
|
3113
|
+
"error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
|
|
3114
|
+
"output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
|
|
3115
|
+
"phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
|
|
3116
|
+
"logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
|
|
3117
|
+
"started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
|
|
3118
|
+
"duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
|
|
3119
|
+
"created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
|
|
3120
|
+
"updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
|
|
3121
|
+
"custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
|
|
3122
|
+
"reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
|
|
3123
|
+
"task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
|
|
3124
|
+
"metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
|
|
3189
3125
|
|
|
3190
3126
|
|
|
3191
3127
|
|
|
@@ -3193,65 +3129,67 @@ Response for the GetVersion API
|
|
|
3193
3129
|
|
|
3194
3130
|
|
|
3195
3131
|
|
|
3196
|
-
.. _ref_flyteidl.admin.
|
|
3132
|
+
.. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
|
|
3197
3133
|
|
|
3198
|
-
|
|
3134
|
+
TaskExecutionGetDataRequest
|
|
3199
3135
|
------------------------------------------------------------------
|
|
3200
3136
|
|
|
3201
|
-
|
|
3137
|
+
Request structure to fetch inputs and output for a task execution.
|
|
3138
|
+
By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
|
|
3202
3139
|
|
|
3203
3140
|
|
|
3204
3141
|
|
|
3205
|
-
.. csv-table::
|
|
3142
|
+
.. csv-table:: TaskExecutionGetDataRequest type fields
|
|
3206
3143
|
:header: "Field", "Type", "Label", "Description"
|
|
3207
3144
|
:widths: auto
|
|
3208
3145
|
|
|
3209
|
-
"
|
|
3210
|
-
"Version", ":ref:`ref_string`", "", "Version for the build, should follow a semver"
|
|
3211
|
-
"BuildTime", ":ref:`ref_string`", "", "Build timestamp"
|
|
3146
|
+
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
|
|
3212
3147
|
|
|
3213
3148
|
|
|
3214
3149
|
|
|
3215
3150
|
|
|
3216
3151
|
|
|
3217
|
-
<!-- end messages -->
|
|
3218
3152
|
|
|
3219
|
-
<!-- end enums -->
|
|
3220
3153
|
|
|
3221
|
-
|
|
3154
|
+
.. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
|
|
3222
3155
|
|
|
3223
|
-
|
|
3156
|
+
TaskExecutionGetDataResponse
|
|
3157
|
+
------------------------------------------------------------------
|
|
3224
3158
|
|
|
3159
|
+
Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
|
|
3225
3160
|
|
|
3226
3161
|
|
|
3227
3162
|
|
|
3228
|
-
..
|
|
3163
|
+
.. csv-table:: TaskExecutionGetDataResponse type fields
|
|
3164
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3165
|
+
:widths: auto
|
|
3229
3166
|
|
|
3230
|
-
|
|
3231
|
-
|
|
3167
|
+
"inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
|
|
3168
|
+
"outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
|
|
3169
|
+
"full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
|
|
3170
|
+
"full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
|
|
3232
3171
|
|
|
3233
3172
|
|
|
3234
3173
|
|
|
3235
3174
|
|
|
3236
3175
|
|
|
3237
|
-
.. _ref_flyteidl.admin.WorkflowAttributes:
|
|
3238
3176
|
|
|
3239
|
-
|
|
3177
|
+
|
|
3178
|
+
.. _ref_flyteidl.admin.TaskExecutionGetRequest:
|
|
3179
|
+
|
|
3180
|
+
TaskExecutionGetRequest
|
|
3240
3181
|
------------------------------------------------------------------
|
|
3241
3182
|
|
|
3242
|
-
|
|
3243
|
-
|
|
3183
|
+
A message used to fetch a single task execution entity.
|
|
3184
|
+
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3244
3185
|
|
|
3245
3186
|
|
|
3246
3187
|
|
|
3247
|
-
.. csv-table::
|
|
3188
|
+
.. csv-table:: TaskExecutionGetRequest type fields
|
|
3248
3189
|
:header: "Field", "Type", "Label", "Description"
|
|
3249
3190
|
:widths: auto
|
|
3250
3191
|
|
|
3251
|
-
"
|
|
3252
|
-
"domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
|
|
3253
|
-
"workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
|
|
3254
|
-
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
3192
|
+
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
|
|
3255
3193
|
|
|
3256
3194
|
|
|
3257
3195
|
|
|
@@ -3259,24 +3197,22 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
3259
3197
|
|
|
3260
3198
|
|
|
3261
3199
|
|
|
3262
|
-
.. _ref_flyteidl.admin.
|
|
3200
|
+
.. _ref_flyteidl.admin.TaskExecutionList:
|
|
3263
3201
|
|
|
3264
|
-
|
|
3202
|
+
TaskExecutionList
|
|
3265
3203
|
------------------------------------------------------------------
|
|
3266
3204
|
|
|
3267
|
-
|
|
3268
|
-
|
|
3205
|
+
Response structure for a query to list of task execution entities.
|
|
3206
|
+
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3269
3207
|
|
|
3270
3208
|
|
|
3271
3209
|
|
|
3272
|
-
.. csv-table::
|
|
3210
|
+
.. csv-table:: TaskExecutionList type fields
|
|
3273
3211
|
:header: "Field", "Type", "Label", "Description"
|
|
3274
3212
|
:widths: auto
|
|
3275
3213
|
|
|
3276
|
-
"
|
|
3277
|
-
"
|
|
3278
|
-
"workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
|
|
3279
|
-
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
|
|
3214
|
+
"task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
|
|
3215
|
+
"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."
|
|
3280
3216
|
|
|
3281
3217
|
|
|
3282
3218
|
|
|
@@ -3284,59 +3220,57 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
3284
3220
|
|
|
3285
3221
|
|
|
3286
3222
|
|
|
3287
|
-
.. _ref_flyteidl.admin.
|
|
3223
|
+
.. _ref_flyteidl.admin.TaskExecutionListRequest:
|
|
3288
3224
|
|
|
3289
|
-
|
|
3225
|
+
TaskExecutionListRequest
|
|
3290
3226
|
------------------------------------------------------------------
|
|
3291
3227
|
|
|
3292
|
-
|
|
3293
|
-
|
|
3294
|
-
|
|
3228
|
+
Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
|
|
3229
|
+
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3295
3230
|
|
|
3296
3231
|
|
|
3297
3232
|
|
|
3233
|
+
.. csv-table:: TaskExecutionListRequest type fields
|
|
3234
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3235
|
+
:widths: auto
|
|
3298
3236
|
|
|
3237
|
+
"node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
|
|
3238
|
+
"limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
|
|
3239
|
+
"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"
|
|
3240
|
+
"filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
|
|
3241
|
+
"sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
|
|
3299
3242
|
|
|
3300
3243
|
|
|
3301
|
-
.. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
|
|
3302
3244
|
|
|
3303
|
-
WorkflowAttributesGetRequest
|
|
3304
|
-
------------------------------------------------------------------
|
|
3305
3245
|
|
|
3306
|
-
Request to get an individual workflow attribute override.
|
|
3307
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3308
3246
|
|
|
3247
|
+
<!-- end messages -->
|
|
3309
3248
|
|
|
3249
|
+
<!-- end enums -->
|
|
3310
3250
|
|
|
3311
|
-
|
|
3312
|
-
:header: "Field", "Type", "Label", "Description"
|
|
3313
|
-
:widths: auto
|
|
3251
|
+
<!-- end HasExtensions -->
|
|
3314
3252
|
|
|
3315
|
-
|
|
3316
|
-
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
3317
|
-
"workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
|
|
3318
|
-
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
|
|
3253
|
+
<!-- end services -->
|
|
3319
3254
|
|
|
3320
3255
|
|
|
3321
3256
|
|
|
3322
3257
|
|
|
3258
|
+
.. _ref_flyteidl/admin/version.proto:
|
|
3323
3259
|
|
|
3260
|
+
flyteidl/admin/version.proto
|
|
3261
|
+
==================================================================
|
|
3324
3262
|
|
|
3325
3263
|
|
|
3326
|
-
.. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
|
|
3327
3264
|
|
|
3328
|
-
WorkflowAttributesGetResponse
|
|
3329
|
-
------------------------------------------------------------------
|
|
3330
3265
|
|
|
3331
|
-
Response to get an individual workflow attribute override.
|
|
3332
3266
|
|
|
3267
|
+
.. _ref_flyteidl.admin.GetVersionRequest:
|
|
3333
3268
|
|
|
3269
|
+
GetVersionRequest
|
|
3270
|
+
------------------------------------------------------------------
|
|
3334
3271
|
|
|
3335
|
-
|
|
3336
|
-
:header: "Field", "Type", "Label", "Description"
|
|
3337
|
-
:widths: auto
|
|
3272
|
+
Empty request for GetVersion
|
|
3338
3273
|
|
|
3339
|
-
"attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
|
|
3340
3274
|
|
|
3341
3275
|
|
|
3342
3276
|
|
|
@@ -3344,21 +3278,20 @@ Response to get an individual workflow attribute override.
|
|
|
3344
3278
|
|
|
3345
3279
|
|
|
3346
3280
|
|
|
3347
|
-
.. _ref_flyteidl.admin.
|
|
3281
|
+
.. _ref_flyteidl.admin.GetVersionResponse:
|
|
3348
3282
|
|
|
3349
|
-
|
|
3283
|
+
GetVersionResponse
|
|
3350
3284
|
------------------------------------------------------------------
|
|
3351
3285
|
|
|
3352
|
-
|
|
3353
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3286
|
+
Response for the GetVersion API
|
|
3354
3287
|
|
|
3355
3288
|
|
|
3356
3289
|
|
|
3357
|
-
.. csv-table::
|
|
3290
|
+
.. csv-table:: GetVersionResponse type fields
|
|
3358
3291
|
:header: "Field", "Type", "Label", "Description"
|
|
3359
3292
|
:widths: auto
|
|
3360
3293
|
|
|
3361
|
-
"
|
|
3294
|
+
"control_plane_version", ":ref:`ref_flyteidl.admin.Version`", "", "The control plane version information. FlyteAdmin and related components form the control plane of Flyte"
|
|
3362
3295
|
|
|
3363
3296
|
|
|
3364
3297
|
|
|
@@ -3366,13 +3299,22 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
3366
3299
|
|
|
3367
3300
|
|
|
3368
3301
|
|
|
3369
|
-
.. _ref_flyteidl.admin.
|
|
3302
|
+
.. _ref_flyteidl.admin.Version:
|
|
3370
3303
|
|
|
3371
|
-
|
|
3304
|
+
Version
|
|
3372
3305
|
------------------------------------------------------------------
|
|
3373
3306
|
|
|
3374
|
-
|
|
3307
|
+
Provides Version information for a component
|
|
3308
|
+
|
|
3309
|
+
|
|
3310
|
+
|
|
3311
|
+
.. csv-table:: Version type fields
|
|
3312
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3313
|
+
:widths: auto
|
|
3375
3314
|
|
|
3315
|
+
"Build", ":ref:`ref_string`", "", "Specifies the GIT sha of the build"
|
|
3316
|
+
"Version", ":ref:`ref_string`", "", "Version for the build, should follow a semver"
|
|
3317
|
+
"BuildTime", ":ref:`ref_string`", "", "Build timestamp"
|
|
3376
3318
|
|
|
3377
3319
|
|
|
3378
3320
|
|
|
@@ -3524,6 +3466,170 @@ Represents a structure that encapsulates the specification of the workflow.
|
|
|
3524
3466
|
|
|
3525
3467
|
|
|
3526
3468
|
|
|
3469
|
+
<!-- end messages -->
|
|
3470
|
+
|
|
3471
|
+
<!-- end enums -->
|
|
3472
|
+
|
|
3473
|
+
<!-- end HasExtensions -->
|
|
3474
|
+
|
|
3475
|
+
<!-- end services -->
|
|
3476
|
+
|
|
3477
|
+
|
|
3478
|
+
|
|
3479
|
+
|
|
3480
|
+
.. _ref_flyteidl/admin/workflow_attributes.proto:
|
|
3481
|
+
|
|
3482
|
+
flyteidl/admin/workflow_attributes.proto
|
|
3483
|
+
==================================================================
|
|
3484
|
+
|
|
3485
|
+
|
|
3486
|
+
|
|
3487
|
+
|
|
3488
|
+
|
|
3489
|
+
.. _ref_flyteidl.admin.WorkflowAttributes:
|
|
3490
|
+
|
|
3491
|
+
WorkflowAttributes
|
|
3492
|
+
------------------------------------------------------------------
|
|
3493
|
+
|
|
3494
|
+
Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
|
|
3495
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3496
|
+
|
|
3497
|
+
|
|
3498
|
+
|
|
3499
|
+
.. csv-table:: WorkflowAttributes type fields
|
|
3500
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3501
|
+
:widths: auto
|
|
3502
|
+
|
|
3503
|
+
"project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
|
|
3504
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
|
|
3505
|
+
"workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
|
|
3506
|
+
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
3507
|
+
|
|
3508
|
+
|
|
3509
|
+
|
|
3510
|
+
|
|
3511
|
+
|
|
3512
|
+
|
|
3513
|
+
|
|
3514
|
+
.. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
|
|
3515
|
+
|
|
3516
|
+
WorkflowAttributesDeleteRequest
|
|
3517
|
+
------------------------------------------------------------------
|
|
3518
|
+
|
|
3519
|
+
Request to delete a set matchable workflow attribute override.
|
|
3520
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3521
|
+
|
|
3522
|
+
|
|
3523
|
+
|
|
3524
|
+
.. csv-table:: WorkflowAttributesDeleteRequest type fields
|
|
3525
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3526
|
+
:widths: auto
|
|
3527
|
+
|
|
3528
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
3529
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
3530
|
+
"workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
|
|
3531
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
|
|
3532
|
+
|
|
3533
|
+
|
|
3534
|
+
|
|
3535
|
+
|
|
3536
|
+
|
|
3537
|
+
|
|
3538
|
+
|
|
3539
|
+
.. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
|
|
3540
|
+
|
|
3541
|
+
WorkflowAttributesDeleteResponse
|
|
3542
|
+
------------------------------------------------------------------
|
|
3543
|
+
|
|
3544
|
+
Purposefully empty, may be populated in the future.
|
|
3545
|
+
|
|
3546
|
+
|
|
3547
|
+
|
|
3548
|
+
|
|
3549
|
+
|
|
3550
|
+
|
|
3551
|
+
|
|
3552
|
+
|
|
3553
|
+
.. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
|
|
3554
|
+
|
|
3555
|
+
WorkflowAttributesGetRequest
|
|
3556
|
+
------------------------------------------------------------------
|
|
3557
|
+
|
|
3558
|
+
Request to get an individual workflow attribute override.
|
|
3559
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3560
|
+
|
|
3561
|
+
|
|
3562
|
+
|
|
3563
|
+
.. csv-table:: WorkflowAttributesGetRequest type fields
|
|
3564
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3565
|
+
:widths: auto
|
|
3566
|
+
|
|
3567
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
3568
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
3569
|
+
"workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
|
|
3570
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
|
|
3571
|
+
|
|
3572
|
+
|
|
3573
|
+
|
|
3574
|
+
|
|
3575
|
+
|
|
3576
|
+
|
|
3577
|
+
|
|
3578
|
+
.. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
|
|
3579
|
+
|
|
3580
|
+
WorkflowAttributesGetResponse
|
|
3581
|
+
------------------------------------------------------------------
|
|
3582
|
+
|
|
3583
|
+
Response to get an individual workflow attribute override.
|
|
3584
|
+
|
|
3585
|
+
|
|
3586
|
+
|
|
3587
|
+
.. csv-table:: WorkflowAttributesGetResponse type fields
|
|
3588
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3589
|
+
:widths: auto
|
|
3590
|
+
|
|
3591
|
+
"attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
|
|
3592
|
+
|
|
3593
|
+
|
|
3594
|
+
|
|
3595
|
+
|
|
3596
|
+
|
|
3597
|
+
|
|
3598
|
+
|
|
3599
|
+
.. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
|
|
3600
|
+
|
|
3601
|
+
WorkflowAttributesUpdateRequest
|
|
3602
|
+
------------------------------------------------------------------
|
|
3603
|
+
|
|
3604
|
+
Sets custom attributes for a project, domain and workflow combination.
|
|
3605
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3606
|
+
|
|
3607
|
+
|
|
3608
|
+
|
|
3609
|
+
.. csv-table:: WorkflowAttributesUpdateRequest type fields
|
|
3610
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3611
|
+
:widths: auto
|
|
3612
|
+
|
|
3613
|
+
"attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
|
|
3614
|
+
|
|
3615
|
+
|
|
3616
|
+
|
|
3617
|
+
|
|
3618
|
+
|
|
3619
|
+
|
|
3620
|
+
|
|
3621
|
+
.. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
|
|
3622
|
+
|
|
3623
|
+
WorkflowAttributesUpdateResponse
|
|
3624
|
+
------------------------------------------------------------------
|
|
3625
|
+
|
|
3626
|
+
Purposefully empty, may be populated in the future.
|
|
3627
|
+
|
|
3628
|
+
|
|
3629
|
+
|
|
3630
|
+
|
|
3631
|
+
|
|
3632
|
+
|
|
3527
3633
|
<!-- end messages -->
|
|
3528
3634
|
|
|
3529
3635
|
<!-- end enums -->
|