@flyteorg/flyteidl 0.24.16 → 0.24.17

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.
@@ -2492,31 +2492,32 @@ Note: This is internal to Admin and doesn't need to be exposed to other componen
2492
2492
 
2493
2493
 
2494
2494
 
2495
- .. _ref_flyteidl/admin/project.proto:
2495
+ .. _ref_flyteidl/admin/project_domain_attributes.proto:
2496
2496
 
2497
- flyteidl/admin/project.proto
2497
+ flyteidl/admin/project_domain_attributes.proto
2498
2498
  ==================================================================
2499
2499
 
2500
2500
 
2501
2501
 
2502
2502
 
2503
2503
 
2504
- .. _ref_flyteidl.admin.Domain:
2504
+ .. _ref_flyteidl.admin.ProjectDomainAttributes:
2505
2505
 
2506
- Domain
2506
+ ProjectDomainAttributes
2507
2507
  ------------------------------------------------------------------
2508
2508
 
2509
- Namespace within a project commonly used to differentiate between different service instances.
2510
- e.g. "production", "development", etc.
2509
+ Defines a set of custom matching attributes which defines resource defaults for a project and domain.
2510
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2511
2511
 
2512
2512
 
2513
2513
 
2514
- .. csv-table:: Domain type fields
2514
+ .. csv-table:: ProjectDomainAttributes type fields
2515
2515
  :header: "Field", "Type", "Label", "Description"
2516
2516
  :widths: auto
2517
2517
 
2518
- "id", ":ref:`ref_string`", "", "Globally unique domain name."
2519
- "name", ":ref:`ref_string`", "", "Display name."
2518
+ "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
2519
+ "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
2520
+ "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
2520
2521
 
2521
2522
 
2522
2523
 
@@ -2524,25 +2525,23 @@ e.g. "production", "development", etc.
2524
2525
 
2525
2526
 
2526
2527
 
2527
- .. _ref_flyteidl.admin.Project:
2528
+ .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
2528
2529
 
2529
- Project
2530
+ ProjectDomainAttributesDeleteRequest
2530
2531
  ------------------------------------------------------------------
2531
2532
 
2532
- Top-level namespace used to classify different entities like workflows and executions.
2533
+ Request to delete a set matchable project domain attribute override.
2534
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2533
2535
 
2534
2536
 
2535
2537
 
2536
- .. csv-table:: Project type fields
2538
+ .. csv-table:: ProjectDomainAttributesDeleteRequest type fields
2537
2539
  :header: "Field", "Type", "Label", "Description"
2538
2540
  :widths: auto
2539
2541
 
2540
- "id", ":ref:`ref_string`", "", "Globally unique project name."
2541
- "name", ":ref:`ref_string`", "", "Display name."
2542
- "domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
2543
- "description", ":ref:`ref_string`", "", ""
2544
- "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
2545
- "state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
2542
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2543
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2544
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
2546
2545
 
2547
2546
 
2548
2547
 
@@ -2550,24 +2549,13 @@ Top-level namespace used to classify different entities like workflows and execu
2550
2549
 
2551
2550
 
2552
2551
 
2553
- .. _ref_flyteidl.admin.ProjectListRequest:
2552
+ .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
2554
2553
 
2555
- ProjectListRequest
2554
+ ProjectDomainAttributesDeleteResponse
2556
2555
  ------------------------------------------------------------------
2557
2556
 
2558
- Request to retrieve a list of projects matching specified filters.
2559
- See :ref:`ref_flyteidl.admin.Project` for more details
2560
-
2561
-
2562
-
2563
- .. csv-table:: ProjectListRequest type fields
2564
- :header: "Field", "Type", "Label", "Description"
2565
- :widths: auto
2557
+ Purposefully empty, may be populated in the future.
2566
2558
 
2567
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
2568
- "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"
2569
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2570
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
2571
2559
 
2572
2560
 
2573
2561
 
@@ -2575,21 +2563,23 @@ See :ref:`ref_flyteidl.admin.Project` for more details
2575
2563
 
2576
2564
 
2577
2565
 
2578
- .. _ref_flyteidl.admin.ProjectRegisterRequest:
2566
+ .. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
2579
2567
 
2580
- ProjectRegisterRequest
2568
+ ProjectDomainAttributesGetRequest
2581
2569
  ------------------------------------------------------------------
2582
2570
 
2583
- Adds a new user-project within the Flyte deployment.
2584
- See :ref:`ref_flyteidl.admin.Project` for more details
2571
+ Request to get an individual project domain attribute override.
2572
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2585
2573
 
2586
2574
 
2587
2575
 
2588
- .. csv-table:: ProjectRegisterRequest type fields
2576
+ .. csv-table:: ProjectDomainAttributesGetRequest type fields
2589
2577
  :header: "Field", "Type", "Label", "Description"
2590
2578
  :widths: auto
2591
2579
 
2592
- "project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
2580
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2581
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2582
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
2593
2583
 
2594
2584
 
2595
2585
 
@@ -2597,27 +2587,21 @@ See :ref:`ref_flyteidl.admin.Project` for more details
2597
2587
 
2598
2588
 
2599
2589
 
2600
- .. _ref_flyteidl.admin.ProjectRegisterResponse:
2590
+ .. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
2601
2591
 
2602
- ProjectRegisterResponse
2592
+ ProjectDomainAttributesGetResponse
2603
2593
  ------------------------------------------------------------------
2604
2594
 
2605
- Purposefully empty, may be updated in the future.
2606
-
2607
-
2608
-
2609
-
2610
-
2611
-
2612
-
2595
+ Response to get an individual project domain attribute override.
2596
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2613
2597
 
2614
- .. _ref_flyteidl.admin.ProjectUpdateResponse:
2615
2598
 
2616
- ProjectUpdateResponse
2617
- ------------------------------------------------------------------
2618
2599
 
2619
- Purposefully empty, may be updated in the future.
2600
+ .. csv-table:: ProjectDomainAttributesGetResponse type fields
2601
+ :header: "Field", "Type", "Label", "Description"
2602
+ :widths: auto
2620
2603
 
2604
+ "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
2621
2605
 
2622
2606
 
2623
2607
 
@@ -2625,45 +2609,41 @@ Purposefully empty, may be updated in the future.
2625
2609
 
2626
2610
 
2627
2611
 
2628
- .. _ref_flyteidl.admin.Projects:
2612
+ .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
2629
2613
 
2630
- Projects
2614
+ ProjectDomainAttributesUpdateRequest
2631
2615
  ------------------------------------------------------------------
2632
2616
 
2633
- Represents a list of projects.
2634
- See :ref:`ref_flyteidl.admin.Project` for more details
2617
+ Sets custom attributes for a project-domain combination.
2618
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2635
2619
 
2636
2620
 
2637
2621
 
2638
- .. csv-table:: Projects type fields
2622
+ .. csv-table:: ProjectDomainAttributesUpdateRequest type fields
2639
2623
  :header: "Field", "Type", "Label", "Description"
2640
2624
  :widths: auto
2641
2625
 
2642
- "projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
2643
- "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."
2644
-
2626
+ "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
2645
2627
 
2646
2628
 
2647
2629
 
2648
2630
 
2649
- <!-- end messages -->
2650
2631
 
2651
2632
 
2652
2633
 
2653
- .. _ref_flyteidl.admin.Project.ProjectState:
2634
+ .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
2654
2635
 
2655
- Project.ProjectState
2636
+ ProjectDomainAttributesUpdateResponse
2656
2637
  ------------------------------------------------------------------
2657
2638
 
2658
- The state of the project is used to control its visibility in the UI and validity.
2639
+ Purposefully empty, may be populated in the future.
2640
+
2659
2641
 
2660
- .. csv-table:: Enum Project.ProjectState values
2661
- :header: "Name", "Number", "Description"
2662
- :widths: auto
2663
2642
 
2664
- "ACTIVE", "0", "By default, all projects are considered active."
2665
- "ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
2666
- "SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
2643
+
2644
+
2645
+
2646
+ <!-- end messages -->
2667
2647
 
2668
2648
  <!-- end enums -->
2669
2649
 
@@ -2674,32 +2654,31 @@ The state of the project is used to control its visibility in the UI and validit
2674
2654
 
2675
2655
 
2676
2656
 
2677
- .. _ref_flyteidl/admin/project_domain_attributes.proto:
2657
+ .. _ref_flyteidl/admin/project.proto:
2678
2658
 
2679
- flyteidl/admin/project_domain_attributes.proto
2659
+ flyteidl/admin/project.proto
2680
2660
  ==================================================================
2681
2661
 
2682
2662
 
2683
2663
 
2684
2664
 
2685
2665
 
2686
- .. _ref_flyteidl.admin.ProjectDomainAttributes:
2666
+ .. _ref_flyteidl.admin.Domain:
2687
2667
 
2688
- ProjectDomainAttributes
2668
+ Domain
2689
2669
  ------------------------------------------------------------------
2690
2670
 
2691
- Defines a set of custom matching attributes which defines resource defaults for a project and domain.
2692
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2671
+ Namespace within a project commonly used to differentiate between different service instances.
2672
+ e.g. "production", "development", etc.
2693
2673
 
2694
2674
 
2695
2675
 
2696
- .. csv-table:: ProjectDomainAttributes type fields
2676
+ .. csv-table:: Domain type fields
2697
2677
  :header: "Field", "Type", "Label", "Description"
2698
2678
  :widths: auto
2699
2679
 
2700
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
2701
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
2702
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
2680
+ "id", ":ref:`ref_string`", "", "Globally unique domain name."
2681
+ "name", ":ref:`ref_string`", "", "Display name."
2703
2682
 
2704
2683
 
2705
2684
 
@@ -2707,23 +2686,25 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
2707
2686
 
2708
2687
 
2709
2688
 
2710
- .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
2689
+ .. _ref_flyteidl.admin.Project:
2711
2690
 
2712
- ProjectDomainAttributesDeleteRequest
2691
+ Project
2713
2692
  ------------------------------------------------------------------
2714
2693
 
2715
- Request to delete a set matchable project domain attribute override.
2716
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2694
+ Top-level namespace used to classify different entities like workflows and executions.
2717
2695
 
2718
2696
 
2719
2697
 
2720
- .. csv-table:: ProjectDomainAttributesDeleteRequest type fields
2698
+ .. csv-table:: Project type fields
2721
2699
  :header: "Field", "Type", "Label", "Description"
2722
2700
  :widths: auto
2723
2701
 
2724
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2725
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2726
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
2702
+ "id", ":ref:`ref_string`", "", "Globally unique project name."
2703
+ "name", ":ref:`ref_string`", "", "Display name."
2704
+ "domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
2705
+ "description", ":ref:`ref_string`", "", ""
2706
+ "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
2707
+ "state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
2727
2708
 
2728
2709
 
2729
2710
 
@@ -2731,37 +2712,46 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
2731
2712
 
2732
2713
 
2733
2714
 
2734
- .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
2715
+ .. _ref_flyteidl.admin.ProjectListRequest:
2735
2716
 
2736
- ProjectDomainAttributesDeleteResponse
2717
+ ProjectListRequest
2737
2718
  ------------------------------------------------------------------
2738
2719
 
2739
- Purposefully empty, may be populated in the future.
2720
+ Request to retrieve a list of projects matching specified filters.
2721
+ See :ref:`ref_flyteidl.admin.Project` for more details
2740
2722
 
2741
2723
 
2742
2724
 
2725
+ .. csv-table:: ProjectListRequest type fields
2726
+ :header: "Field", "Type", "Label", "Description"
2727
+ :widths: auto
2743
2728
 
2729
+ "limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
2730
+ "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"
2731
+ "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2732
+ "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
2744
2733
 
2745
2734
 
2746
2735
 
2747
2736
 
2748
- .. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
2749
2737
 
2750
- ProjectDomainAttributesGetRequest
2738
+
2739
+
2740
+ .. _ref_flyteidl.admin.ProjectRegisterRequest:
2741
+
2742
+ ProjectRegisterRequest
2751
2743
  ------------------------------------------------------------------
2752
2744
 
2753
- Request to get an individual project domain attribute override.
2754
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2745
+ Adds a new user-project within the Flyte deployment.
2746
+ See :ref:`ref_flyteidl.admin.Project` for more details
2755
2747
 
2756
2748
 
2757
2749
 
2758
- .. csv-table:: ProjectDomainAttributesGetRequest type fields
2750
+ .. csv-table:: ProjectRegisterRequest type fields
2759
2751
  :header: "Field", "Type", "Label", "Description"
2760
2752
  :widths: auto
2761
2753
 
2762
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2763
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2764
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
2754
+ "project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
2765
2755
 
2766
2756
 
2767
2757
 
@@ -2769,63 +2759,73 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
2769
2759
 
2770
2760
 
2771
2761
 
2772
- .. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
2762
+ .. _ref_flyteidl.admin.ProjectRegisterResponse:
2773
2763
 
2774
- ProjectDomainAttributesGetResponse
2764
+ ProjectRegisterResponse
2775
2765
  ------------------------------------------------------------------
2776
2766
 
2777
- Response to get an individual project domain attribute override.
2778
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2767
+ Purposefully empty, may be updated in the future.
2779
2768
 
2780
2769
 
2781
2770
 
2782
- .. csv-table:: ProjectDomainAttributesGetResponse type fields
2783
- :header: "Field", "Type", "Label", "Description"
2784
- :widths: auto
2785
2771
 
2786
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
2787
2772
 
2788
2773
 
2789
2774
 
2790
2775
 
2776
+ .. _ref_flyteidl.admin.ProjectUpdateResponse:
2791
2777
 
2778
+ ProjectUpdateResponse
2779
+ ------------------------------------------------------------------
2792
2780
 
2781
+ Purposefully empty, may be updated in the future.
2793
2782
 
2794
- .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
2795
2783
 
2796
- ProjectDomainAttributesUpdateRequest
2797
- ------------------------------------------------------------------
2798
2784
 
2799
- Sets custom attributes for a project-domain combination.
2800
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2801
2785
 
2802
2786
 
2803
2787
 
2804
- .. csv-table:: ProjectDomainAttributesUpdateRequest type fields
2805
- :header: "Field", "Type", "Label", "Description"
2806
- :widths: auto
2807
2788
 
2808
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
2809
2789
 
2790
+ .. _ref_flyteidl.admin.Projects:
2810
2791
 
2792
+ Projects
2793
+ ------------------------------------------------------------------
2811
2794
 
2795
+ Represents a list of projects.
2796
+ See :ref:`ref_flyteidl.admin.Project` for more details
2812
2797
 
2813
2798
 
2814
2799
 
2800
+ .. csv-table:: Projects type fields
2801
+ :header: "Field", "Type", "Label", "Description"
2802
+ :widths: auto
2815
2803
 
2816
- .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
2804
+ "projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
2805
+ "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."
2817
2806
 
2818
- ProjectDomainAttributesUpdateResponse
2819
- ------------------------------------------------------------------
2820
2807
 
2821
- Purposefully empty, may be populated in the future.
2822
2808
 
2823
2809
 
2824
2810
 
2811
+ <!-- end messages -->
2825
2812
 
2826
2813
 
2827
2814
 
2828
- <!-- end messages -->
2815
+ .. _ref_flyteidl.admin.Project.ProjectState:
2816
+
2817
+ Project.ProjectState
2818
+ ------------------------------------------------------------------
2819
+
2820
+ The state of the project is used to control its visibility in the UI and validity.
2821
+
2822
+ .. csv-table:: Enum Project.ProjectState values
2823
+ :header: "Name", "Number", "Description"
2824
+ :widths: auto
2825
+
2826
+ "ACTIVE", "0", "By default, all projects are considered active."
2827
+ "ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
2828
+ "SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
2829
2829
 
2830
2830
  <!-- end enums -->
2831
2831
 
@@ -2939,32 +2939,34 @@ Represents a frequency at which to run a schedule.
2939
2939
 
2940
2940
 
2941
2941
 
2942
- .. _ref_flyteidl/admin/task.proto:
2942
+ .. _ref_flyteidl/admin/task_execution.proto:
2943
2943
 
2944
- flyteidl/admin/task.proto
2944
+ flyteidl/admin/task_execution.proto
2945
2945
  ==================================================================
2946
2946
 
2947
2947
 
2948
2948
 
2949
2949
 
2950
2950
 
2951
- .. _ref_flyteidl.admin.Task:
2951
+ .. _ref_flyteidl.admin.TaskExecution:
2952
2952
 
2953
- Task
2953
+ TaskExecution
2954
2954
  ------------------------------------------------------------------
2955
2955
 
2956
- Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
2957
- arranged to process workflow inputs and produce a deterministic set of outputs.
2958
- Tasks can come in many varieties tuned for specialized behavior.
2956
+ Encapsulates all details for a single task execution entity.
2957
+ A task execution represents an instantiated task, including all inputs and additional
2958
+ metadata as well as computed results included state, outputs, and duration-based attributes.
2959
2959
 
2960
2960
 
2961
2961
 
2962
- .. csv-table:: Task type fields
2962
+ .. csv-table:: TaskExecution type fields
2963
2963
  :header: "Field", "Type", "Label", "Description"
2964
2964
  :widths: auto
2965
2965
 
2966
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
2967
- "closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
2966
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
2967
+ "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
2968
+ "closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
2969
+ "is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
2968
2970
 
2969
2971
 
2970
2972
 
@@ -2972,22 +2974,33 @@ Tasks can come in many varieties tuned for specialized behavior.
2972
2974
 
2973
2975
 
2974
2976
 
2975
- .. _ref_flyteidl.admin.TaskClosure:
2977
+ .. _ref_flyteidl.admin.TaskExecutionClosure:
2976
2978
 
2977
- TaskClosure
2979
+ TaskExecutionClosure
2978
2980
  ------------------------------------------------------------------
2979
2981
 
2980
- Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
2981
- and task metadata.
2982
+ Container for task execution details and results.
2982
2983
 
2983
2984
 
2984
2985
 
2985
- .. csv-table:: TaskClosure type fields
2986
+ .. csv-table:: TaskExecutionClosure type fields
2986
2987
  :header: "Field", "Type", "Label", "Description"
2987
2988
  :widths: auto
2988
2989
 
2989
- "compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
2990
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
2990
+ "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."
2991
+ "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
2992
+ "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
2993
+ "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
2994
+ "logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
2995
+ "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
2996
+ "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
2997
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
2998
+ "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
2999
+ "custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
3000
+ "reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
3001
+ "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
3002
+ "metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
3003
+ "event_version", ":ref:`ref_int32`", "", "The event version is used to indicate versioned changes in how data is maintained using this proto message. For example, event_verison > 0 means that maps tasks logs use the TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog in this message."
2991
3004
 
2992
3005
 
2993
3006
 
@@ -2995,22 +3008,21 @@ and task metadata.
2995
3008
 
2996
3009
 
2997
3010
 
2998
- .. _ref_flyteidl.admin.TaskCreateRequest:
3011
+ .. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
2999
3012
 
3000
- TaskCreateRequest
3013
+ TaskExecutionGetDataRequest
3001
3014
  ------------------------------------------------------------------
3002
3015
 
3003
- Represents a request structure to create a revision of a task.
3004
- See :ref:`ref_flyteidl.admin.Task` for more details
3016
+ Request structure to fetch inputs and output for a task execution.
3017
+ By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
3005
3018
 
3006
3019
 
3007
3020
 
3008
- .. csv-table:: TaskCreateRequest type fields
3021
+ .. csv-table:: TaskExecutionGetDataRequest type fields
3009
3022
  :header: "Field", "Type", "Label", "Description"
3010
3023
  :widths: auto
3011
3024
 
3012
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
3013
- "spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
3025
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
3014
3026
 
3015
3027
 
3016
3028
 
@@ -3018,38 +3030,45 @@ See :ref:`ref_flyteidl.admin.Task` for more details
3018
3030
 
3019
3031
 
3020
3032
 
3021
- .. _ref_flyteidl.admin.TaskCreateResponse:
3033
+ .. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
3022
3034
 
3023
- TaskCreateResponse
3035
+ TaskExecutionGetDataResponse
3024
3036
  ------------------------------------------------------------------
3025
3037
 
3026
- Represents a response structure if task creation succeeds.
3038
+ Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
3027
3039
 
3028
- Purposefully empty, may be populated in the future.
3029
3040
 
3030
3041
 
3042
+ .. csv-table:: TaskExecutionGetDataResponse type fields
3043
+ :header: "Field", "Type", "Label", "Description"
3044
+ :widths: auto
3031
3045
 
3046
+ "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
3047
+ "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
3048
+ "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
3049
+ "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
3032
3050
 
3033
3051
 
3034
3052
 
3035
3053
 
3036
3054
 
3037
- .. _ref_flyteidl.admin.TaskList:
3038
3055
 
3039
- TaskList
3056
+
3057
+ .. _ref_flyteidl.admin.TaskExecutionGetRequest:
3058
+
3059
+ TaskExecutionGetRequest
3040
3060
  ------------------------------------------------------------------
3041
3061
 
3042
- Represents a list of tasks returned from the admin.
3043
- See :ref:`ref_flyteidl.admin.Task` for more details
3062
+ A message used to fetch a single task execution entity.
3063
+ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3044
3064
 
3045
3065
 
3046
3066
 
3047
- .. csv-table:: TaskList type fields
3067
+ .. csv-table:: TaskExecutionGetRequest type fields
3048
3068
  :header: "Field", "Type", "Label", "Description"
3049
3069
  :widths: auto
3050
3070
 
3051
- "tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
3052
- "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."
3071
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
3053
3072
 
3054
3073
 
3055
3074
 
@@ -3057,97 +3076,90 @@ See :ref:`ref_flyteidl.admin.Task` for more details
3057
3076
 
3058
3077
 
3059
3078
 
3060
- .. _ref_flyteidl.admin.TaskSpec:
3079
+ .. _ref_flyteidl.admin.TaskExecutionList:
3061
3080
 
3062
- TaskSpec
3081
+ TaskExecutionList
3063
3082
  ------------------------------------------------------------------
3064
3083
 
3065
- Represents a structure that encapsulates the user-configured specification of the task.
3084
+ Response structure for a query to list of task execution entities.
3085
+ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3066
3086
 
3067
3087
 
3068
3088
 
3069
- .. csv-table:: TaskSpec type fields
3089
+ .. csv-table:: TaskExecutionList type fields
3070
3090
  :header: "Field", "Type", "Label", "Description"
3071
3091
  :widths: auto
3072
3092
 
3073
- "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
3093
+ "task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
3094
+ "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."
3074
3095
 
3075
3096
 
3076
3097
 
3077
3098
 
3078
3099
 
3079
- <!-- end messages -->
3080
3100
 
3081
- <!-- end enums -->
3082
3101
 
3083
- <!-- end HasExtensions -->
3102
+ .. _ref_flyteidl.admin.TaskExecutionListRequest:
3084
3103
 
3085
- <!-- end services -->
3104
+ TaskExecutionListRequest
3105
+ ------------------------------------------------------------------
3086
3106
 
3107
+ Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
3108
+ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3087
3109
 
3088
3110
 
3089
3111
 
3090
- .. _ref_flyteidl/admin/task_execution.proto:
3112
+ .. csv-table:: TaskExecutionListRequest type fields
3113
+ :header: "Field", "Type", "Label", "Description"
3114
+ :widths: auto
3091
3115
 
3092
- flyteidl/admin/task_execution.proto
3093
- ==================================================================
3116
+ "node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
3117
+ "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
3118
+ "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"
3119
+ "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
3120
+ "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
3094
3121
 
3095
3122
 
3096
3123
 
3097
3124
 
3098
3125
 
3099
- .. _ref_flyteidl.admin.TaskExecution:
3126
+ <!-- end messages -->
3100
3127
 
3101
- TaskExecution
3102
- ------------------------------------------------------------------
3128
+ <!-- end enums -->
3103
3129
 
3104
- Encapsulates all details for a single task execution entity.
3105
- A task execution represents an instantiated task, including all inputs and additional
3106
- metadata as well as computed results included state, outputs, and duration-based attributes.
3130
+ <!-- end HasExtensions -->
3107
3131
 
3132
+ <!-- end services -->
3108
3133
 
3109
3134
 
3110
- .. csv-table:: TaskExecution type fields
3111
- :header: "Field", "Type", "Label", "Description"
3112
- :widths: auto
3113
3135
 
3114
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
3115
- "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
3116
- "closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
3117
- "is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
3118
3136
 
3137
+ .. _ref_flyteidl/admin/task.proto:
3119
3138
 
3139
+ flyteidl/admin/task.proto
3140
+ ==================================================================
3120
3141
 
3121
3142
 
3122
3143
 
3123
3144
 
3124
3145
 
3125
- .. _ref_flyteidl.admin.TaskExecutionClosure:
3146
+ .. _ref_flyteidl.admin.Task:
3126
3147
 
3127
- TaskExecutionClosure
3148
+ Task
3128
3149
  ------------------------------------------------------------------
3129
3150
 
3130
- Container for task execution details and results.
3151
+ Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
3152
+ arranged to process workflow inputs and produce a deterministic set of outputs.
3153
+ Tasks can come in many varieties tuned for specialized behavior.
3131
3154
 
3132
3155
 
3133
3156
 
3134
- .. csv-table:: TaskExecutionClosure type fields
3157
+ .. csv-table:: Task type fields
3135
3158
  :header: "Field", "Type", "Label", "Description"
3136
3159
  :widths: auto
3137
3160
 
3138
- "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."
3139
- "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
3140
- "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
3141
- "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
3142
- "logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
3143
- "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
3144
- "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
3145
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
3146
- "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
3147
- "custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
3148
- "reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
3149
- "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
3150
- "metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
3161
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
3162
+ "closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
3151
3163
 
3152
3164
 
3153
3165
 
@@ -3155,21 +3167,22 @@ Container for task execution details and results.
3155
3167
 
3156
3168
 
3157
3169
 
3158
- .. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
3170
+ .. _ref_flyteidl.admin.TaskClosure:
3159
3171
 
3160
- TaskExecutionGetDataRequest
3172
+ TaskClosure
3161
3173
  ------------------------------------------------------------------
3162
3174
 
3163
- Request structure to fetch inputs and output for a task execution.
3164
- By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
3175
+ Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
3176
+ and task metadata.
3165
3177
 
3166
3178
 
3167
3179
 
3168
- .. csv-table:: TaskExecutionGetDataRequest type fields
3180
+ .. csv-table:: TaskClosure type fields
3169
3181
  :header: "Field", "Type", "Label", "Description"
3170
3182
  :widths: auto
3171
3183
 
3172
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
3184
+ "compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
3185
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
3173
3186
 
3174
3187
 
3175
3188
 
@@ -3177,23 +3190,22 @@ By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExec
3177
3190
 
3178
3191
 
3179
3192
 
3180
- .. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
3193
+ .. _ref_flyteidl.admin.TaskCreateRequest:
3181
3194
 
3182
- TaskExecutionGetDataResponse
3195
+ TaskCreateRequest
3183
3196
  ------------------------------------------------------------------
3184
3197
 
3185
- Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
3198
+ Represents a request structure to create a revision of a task.
3199
+ See :ref:`ref_flyteidl.admin.Task` for more details
3186
3200
 
3187
3201
 
3188
3202
 
3189
- .. csv-table:: TaskExecutionGetDataResponse type fields
3203
+ .. csv-table:: TaskCreateRequest type fields
3190
3204
  :header: "Field", "Type", "Label", "Description"
3191
3205
  :widths: auto
3192
3206
 
3193
- "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
3194
- "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
3195
- "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
3196
- "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
3207
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
3208
+ "spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
3197
3209
 
3198
3210
 
3199
3211
 
@@ -3201,21 +3213,15 @@ Response structure for TaskExecutionGetDataRequest which contains inputs and out
3201
3213
 
3202
3214
 
3203
3215
 
3204
- .. _ref_flyteidl.admin.TaskExecutionGetRequest:
3216
+ .. _ref_flyteidl.admin.TaskCreateResponse:
3205
3217
 
3206
- TaskExecutionGetRequest
3218
+ TaskCreateResponse
3207
3219
  ------------------------------------------------------------------
3208
3220
 
3209
- A message used to fetch a single task execution entity.
3210
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3211
-
3212
-
3221
+ Represents a response structure if task creation succeeds.
3213
3222
 
3214
- .. csv-table:: TaskExecutionGetRequest type fields
3215
- :header: "Field", "Type", "Label", "Description"
3216
- :widths: auto
3223
+ Purposefully empty, may be populated in the future.
3217
3224
 
3218
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
3219
3225
 
3220
3226
 
3221
3227
 
@@ -3223,21 +3229,21 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3223
3229
 
3224
3230
 
3225
3231
 
3226
- .. _ref_flyteidl.admin.TaskExecutionList:
3232
+ .. _ref_flyteidl.admin.TaskList:
3227
3233
 
3228
- TaskExecutionList
3234
+ TaskList
3229
3235
  ------------------------------------------------------------------
3230
3236
 
3231
- Response structure for a query to list of task execution entities.
3232
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3237
+ Represents a list of tasks returned from the admin.
3238
+ See :ref:`ref_flyteidl.admin.Task` for more details
3233
3239
 
3234
3240
 
3235
3241
 
3236
- .. csv-table:: TaskExecutionList type fields
3242
+ .. csv-table:: TaskList type fields
3237
3243
  :header: "Field", "Type", "Label", "Description"
3238
3244
  :widths: auto
3239
3245
 
3240
- "task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
3246
+ "tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
3241
3247
  "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."
3242
3248
 
3243
3249
 
@@ -3246,25 +3252,20 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3246
3252
 
3247
3253
 
3248
3254
 
3249
- .. _ref_flyteidl.admin.TaskExecutionListRequest:
3255
+ .. _ref_flyteidl.admin.TaskSpec:
3250
3256
 
3251
- TaskExecutionListRequest
3257
+ TaskSpec
3252
3258
  ------------------------------------------------------------------
3253
3259
 
3254
- Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
3255
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3260
+ Represents a structure that encapsulates the user-configured specification of the task.
3256
3261
 
3257
3262
 
3258
3263
 
3259
- .. csv-table:: TaskExecutionListRequest type fields
3264
+ .. csv-table:: TaskSpec type fields
3260
3265
  :header: "Field", "Type", "Label", "Description"
3261
3266
  :widths: auto
3262
3267
 
3263
- "node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
3264
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
3265
- "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"
3266
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
3267
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
3268
+ "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
3268
3269
 
3269
3270
 
3270
3271
 
@@ -3357,32 +3358,33 @@ Provides Version information for a component
3357
3358
 
3358
3359
 
3359
3360
 
3360
- .. _ref_flyteidl/admin/workflow.proto:
3361
+ .. _ref_flyteidl/admin/workflow_attributes.proto:
3361
3362
 
3362
- flyteidl/admin/workflow.proto
3363
+ flyteidl/admin/workflow_attributes.proto
3363
3364
  ==================================================================
3364
3365
 
3365
3366
 
3366
3367
 
3367
3368
 
3368
3369
 
3369
- .. _ref_flyteidl.admin.Workflow:
3370
+ .. _ref_flyteidl.admin.WorkflowAttributes:
3370
3371
 
3371
- Workflow
3372
+ WorkflowAttributes
3372
3373
  ------------------------------------------------------------------
3373
3374
 
3374
- Represents the workflow structure stored in the Admin
3375
- A workflow is created by ordering tasks and associating outputs to inputs
3376
- in order to produce a directed-acyclic execution graph.
3375
+ Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
3376
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3377
3377
 
3378
3378
 
3379
3379
 
3380
- .. csv-table:: Workflow type fields
3380
+ .. csv-table:: WorkflowAttributes type fields
3381
3381
  :header: "Field", "Type", "Label", "Description"
3382
3382
  :widths: auto
3383
3383
 
3384
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
3385
- "closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
3384
+ "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
3385
+ "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
3386
+ "workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
3387
+ "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
3386
3388
 
3387
3389
 
3388
3390
 
@@ -3390,21 +3392,24 @@ in order to produce a directed-acyclic execution graph.
3390
3392
 
3391
3393
 
3392
3394
 
3393
- .. _ref_flyteidl.admin.WorkflowClosure:
3395
+ .. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
3394
3396
 
3395
- WorkflowClosure
3397
+ WorkflowAttributesDeleteRequest
3396
3398
  ------------------------------------------------------------------
3397
3399
 
3398
- A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
3400
+ Request to delete a set matchable workflow attribute override.
3401
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3399
3402
 
3400
3403
 
3401
3404
 
3402
- .. csv-table:: WorkflowClosure type fields
3405
+ .. csv-table:: WorkflowAttributesDeleteRequest type fields
3403
3406
  :header: "Field", "Type", "Label", "Description"
3404
3407
  :widths: auto
3405
3408
 
3406
- "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
3407
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
3409
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3410
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3411
+ "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3412
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
3408
3413
 
3409
3414
 
3410
3415
 
@@ -3412,36 +3417,38 @@ A container holding the compiled workflow produced from the WorkflowSpec and add
3412
3417
 
3413
3418
 
3414
3419
 
3415
- .. _ref_flyteidl.admin.WorkflowCreateRequest:
3420
+ .. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
3416
3421
 
3417
- WorkflowCreateRequest
3422
+ WorkflowAttributesDeleteResponse
3418
3423
  ------------------------------------------------------------------
3419
3424
 
3420
- Represents a request structure to create a revision of a workflow.
3421
- See :ref:`ref_flyteidl.admin.Workflow` for more details
3425
+ Purposefully empty, may be populated in the future.
3422
3426
 
3423
3427
 
3424
3428
 
3425
- .. csv-table:: WorkflowCreateRequest type fields
3426
- :header: "Field", "Type", "Label", "Description"
3427
- :widths: auto
3428
3429
 
3429
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
3430
- "spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
3431
3430
 
3432
3431
 
3433
3432
 
3434
3433
 
3434
+ .. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
3435
3435
 
3436
+ WorkflowAttributesGetRequest
3437
+ ------------------------------------------------------------------
3436
3438
 
3439
+ Request to get an individual workflow attribute override.
3440
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3437
3441
 
3438
- .. _ref_flyteidl.admin.WorkflowCreateResponse:
3439
3442
 
3440
- WorkflowCreateResponse
3441
- ------------------------------------------------------------------
3442
3443
 
3443
- Purposefully empty, may be populated in the future.
3444
+ .. csv-table:: WorkflowAttributesGetRequest type fields
3445
+ :header: "Field", "Type", "Label", "Description"
3446
+ :widths: auto
3444
3447
 
3448
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3449
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3450
+ "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3451
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
3445
3452
 
3446
3453
 
3447
3454
 
@@ -3449,22 +3456,20 @@ Purposefully empty, may be populated in the future.
3449
3456
 
3450
3457
 
3451
3458
 
3452
- .. _ref_flyteidl.admin.WorkflowList:
3459
+ .. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
3453
3460
 
3454
- WorkflowList
3461
+ WorkflowAttributesGetResponse
3455
3462
  ------------------------------------------------------------------
3456
3463
 
3457
- Represents a list of workflows returned from the admin.
3458
- See :ref:`ref_flyteidl.admin.Workflow` for more details
3464
+ Response to get an individual workflow attribute override.
3459
3465
 
3460
3466
 
3461
3467
 
3462
- .. csv-table:: WorkflowList type fields
3468
+ .. csv-table:: WorkflowAttributesGetResponse type fields
3463
3469
  :header: "Field", "Type", "Label", "Description"
3464
3470
  :widths: auto
3465
3471
 
3466
- "workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
3467
- "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."
3472
+ "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3468
3473
 
3469
3474
 
3470
3475
 
@@ -3472,21 +3477,35 @@ See :ref:`ref_flyteidl.admin.Workflow` for more details
3472
3477
 
3473
3478
 
3474
3479
 
3475
- .. _ref_flyteidl.admin.WorkflowSpec:
3480
+ .. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
3476
3481
 
3477
- WorkflowSpec
3482
+ WorkflowAttributesUpdateRequest
3478
3483
  ------------------------------------------------------------------
3479
3484
 
3480
- Represents a structure that encapsulates the specification of the workflow.
3485
+ Sets custom attributes for a project, domain and workflow combination.
3486
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3481
3487
 
3482
3488
 
3483
3489
 
3484
- .. csv-table:: WorkflowSpec type fields
3490
+ .. csv-table:: WorkflowAttributesUpdateRequest type fields
3485
3491
  :header: "Field", "Type", "Label", "Description"
3486
3492
  :widths: auto
3487
3493
 
3488
- "template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
3489
- "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."
3494
+ "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3495
+
3496
+
3497
+
3498
+
3499
+
3500
+
3501
+
3502
+ .. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
3503
+
3504
+ WorkflowAttributesUpdateResponse
3505
+ ------------------------------------------------------------------
3506
+
3507
+ Purposefully empty, may be populated in the future.
3508
+
3490
3509
 
3491
3510
 
3492
3511
 
@@ -3503,33 +3522,32 @@ Represents a structure that encapsulates the specification of the workflow.
3503
3522
 
3504
3523
 
3505
3524
 
3506
- .. _ref_flyteidl/admin/workflow_attributes.proto:
3525
+ .. _ref_flyteidl/admin/workflow.proto:
3507
3526
 
3508
- flyteidl/admin/workflow_attributes.proto
3527
+ flyteidl/admin/workflow.proto
3509
3528
  ==================================================================
3510
3529
 
3511
3530
 
3512
3531
 
3513
3532
 
3514
3533
 
3515
- .. _ref_flyteidl.admin.WorkflowAttributes:
3534
+ .. _ref_flyteidl.admin.Workflow:
3516
3535
 
3517
- WorkflowAttributes
3536
+ Workflow
3518
3537
  ------------------------------------------------------------------
3519
3538
 
3520
- Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
3521
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3539
+ Represents the workflow structure stored in the Admin
3540
+ A workflow is created by ordering tasks and associating outputs to inputs
3541
+ in order to produce a directed-acyclic execution graph.
3522
3542
 
3523
3543
 
3524
3544
 
3525
- .. csv-table:: WorkflowAttributes type fields
3545
+ .. csv-table:: Workflow type fields
3526
3546
  :header: "Field", "Type", "Label", "Description"
3527
3547
  :widths: auto
3528
3548
 
3529
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
3530
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
3531
- "workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
3532
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
3549
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
3550
+ "closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
3533
3551
 
3534
3552
 
3535
3553
 
@@ -3537,24 +3555,21 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
3537
3555
 
3538
3556
 
3539
3557
 
3540
- .. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
3558
+ .. _ref_flyteidl.admin.WorkflowClosure:
3541
3559
 
3542
- WorkflowAttributesDeleteRequest
3560
+ WorkflowClosure
3543
3561
  ------------------------------------------------------------------
3544
3562
 
3545
- Request to delete a set matchable workflow attribute override.
3546
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3563
+ A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
3547
3564
 
3548
3565
 
3549
3566
 
3550
- .. csv-table:: WorkflowAttributesDeleteRequest type fields
3567
+ .. csv-table:: WorkflowClosure type fields
3551
3568
  :header: "Field", "Type", "Label", "Description"
3552
3569
  :widths: auto
3553
3570
 
3554
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3555
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3556
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3557
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
3571
+ "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
3572
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
3558
3573
 
3559
3574
 
3560
3575
 
@@ -3562,38 +3577,36 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
3562
3577
 
3563
3578
 
3564
3579
 
3565
- .. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
3580
+ .. _ref_flyteidl.admin.WorkflowCreateRequest:
3566
3581
 
3567
- WorkflowAttributesDeleteResponse
3582
+ WorkflowCreateRequest
3568
3583
  ------------------------------------------------------------------
3569
3584
 
3570
- Purposefully empty, may be populated in the future.
3585
+ Represents a request structure to create a revision of a workflow.
3586
+ See :ref:`ref_flyteidl.admin.Workflow` for more details
3571
3587
 
3572
3588
 
3573
3589
 
3590
+ .. csv-table:: WorkflowCreateRequest type fields
3591
+ :header: "Field", "Type", "Label", "Description"
3592
+ :widths: auto
3574
3593
 
3594
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
3595
+ "spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
3575
3596
 
3576
3597
 
3577
3598
 
3578
3599
 
3579
- .. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
3580
3600
 
3581
- WorkflowAttributesGetRequest
3582
- ------------------------------------------------------------------
3583
3601
 
3584
- Request to get an individual workflow attribute override.
3585
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3586
3602
 
3603
+ .. _ref_flyteidl.admin.WorkflowCreateResponse:
3587
3604
 
3605
+ WorkflowCreateResponse
3606
+ ------------------------------------------------------------------
3588
3607
 
3589
- .. csv-table:: WorkflowAttributesGetRequest type fields
3590
- :header: "Field", "Type", "Label", "Description"
3591
- :widths: auto
3608
+ Purposefully empty, may be populated in the future.
3592
3609
 
3593
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3594
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3595
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3596
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
3597
3610
 
3598
3611
 
3599
3612
 
@@ -3601,20 +3614,22 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
3601
3614
 
3602
3615
 
3603
3616
 
3604
- .. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
3617
+ .. _ref_flyteidl.admin.WorkflowList:
3605
3618
 
3606
- WorkflowAttributesGetResponse
3619
+ WorkflowList
3607
3620
  ------------------------------------------------------------------
3608
3621
 
3609
- Response to get an individual workflow attribute override.
3622
+ Represents a list of workflows returned from the admin.
3623
+ See :ref:`ref_flyteidl.admin.Workflow` for more details
3610
3624
 
3611
3625
 
3612
3626
 
3613
- .. csv-table:: WorkflowAttributesGetResponse type fields
3627
+ .. csv-table:: WorkflowList type fields
3614
3628
  :header: "Field", "Type", "Label", "Description"
3615
3629
  :widths: auto
3616
3630
 
3617
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3631
+ "workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
3632
+ "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."
3618
3633
 
3619
3634
 
3620
3635
 
@@ -3622,35 +3637,21 @@ Response to get an individual workflow attribute override.
3622
3637
 
3623
3638
 
3624
3639
 
3625
- .. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
3640
+ .. _ref_flyteidl.admin.WorkflowSpec:
3626
3641
 
3627
- WorkflowAttributesUpdateRequest
3642
+ WorkflowSpec
3628
3643
  ------------------------------------------------------------------
3629
3644
 
3630
- Sets custom attributes for a project, domain and workflow combination.
3631
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3645
+ Represents a structure that encapsulates the specification of the workflow.
3632
3646
 
3633
3647
 
3634
3648
 
3635
- .. csv-table:: WorkflowAttributesUpdateRequest type fields
3649
+ .. csv-table:: WorkflowSpec type fields
3636
3650
  :header: "Field", "Type", "Label", "Description"
3637
3651
  :widths: auto
3638
3652
 
3639
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3640
-
3641
-
3642
-
3643
-
3644
-
3645
-
3646
-
3647
- .. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
3648
-
3649
- WorkflowAttributesUpdateResponse
3650
- ------------------------------------------------------------------
3651
-
3652
- Purposefully empty, may be populated in the future.
3653
-
3653
+ "template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
3654
+ "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."
3654
3655
 
3655
3656
 
3656
3657