@flyteorg/flyteidl 0.24.5 → 0.24.8
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 +12 -0
- package/gen/pb-js/flyteidl.js +53 -0
- package/package.json +1 -1
- package/protos/docs/admin/admin.rst +430 -329
- package/protos/docs/core/core.rst +40 -40
- package/protos/docs/datacatalog/datacatalog.rst +367 -0
- package/protos/docs/event/event.rst +369 -0
- package/protos/flyteidl/event/event.proto +6 -0
|
@@ -2058,6 +2058,10 @@ Adds defaults for customizable workflow-execution specifications and overrides.
|
|
|
2058
2058
|
:widths: auto
|
|
2059
2059
|
|
|
2060
2060
|
"max_parallelism", ":ref:`ref_int32`", "", "Can be used to control the number of parallel nodes to run within the workflow. This is useful to achieve fairness."
|
|
2061
|
+
"security_context", ":ref:`ref_flyteidl.core.SecurityContext`", "", "Indicates security context permissions for executions triggered with this matchable attribute."
|
|
2062
|
+
"raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.)."
|
|
2063
|
+
"labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Custom labels to be applied to a triggered execution resource."
|
|
2064
|
+
"annotations", ":ref:`ref_flyteidl.admin.Annotations`", "", "Custom annotations to be applied to a triggered execution resource."
|
|
2061
2065
|
|
|
2062
2066
|
|
|
2063
2067
|
|
|
@@ -2466,31 +2470,32 @@ Note: This is internal to Admin and doesn't need to be exposed to other componen
|
|
|
2466
2470
|
|
|
2467
2471
|
|
|
2468
2472
|
|
|
2469
|
-
.. _ref_flyteidl/admin/
|
|
2473
|
+
.. _ref_flyteidl/admin/project_domain_attributes.proto:
|
|
2470
2474
|
|
|
2471
|
-
flyteidl/admin/
|
|
2475
|
+
flyteidl/admin/project_domain_attributes.proto
|
|
2472
2476
|
==================================================================
|
|
2473
2477
|
|
|
2474
2478
|
|
|
2475
2479
|
|
|
2476
2480
|
|
|
2477
2481
|
|
|
2478
|
-
.. _ref_flyteidl.admin.
|
|
2482
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributes:
|
|
2479
2483
|
|
|
2480
|
-
|
|
2484
|
+
ProjectDomainAttributes
|
|
2481
2485
|
------------------------------------------------------------------
|
|
2482
2486
|
|
|
2483
|
-
|
|
2484
|
-
|
|
2487
|
+
Defines a set of custom matching attributes which defines resource defaults for a project and domain.
|
|
2488
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2485
2489
|
|
|
2486
2490
|
|
|
2487
2491
|
|
|
2488
|
-
.. csv-table::
|
|
2492
|
+
.. csv-table:: ProjectDomainAttributes type fields
|
|
2489
2493
|
:header: "Field", "Type", "Label", "Description"
|
|
2490
2494
|
:widths: auto
|
|
2491
2495
|
|
|
2492
|
-
"
|
|
2493
|
-
"
|
|
2496
|
+
"project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
|
|
2497
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
|
|
2498
|
+
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
2494
2499
|
|
|
2495
2500
|
|
|
2496
2501
|
|
|
@@ -2498,25 +2503,23 @@ e.g. "production", "development", etc.
|
|
|
2498
2503
|
|
|
2499
2504
|
|
|
2500
2505
|
|
|
2501
|
-
.. _ref_flyteidl.admin.
|
|
2506
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
|
|
2502
2507
|
|
|
2503
|
-
|
|
2508
|
+
ProjectDomainAttributesDeleteRequest
|
|
2504
2509
|
------------------------------------------------------------------
|
|
2505
2510
|
|
|
2506
|
-
|
|
2511
|
+
Request to delete a set matchable project domain attribute override.
|
|
2512
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2507
2513
|
|
|
2508
2514
|
|
|
2509
2515
|
|
|
2510
|
-
.. csv-table::
|
|
2516
|
+
.. csv-table:: ProjectDomainAttributesDeleteRequest type fields
|
|
2511
2517
|
:header: "Field", "Type", "Label", "Description"
|
|
2512
2518
|
:widths: auto
|
|
2513
2519
|
|
|
2514
|
-
"
|
|
2515
|
-
"
|
|
2516
|
-
"
|
|
2517
|
-
"description", ":ref:`ref_string`", "", ""
|
|
2518
|
-
"labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
|
|
2519
|
-
"state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
|
|
2520
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
2521
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
2522
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
|
|
2520
2523
|
|
|
2521
2524
|
|
|
2522
2525
|
|
|
@@ -2524,24 +2527,13 @@ Top-level namespace used to classify different entities like workflows and execu
|
|
|
2524
2527
|
|
|
2525
2528
|
|
|
2526
2529
|
|
|
2527
|
-
.. _ref_flyteidl.admin.
|
|
2530
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
|
|
2528
2531
|
|
|
2529
|
-
|
|
2532
|
+
ProjectDomainAttributesDeleteResponse
|
|
2530
2533
|
------------------------------------------------------------------
|
|
2531
2534
|
|
|
2532
|
-
|
|
2533
|
-
See :ref:`ref_flyteidl.admin.Project` for more details
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
|
-
.. csv-table:: ProjectListRequest type fields
|
|
2538
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2539
|
-
:widths: auto
|
|
2535
|
+
Purposefully empty, may be populated in the future.
|
|
2540
2536
|
|
|
2541
|
-
"limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
|
|
2542
|
-
"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"
|
|
2543
|
-
"filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
|
|
2544
|
-
"sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
|
|
2545
2537
|
|
|
2546
2538
|
|
|
2547
2539
|
|
|
@@ -2549,21 +2541,23 @@ See :ref:`ref_flyteidl.admin.Project` for more details
|
|
|
2549
2541
|
|
|
2550
2542
|
|
|
2551
2543
|
|
|
2552
|
-
.. _ref_flyteidl.admin.
|
|
2544
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
|
|
2553
2545
|
|
|
2554
|
-
|
|
2546
|
+
ProjectDomainAttributesGetRequest
|
|
2555
2547
|
------------------------------------------------------------------
|
|
2556
2548
|
|
|
2557
|
-
|
|
2558
|
-
|
|
2549
|
+
Request to get an individual project domain attribute override.
|
|
2550
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2559
2551
|
|
|
2560
2552
|
|
|
2561
2553
|
|
|
2562
|
-
.. csv-table::
|
|
2554
|
+
.. csv-table:: ProjectDomainAttributesGetRequest type fields
|
|
2563
2555
|
:header: "Field", "Type", "Label", "Description"
|
|
2564
2556
|
:widths: auto
|
|
2565
2557
|
|
|
2566
|
-
"project", ":ref:`
|
|
2558
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
2559
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
2560
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
|
|
2567
2561
|
|
|
2568
2562
|
|
|
2569
2563
|
|
|
@@ -2571,27 +2565,21 @@ See :ref:`ref_flyteidl.admin.Project` for more details
|
|
|
2571
2565
|
|
|
2572
2566
|
|
|
2573
2567
|
|
|
2574
|
-
.. _ref_flyteidl.admin.
|
|
2568
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
|
|
2575
2569
|
|
|
2576
|
-
|
|
2570
|
+
ProjectDomainAttributesGetResponse
|
|
2577
2571
|
------------------------------------------------------------------
|
|
2578
2572
|
|
|
2579
|
-
|
|
2580
|
-
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
|
|
2585
|
-
|
|
2586
|
-
|
|
2573
|
+
Response to get an individual project domain attribute override.
|
|
2574
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2587
2575
|
|
|
2588
|
-
.. _ref_flyteidl.admin.ProjectUpdateResponse:
|
|
2589
2576
|
|
|
2590
|
-
ProjectUpdateResponse
|
|
2591
|
-
------------------------------------------------------------------
|
|
2592
2577
|
|
|
2593
|
-
|
|
2578
|
+
.. csv-table:: ProjectDomainAttributesGetResponse type fields
|
|
2579
|
+
:header: "Field", "Type", "Label", "Description"
|
|
2580
|
+
:widths: auto
|
|
2594
2581
|
|
|
2582
|
+
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
|
|
2595
2583
|
|
|
2596
2584
|
|
|
2597
2585
|
|
|
@@ -2599,45 +2587,41 @@ Purposefully empty, may be updated in the future.
|
|
|
2599
2587
|
|
|
2600
2588
|
|
|
2601
2589
|
|
|
2602
|
-
.. _ref_flyteidl.admin.
|
|
2590
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
|
|
2603
2591
|
|
|
2604
|
-
|
|
2592
|
+
ProjectDomainAttributesUpdateRequest
|
|
2605
2593
|
------------------------------------------------------------------
|
|
2606
2594
|
|
|
2607
|
-
|
|
2608
|
-
|
|
2595
|
+
Sets custom attributes for a project-domain combination.
|
|
2596
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2609
2597
|
|
|
2610
2598
|
|
|
2611
2599
|
|
|
2612
|
-
.. csv-table::
|
|
2600
|
+
.. csv-table:: ProjectDomainAttributesUpdateRequest type fields
|
|
2613
2601
|
:header: "Field", "Type", "Label", "Description"
|
|
2614
2602
|
:widths: auto
|
|
2615
2603
|
|
|
2616
|
-
"
|
|
2617
|
-
"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."
|
|
2618
|
-
|
|
2604
|
+
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
|
|
2619
2605
|
|
|
2620
2606
|
|
|
2621
2607
|
|
|
2622
2608
|
|
|
2623
|
-
<!-- end messages -->
|
|
2624
2609
|
|
|
2625
2610
|
|
|
2626
2611
|
|
|
2627
|
-
.. _ref_flyteidl.admin.
|
|
2612
|
+
.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
|
|
2628
2613
|
|
|
2629
|
-
|
|
2614
|
+
ProjectDomainAttributesUpdateResponse
|
|
2630
2615
|
------------------------------------------------------------------
|
|
2631
2616
|
|
|
2632
|
-
|
|
2617
|
+
Purposefully empty, may be populated in the future.
|
|
2618
|
+
|
|
2619
|
+
|
|
2633
2620
|
|
|
2634
|
-
.. csv-table:: Enum Project.ProjectState values
|
|
2635
|
-
:header: "Name", "Number", "Description"
|
|
2636
|
-
:widths: auto
|
|
2637
2621
|
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
|
|
2622
|
+
|
|
2623
|
+
|
|
2624
|
+
<!-- end messages -->
|
|
2641
2625
|
|
|
2642
2626
|
<!-- end enums -->
|
|
2643
2627
|
|
|
@@ -2648,32 +2632,31 @@ The state of the project is used to control its visibility in the UI and validit
|
|
|
2648
2632
|
|
|
2649
2633
|
|
|
2650
2634
|
|
|
2651
|
-
.. _ref_flyteidl/admin/
|
|
2635
|
+
.. _ref_flyteidl/admin/project.proto:
|
|
2652
2636
|
|
|
2653
|
-
flyteidl/admin/
|
|
2637
|
+
flyteidl/admin/project.proto
|
|
2654
2638
|
==================================================================
|
|
2655
2639
|
|
|
2656
2640
|
|
|
2657
2641
|
|
|
2658
2642
|
|
|
2659
2643
|
|
|
2660
|
-
.. _ref_flyteidl.admin.
|
|
2644
|
+
.. _ref_flyteidl.admin.Domain:
|
|
2661
2645
|
|
|
2662
|
-
|
|
2646
|
+
Domain
|
|
2663
2647
|
------------------------------------------------------------------
|
|
2664
2648
|
|
|
2665
|
-
|
|
2666
|
-
|
|
2649
|
+
Namespace within a project commonly used to differentiate between different service instances.
|
|
2650
|
+
e.g. "production", "development", etc.
|
|
2667
2651
|
|
|
2668
2652
|
|
|
2669
2653
|
|
|
2670
|
-
.. csv-table::
|
|
2654
|
+
.. csv-table:: Domain type fields
|
|
2671
2655
|
:header: "Field", "Type", "Label", "Description"
|
|
2672
2656
|
:widths: auto
|
|
2673
2657
|
|
|
2674
|
-
"
|
|
2675
|
-
"
|
|
2676
|
-
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
2658
|
+
"id", ":ref:`ref_string`", "", "Globally unique domain name."
|
|
2659
|
+
"name", ":ref:`ref_string`", "", "Display name."
|
|
2677
2660
|
|
|
2678
2661
|
|
|
2679
2662
|
|
|
@@ -2681,23 +2664,25 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
2681
2664
|
|
|
2682
2665
|
|
|
2683
2666
|
|
|
2684
|
-
.. _ref_flyteidl.admin.
|
|
2667
|
+
.. _ref_flyteidl.admin.Project:
|
|
2685
2668
|
|
|
2686
|
-
|
|
2669
|
+
Project
|
|
2687
2670
|
------------------------------------------------------------------
|
|
2688
2671
|
|
|
2689
|
-
|
|
2690
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2672
|
+
Top-level namespace used to classify different entities like workflows and executions.
|
|
2691
2673
|
|
|
2692
2674
|
|
|
2693
2675
|
|
|
2694
|
-
.. csv-table::
|
|
2676
|
+
.. csv-table:: Project type fields
|
|
2695
2677
|
:header: "Field", "Type", "Label", "Description"
|
|
2696
2678
|
:widths: auto
|
|
2697
2679
|
|
|
2698
|
-
"
|
|
2699
|
-
"
|
|
2700
|
-
"
|
|
2680
|
+
"id", ":ref:`ref_string`", "", "Globally unique project name."
|
|
2681
|
+
"name", ":ref:`ref_string`", "", "Display name."
|
|
2682
|
+
"domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
|
|
2683
|
+
"description", ":ref:`ref_string`", "", ""
|
|
2684
|
+
"labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
|
|
2685
|
+
"state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
|
|
2701
2686
|
|
|
2702
2687
|
|
|
2703
2688
|
|
|
@@ -2705,37 +2690,46 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
2705
2690
|
|
|
2706
2691
|
|
|
2707
2692
|
|
|
2708
|
-
.. _ref_flyteidl.admin.
|
|
2693
|
+
.. _ref_flyteidl.admin.ProjectListRequest:
|
|
2709
2694
|
|
|
2710
|
-
|
|
2695
|
+
ProjectListRequest
|
|
2711
2696
|
------------------------------------------------------------------
|
|
2712
2697
|
|
|
2713
|
-
|
|
2698
|
+
Request to retrieve a list of projects matching specified filters.
|
|
2699
|
+
See :ref:`ref_flyteidl.admin.Project` for more details
|
|
2714
2700
|
|
|
2715
2701
|
|
|
2716
2702
|
|
|
2703
|
+
.. csv-table:: ProjectListRequest type fields
|
|
2704
|
+
:header: "Field", "Type", "Label", "Description"
|
|
2705
|
+
:widths: auto
|
|
2717
2706
|
|
|
2707
|
+
"limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
|
|
2708
|
+
"token", ":ref:`ref_string`", "", "In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional"
|
|
2709
|
+
"filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
|
|
2710
|
+
"sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
|
|
2718
2711
|
|
|
2719
2712
|
|
|
2720
2713
|
|
|
2721
2714
|
|
|
2722
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
|
|
2723
2715
|
|
|
2724
|
-
|
|
2716
|
+
|
|
2717
|
+
|
|
2718
|
+
.. _ref_flyteidl.admin.ProjectRegisterRequest:
|
|
2719
|
+
|
|
2720
|
+
ProjectRegisterRequest
|
|
2725
2721
|
------------------------------------------------------------------
|
|
2726
2722
|
|
|
2727
|
-
|
|
2728
|
-
|
|
2723
|
+
Adds a new user-project within the Flyte deployment.
|
|
2724
|
+
See :ref:`ref_flyteidl.admin.Project` for more details
|
|
2729
2725
|
|
|
2730
2726
|
|
|
2731
2727
|
|
|
2732
|
-
.. csv-table::
|
|
2728
|
+
.. csv-table:: ProjectRegisterRequest type fields
|
|
2733
2729
|
:header: "Field", "Type", "Label", "Description"
|
|
2734
2730
|
:widths: auto
|
|
2735
2731
|
|
|
2736
|
-
"project", ":ref:`
|
|
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"
|
|
2732
|
+
"project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
|
|
2739
2733
|
|
|
2740
2734
|
|
|
2741
2735
|
|
|
@@ -2743,63 +2737,73 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
2743
2737
|
|
|
2744
2738
|
|
|
2745
2739
|
|
|
2746
|
-
.. _ref_flyteidl.admin.
|
|
2740
|
+
.. _ref_flyteidl.admin.ProjectRegisterResponse:
|
|
2747
2741
|
|
|
2748
|
-
|
|
2742
|
+
ProjectRegisterResponse
|
|
2749
2743
|
------------------------------------------------------------------
|
|
2750
2744
|
|
|
2751
|
-
|
|
2752
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2745
|
+
Purposefully empty, may be updated in the future.
|
|
2753
2746
|
|
|
2754
2747
|
|
|
2755
2748
|
|
|
2756
|
-
.. csv-table:: ProjectDomainAttributesGetResponse type fields
|
|
2757
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2758
|
-
:widths: auto
|
|
2759
2749
|
|
|
2760
|
-
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
|
|
2761
2750
|
|
|
2762
2751
|
|
|
2763
2752
|
|
|
2764
2753
|
|
|
2754
|
+
.. _ref_flyteidl.admin.ProjectUpdateResponse:
|
|
2765
2755
|
|
|
2756
|
+
ProjectUpdateResponse
|
|
2757
|
+
------------------------------------------------------------------
|
|
2766
2758
|
|
|
2759
|
+
Purposefully empty, may be updated in the future.
|
|
2767
2760
|
|
|
2768
|
-
.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
|
|
2769
2761
|
|
|
2770
|
-
ProjectDomainAttributesUpdateRequest
|
|
2771
|
-
------------------------------------------------------------------
|
|
2772
2762
|
|
|
2773
|
-
Sets custom attributes for a project-domain combination.
|
|
2774
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
2775
2763
|
|
|
2776
2764
|
|
|
2777
2765
|
|
|
2778
|
-
.. csv-table:: ProjectDomainAttributesUpdateRequest type fields
|
|
2779
|
-
:header: "Field", "Type", "Label", "Description"
|
|
2780
|
-
:widths: auto
|
|
2781
2766
|
|
|
2782
|
-
"attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
|
|
2783
2767
|
|
|
2768
|
+
.. _ref_flyteidl.admin.Projects:
|
|
2784
2769
|
|
|
2770
|
+
Projects
|
|
2771
|
+
------------------------------------------------------------------
|
|
2785
2772
|
|
|
2773
|
+
Represents a list of projects.
|
|
2774
|
+
See :ref:`ref_flyteidl.admin.Project` for more details
|
|
2786
2775
|
|
|
2787
2776
|
|
|
2788
2777
|
|
|
2778
|
+
.. csv-table:: Projects type fields
|
|
2779
|
+
:header: "Field", "Type", "Label", "Description"
|
|
2780
|
+
:widths: auto
|
|
2789
2781
|
|
|
2790
|
-
|
|
2782
|
+
"projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
|
|
2783
|
+
"token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
|
|
2791
2784
|
|
|
2792
|
-
ProjectDomainAttributesUpdateResponse
|
|
2793
|
-
------------------------------------------------------------------
|
|
2794
2785
|
|
|
2795
|
-
Purposefully empty, may be populated in the future.
|
|
2796
2786
|
|
|
2797
2787
|
|
|
2798
2788
|
|
|
2789
|
+
<!-- end messages -->
|
|
2799
2790
|
|
|
2800
2791
|
|
|
2801
2792
|
|
|
2802
|
-
|
|
2793
|
+
.. _ref_flyteidl.admin.Project.ProjectState:
|
|
2794
|
+
|
|
2795
|
+
Project.ProjectState
|
|
2796
|
+
------------------------------------------------------------------
|
|
2797
|
+
|
|
2798
|
+
The state of the project is used to control its visibility in the UI and validity.
|
|
2799
|
+
|
|
2800
|
+
.. csv-table:: Enum Project.ProjectState values
|
|
2801
|
+
:header: "Name", "Number", "Description"
|
|
2802
|
+
:widths: auto
|
|
2803
|
+
|
|
2804
|
+
"ACTIVE", "0", "By default, all projects are considered active."
|
|
2805
|
+
"ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
|
|
2806
|
+
"SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
|
|
2803
2807
|
|
|
2804
2808
|
<!-- end enums -->
|
|
2805
2809
|
|
|
@@ -2913,32 +2917,34 @@ Represents a frequency at which to run a schedule.
|
|
|
2913
2917
|
|
|
2914
2918
|
|
|
2915
2919
|
|
|
2916
|
-
.. _ref_flyteidl/admin/
|
|
2920
|
+
.. _ref_flyteidl/admin/task_execution.proto:
|
|
2917
2921
|
|
|
2918
|
-
flyteidl/admin/
|
|
2922
|
+
flyteidl/admin/task_execution.proto
|
|
2919
2923
|
==================================================================
|
|
2920
2924
|
|
|
2921
2925
|
|
|
2922
2926
|
|
|
2923
2927
|
|
|
2924
2928
|
|
|
2925
|
-
.. _ref_flyteidl.admin.
|
|
2929
|
+
.. _ref_flyteidl.admin.TaskExecution:
|
|
2926
2930
|
|
|
2927
|
-
|
|
2931
|
+
TaskExecution
|
|
2928
2932
|
------------------------------------------------------------------
|
|
2929
2933
|
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2934
|
+
Encapsulates all details for a single task execution entity.
|
|
2935
|
+
A task execution represents an instantiated task, including all inputs and additional
|
|
2936
|
+
metadata as well as computed results included state, outputs, and duration-based attributes.
|
|
2933
2937
|
|
|
2934
2938
|
|
|
2935
2939
|
|
|
2936
|
-
.. csv-table::
|
|
2940
|
+
.. csv-table:: TaskExecution type fields
|
|
2937
2941
|
:header: "Field", "Type", "Label", "Description"
|
|
2938
2942
|
:widths: auto
|
|
2939
2943
|
|
|
2940
|
-
"id", ":ref:`ref_flyteidl.core.
|
|
2941
|
-
"
|
|
2944
|
+
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
|
|
2945
|
+
"input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
|
|
2946
|
+
"closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
|
|
2947
|
+
"is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
|
|
2942
2948
|
|
|
2943
2949
|
|
|
2944
2950
|
|
|
@@ -2946,22 +2952,32 @@ Tasks can come in many varieties tuned for specialized behavior.
|
|
|
2946
2952
|
|
|
2947
2953
|
|
|
2948
2954
|
|
|
2949
|
-
.. _ref_flyteidl.admin.
|
|
2955
|
+
.. _ref_flyteidl.admin.TaskExecutionClosure:
|
|
2950
2956
|
|
|
2951
|
-
|
|
2957
|
+
TaskExecutionClosure
|
|
2952
2958
|
------------------------------------------------------------------
|
|
2953
2959
|
|
|
2954
|
-
|
|
2955
|
-
and task metadata.
|
|
2960
|
+
Container for task execution details and results.
|
|
2956
2961
|
|
|
2957
2962
|
|
|
2958
2963
|
|
|
2959
|
-
.. csv-table::
|
|
2964
|
+
.. csv-table:: TaskExecutionClosure type fields
|
|
2960
2965
|
:header: "Field", "Type", "Label", "Description"
|
|
2961
2966
|
:widths: auto
|
|
2962
2967
|
|
|
2963
|
-
"
|
|
2964
|
-
"
|
|
2968
|
+
"output_uri", ":ref:`ref_string`", "", "**Deprecated.** Path to remote data store where output blob is stored if the execution succeeded (and produced outputs). DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
|
|
2969
|
+
"error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
|
|
2970
|
+
"output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
|
|
2971
|
+
"phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
|
|
2972
|
+
"logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
|
|
2973
|
+
"started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
|
|
2974
|
+
"duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
|
|
2975
|
+
"created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
|
|
2976
|
+
"updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
|
|
2977
|
+
"custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
|
|
2978
|
+
"reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
|
|
2979
|
+
"task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
|
|
2980
|
+
"metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
|
|
2965
2981
|
|
|
2966
2982
|
|
|
2967
2983
|
|
|
@@ -2969,22 +2985,21 @@ and task metadata.
|
|
|
2969
2985
|
|
|
2970
2986
|
|
|
2971
2987
|
|
|
2972
|
-
.. _ref_flyteidl.admin.
|
|
2988
|
+
.. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
|
|
2973
2989
|
|
|
2974
|
-
|
|
2990
|
+
TaskExecutionGetDataRequest
|
|
2975
2991
|
------------------------------------------------------------------
|
|
2976
2992
|
|
|
2977
|
-
|
|
2978
|
-
|
|
2993
|
+
Request structure to fetch inputs and output for a task execution.
|
|
2994
|
+
By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
|
|
2979
2995
|
|
|
2980
2996
|
|
|
2981
2997
|
|
|
2982
|
-
.. csv-table::
|
|
2998
|
+
.. csv-table:: TaskExecutionGetDataRequest type fields
|
|
2983
2999
|
:header: "Field", "Type", "Label", "Description"
|
|
2984
3000
|
:widths: auto
|
|
2985
3001
|
|
|
2986
|
-
"id", ":ref:`ref_flyteidl.core.
|
|
2987
|
-
"spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
|
|
3002
|
+
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
|
|
2988
3003
|
|
|
2989
3004
|
|
|
2990
3005
|
|
|
@@ -2992,15 +3007,23 @@ See :ref:`ref_flyteidl.admin.Task` for more details
|
|
|
2992
3007
|
|
|
2993
3008
|
|
|
2994
3009
|
|
|
2995
|
-
.. _ref_flyteidl.admin.
|
|
3010
|
+
.. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
|
|
2996
3011
|
|
|
2997
|
-
|
|
3012
|
+
TaskExecutionGetDataResponse
|
|
2998
3013
|
------------------------------------------------------------------
|
|
2999
3014
|
|
|
3000
|
-
|
|
3015
|
+
Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
|
|
3016
|
+
|
|
3001
3017
|
|
|
3002
|
-
Purposefully empty, may be populated in the future.
|
|
3003
3018
|
|
|
3019
|
+
.. csv-table:: TaskExecutionGetDataResponse type fields
|
|
3020
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3021
|
+
:widths: auto
|
|
3022
|
+
|
|
3023
|
+
"inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
|
|
3024
|
+
"outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
|
|
3025
|
+
"full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
|
|
3026
|
+
"full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
|
|
3004
3027
|
|
|
3005
3028
|
|
|
3006
3029
|
|
|
@@ -3008,22 +3031,21 @@ Purposefully empty, may be populated in the future.
|
|
|
3008
3031
|
|
|
3009
3032
|
|
|
3010
3033
|
|
|
3011
|
-
.. _ref_flyteidl.admin.
|
|
3034
|
+
.. _ref_flyteidl.admin.TaskExecutionGetRequest:
|
|
3012
3035
|
|
|
3013
|
-
|
|
3036
|
+
TaskExecutionGetRequest
|
|
3014
3037
|
------------------------------------------------------------------
|
|
3015
3038
|
|
|
3016
|
-
|
|
3017
|
-
See :ref:`ref_flyteidl.admin.
|
|
3039
|
+
A message used to fetch a single task execution entity.
|
|
3040
|
+
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3018
3041
|
|
|
3019
3042
|
|
|
3020
3043
|
|
|
3021
|
-
.. csv-table::
|
|
3044
|
+
.. csv-table:: TaskExecutionGetRequest type fields
|
|
3022
3045
|
:header: "Field", "Type", "Label", "Description"
|
|
3023
3046
|
:widths: auto
|
|
3024
3047
|
|
|
3025
|
-
"
|
|
3026
|
-
"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."
|
|
3048
|
+
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
|
|
3027
3049
|
|
|
3028
3050
|
|
|
3029
3051
|
|
|
@@ -3031,97 +3053,90 @@ See :ref:`ref_flyteidl.admin.Task` for more details
|
|
|
3031
3053
|
|
|
3032
3054
|
|
|
3033
3055
|
|
|
3034
|
-
.. _ref_flyteidl.admin.
|
|
3056
|
+
.. _ref_flyteidl.admin.TaskExecutionList:
|
|
3035
3057
|
|
|
3036
|
-
|
|
3058
|
+
TaskExecutionList
|
|
3037
3059
|
------------------------------------------------------------------
|
|
3038
3060
|
|
|
3039
|
-
|
|
3061
|
+
Response structure for a query to list of task execution entities.
|
|
3062
|
+
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3040
3063
|
|
|
3041
3064
|
|
|
3042
3065
|
|
|
3043
|
-
.. csv-table::
|
|
3066
|
+
.. csv-table:: TaskExecutionList type fields
|
|
3044
3067
|
:header: "Field", "Type", "Label", "Description"
|
|
3045
3068
|
:widths: auto
|
|
3046
3069
|
|
|
3047
|
-
"
|
|
3070
|
+
"task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
|
|
3071
|
+
"token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
|
|
3048
3072
|
|
|
3049
3073
|
|
|
3050
3074
|
|
|
3051
3075
|
|
|
3052
3076
|
|
|
3053
|
-
<!-- end messages -->
|
|
3054
3077
|
|
|
3055
|
-
<!-- end enums -->
|
|
3056
3078
|
|
|
3057
|
-
|
|
3079
|
+
.. _ref_flyteidl.admin.TaskExecutionListRequest:
|
|
3058
3080
|
|
|
3059
|
-
|
|
3081
|
+
TaskExecutionListRequest
|
|
3082
|
+
------------------------------------------------------------------
|
|
3060
3083
|
|
|
3084
|
+
Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
|
|
3085
|
+
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3061
3086
|
|
|
3062
3087
|
|
|
3063
3088
|
|
|
3064
|
-
..
|
|
3089
|
+
.. csv-table:: TaskExecutionListRequest type fields
|
|
3090
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3091
|
+
:widths: auto
|
|
3065
3092
|
|
|
3066
|
-
|
|
3067
|
-
|
|
3093
|
+
"node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
|
|
3094
|
+
"limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
|
|
3095
|
+
"token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional"
|
|
3096
|
+
"filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
|
|
3097
|
+
"sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
|
|
3068
3098
|
|
|
3069
3099
|
|
|
3070
3100
|
|
|
3071
3101
|
|
|
3072
3102
|
|
|
3073
|
-
|
|
3103
|
+
<!-- end messages -->
|
|
3074
3104
|
|
|
3075
|
-
|
|
3076
|
-
------------------------------------------------------------------
|
|
3105
|
+
<!-- end enums -->
|
|
3077
3106
|
|
|
3078
|
-
|
|
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.
|
|
3107
|
+
<!-- end HasExtensions -->
|
|
3081
3108
|
|
|
3109
|
+
<!-- end services -->
|
|
3082
3110
|
|
|
3083
3111
|
|
|
3084
|
-
.. csv-table:: TaskExecution type fields
|
|
3085
|
-
:header: "Field", "Type", "Label", "Description"
|
|
3086
|
-
:widths: auto
|
|
3087
3112
|
|
|
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."
|
|
3092
3113
|
|
|
3114
|
+
.. _ref_flyteidl/admin/task.proto:
|
|
3093
3115
|
|
|
3116
|
+
flyteidl/admin/task.proto
|
|
3117
|
+
==================================================================
|
|
3094
3118
|
|
|
3095
3119
|
|
|
3096
3120
|
|
|
3097
3121
|
|
|
3098
3122
|
|
|
3099
|
-
.. _ref_flyteidl.admin.
|
|
3123
|
+
.. _ref_flyteidl.admin.Task:
|
|
3100
3124
|
|
|
3101
|
-
|
|
3125
|
+
Task
|
|
3102
3126
|
------------------------------------------------------------------
|
|
3103
3127
|
|
|
3104
|
-
|
|
3128
|
+
Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
|
|
3129
|
+
arranged to process workflow inputs and produce a deterministic set of outputs.
|
|
3130
|
+
Tasks can come in many varieties tuned for specialized behavior.
|
|
3105
3131
|
|
|
3106
3132
|
|
|
3107
3133
|
|
|
3108
|
-
.. csv-table::
|
|
3134
|
+
.. csv-table:: Task type fields
|
|
3109
3135
|
:header: "Field", "Type", "Label", "Description"
|
|
3110
3136
|
:widths: auto
|
|
3111
3137
|
|
|
3112
|
-
"
|
|
3113
|
-
"
|
|
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."
|
|
3138
|
+
"id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
|
|
3139
|
+
"closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
|
|
3125
3140
|
|
|
3126
3141
|
|
|
3127
3142
|
|
|
@@ -3129,21 +3144,22 @@ Container for task execution details and results.
|
|
|
3129
3144
|
|
|
3130
3145
|
|
|
3131
3146
|
|
|
3132
|
-
.. _ref_flyteidl.admin.
|
|
3147
|
+
.. _ref_flyteidl.admin.TaskClosure:
|
|
3133
3148
|
|
|
3134
|
-
|
|
3149
|
+
TaskClosure
|
|
3135
3150
|
------------------------------------------------------------------
|
|
3136
3151
|
|
|
3137
|
-
|
|
3138
|
-
|
|
3152
|
+
Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
|
|
3153
|
+
and task metadata.
|
|
3139
3154
|
|
|
3140
3155
|
|
|
3141
3156
|
|
|
3142
|
-
.. csv-table::
|
|
3157
|
+
.. csv-table:: TaskClosure type fields
|
|
3143
3158
|
:header: "Field", "Type", "Label", "Description"
|
|
3144
3159
|
:widths: auto
|
|
3145
3160
|
|
|
3146
|
-
"
|
|
3161
|
+
"compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
|
|
3162
|
+
"created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
|
|
3147
3163
|
|
|
3148
3164
|
|
|
3149
3165
|
|
|
@@ -3151,23 +3167,22 @@ By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExec
|
|
|
3151
3167
|
|
|
3152
3168
|
|
|
3153
3169
|
|
|
3154
|
-
.. _ref_flyteidl.admin.
|
|
3170
|
+
.. _ref_flyteidl.admin.TaskCreateRequest:
|
|
3155
3171
|
|
|
3156
|
-
|
|
3172
|
+
TaskCreateRequest
|
|
3157
3173
|
------------------------------------------------------------------
|
|
3158
3174
|
|
|
3159
|
-
|
|
3175
|
+
Represents a request structure to create a revision of a task.
|
|
3176
|
+
See :ref:`ref_flyteidl.admin.Task` for more details
|
|
3160
3177
|
|
|
3161
3178
|
|
|
3162
3179
|
|
|
3163
|
-
.. csv-table::
|
|
3180
|
+
.. csv-table:: TaskCreateRequest type fields
|
|
3164
3181
|
:header: "Field", "Type", "Label", "Description"
|
|
3165
3182
|
:widths: auto
|
|
3166
3183
|
|
|
3167
|
-
"
|
|
3168
|
-
"
|
|
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."
|
|
3184
|
+
"id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
|
|
3185
|
+
"spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
|
|
3171
3186
|
|
|
3172
3187
|
|
|
3173
3188
|
|
|
@@ -3175,21 +3190,15 @@ Response structure for TaskExecutionGetDataRequest which contains inputs and out
|
|
|
3175
3190
|
|
|
3176
3191
|
|
|
3177
3192
|
|
|
3178
|
-
.. _ref_flyteidl.admin.
|
|
3193
|
+
.. _ref_flyteidl.admin.TaskCreateResponse:
|
|
3179
3194
|
|
|
3180
|
-
|
|
3195
|
+
TaskCreateResponse
|
|
3181
3196
|
------------------------------------------------------------------
|
|
3182
3197
|
|
|
3183
|
-
|
|
3184
|
-
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3185
|
-
|
|
3186
|
-
|
|
3198
|
+
Represents a response structure if task creation succeeds.
|
|
3187
3199
|
|
|
3188
|
-
|
|
3189
|
-
:header: "Field", "Type", "Label", "Description"
|
|
3190
|
-
:widths: auto
|
|
3200
|
+
Purposefully empty, may be populated in the future.
|
|
3191
3201
|
|
|
3192
|
-
"id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
|
|
3193
3202
|
|
|
3194
3203
|
|
|
3195
3204
|
|
|
@@ -3197,21 +3206,21 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
|
3197
3206
|
|
|
3198
3207
|
|
|
3199
3208
|
|
|
3200
|
-
.. _ref_flyteidl.admin.
|
|
3209
|
+
.. _ref_flyteidl.admin.TaskList:
|
|
3201
3210
|
|
|
3202
|
-
|
|
3211
|
+
TaskList
|
|
3203
3212
|
------------------------------------------------------------------
|
|
3204
3213
|
|
|
3205
|
-
|
|
3206
|
-
See :ref:`ref_flyteidl.admin.
|
|
3214
|
+
Represents a list of tasks returned from the admin.
|
|
3215
|
+
See :ref:`ref_flyteidl.admin.Task` for more details
|
|
3207
3216
|
|
|
3208
3217
|
|
|
3209
3218
|
|
|
3210
|
-
.. csv-table::
|
|
3219
|
+
.. csv-table:: TaskList type fields
|
|
3211
3220
|
:header: "Field", "Type", "Label", "Description"
|
|
3212
3221
|
:widths: auto
|
|
3213
3222
|
|
|
3214
|
-
"
|
|
3223
|
+
"tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
|
|
3215
3224
|
"token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
|
|
3216
3225
|
|
|
3217
3226
|
|
|
@@ -3220,25 +3229,20 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
|
3220
3229
|
|
|
3221
3230
|
|
|
3222
3231
|
|
|
3223
|
-
.. _ref_flyteidl.admin.
|
|
3232
|
+
.. _ref_flyteidl.admin.TaskSpec:
|
|
3224
3233
|
|
|
3225
|
-
|
|
3234
|
+
TaskSpec
|
|
3226
3235
|
------------------------------------------------------------------
|
|
3227
3236
|
|
|
3228
|
-
Represents a
|
|
3229
|
-
See :ref:`ref_flyteidl.admin.TaskExecution` for more details
|
|
3237
|
+
Represents a structure that encapsulates the user-configured specification of the task.
|
|
3230
3238
|
|
|
3231
3239
|
|
|
3232
3240
|
|
|
3233
|
-
.. csv-table::
|
|
3241
|
+
.. csv-table:: TaskSpec type fields
|
|
3234
3242
|
:header: "Field", "Type", "Label", "Description"
|
|
3235
3243
|
:widths: auto
|
|
3236
3244
|
|
|
3237
|
-
"
|
|
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"
|
|
3245
|
+
"template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
|
|
3242
3246
|
|
|
3243
3247
|
|
|
3244
3248
|
|
|
@@ -3331,32 +3335,33 @@ Provides Version information for a component
|
|
|
3331
3335
|
|
|
3332
3336
|
|
|
3333
3337
|
|
|
3334
|
-
.. _ref_flyteidl/admin/
|
|
3338
|
+
.. _ref_flyteidl/admin/workflow_attributes.proto:
|
|
3335
3339
|
|
|
3336
|
-
flyteidl/admin/
|
|
3340
|
+
flyteidl/admin/workflow_attributes.proto
|
|
3337
3341
|
==================================================================
|
|
3338
3342
|
|
|
3339
3343
|
|
|
3340
3344
|
|
|
3341
3345
|
|
|
3342
3346
|
|
|
3343
|
-
.. _ref_flyteidl.admin.
|
|
3347
|
+
.. _ref_flyteidl.admin.WorkflowAttributes:
|
|
3344
3348
|
|
|
3345
|
-
|
|
3349
|
+
WorkflowAttributes
|
|
3346
3350
|
------------------------------------------------------------------
|
|
3347
3351
|
|
|
3348
|
-
|
|
3349
|
-
|
|
3350
|
-
in order to produce a directed-acyclic execution graph.
|
|
3352
|
+
Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
|
|
3353
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3351
3354
|
|
|
3352
3355
|
|
|
3353
3356
|
|
|
3354
|
-
.. csv-table::
|
|
3357
|
+
.. csv-table:: WorkflowAttributes type fields
|
|
3355
3358
|
:header: "Field", "Type", "Label", "Description"
|
|
3356
3359
|
:widths: auto
|
|
3357
3360
|
|
|
3358
|
-
"
|
|
3359
|
-
"
|
|
3361
|
+
"project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
|
|
3362
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
|
|
3363
|
+
"workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
|
|
3364
|
+
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
3360
3365
|
|
|
3361
3366
|
|
|
3362
3367
|
|
|
@@ -3364,21 +3369,24 @@ in order to produce a directed-acyclic execution graph.
|
|
|
3364
3369
|
|
|
3365
3370
|
|
|
3366
3371
|
|
|
3367
|
-
.. _ref_flyteidl.admin.
|
|
3372
|
+
.. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
|
|
3368
3373
|
|
|
3369
|
-
|
|
3374
|
+
WorkflowAttributesDeleteRequest
|
|
3370
3375
|
------------------------------------------------------------------
|
|
3371
3376
|
|
|
3372
|
-
|
|
3377
|
+
Request to delete a set matchable workflow attribute override.
|
|
3378
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3373
3379
|
|
|
3374
3380
|
|
|
3375
3381
|
|
|
3376
|
-
.. csv-table::
|
|
3382
|
+
.. csv-table:: WorkflowAttributesDeleteRequest type fields
|
|
3377
3383
|
:header: "Field", "Type", "Label", "Description"
|
|
3378
3384
|
:widths: auto
|
|
3379
3385
|
|
|
3380
|
-
"
|
|
3381
|
-
"
|
|
3386
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
3387
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
3388
|
+
"workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
|
|
3389
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
|
|
3382
3390
|
|
|
3383
3391
|
|
|
3384
3392
|
|
|
@@ -3386,36 +3394,38 @@ A container holding the compiled workflow produced from the WorkflowSpec and add
|
|
|
3386
3394
|
|
|
3387
3395
|
|
|
3388
3396
|
|
|
3389
|
-
.. _ref_flyteidl.admin.
|
|
3397
|
+
.. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
|
|
3390
3398
|
|
|
3391
|
-
|
|
3399
|
+
WorkflowAttributesDeleteResponse
|
|
3392
3400
|
------------------------------------------------------------------
|
|
3393
3401
|
|
|
3394
|
-
|
|
3395
|
-
See :ref:`ref_flyteidl.admin.Workflow` for more details
|
|
3402
|
+
Purposefully empty, may be populated in the future.
|
|
3396
3403
|
|
|
3397
3404
|
|
|
3398
3405
|
|
|
3399
|
-
.. csv-table:: WorkflowCreateRequest type fields
|
|
3400
|
-
:header: "Field", "Type", "Label", "Description"
|
|
3401
|
-
:widths: auto
|
|
3402
3406
|
|
|
3403
|
-
"id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
|
|
3404
|
-
"spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
|
|
3405
3407
|
|
|
3406
3408
|
|
|
3407
3409
|
|
|
3408
3410
|
|
|
3411
|
+
.. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
|
|
3409
3412
|
|
|
3413
|
+
WorkflowAttributesGetRequest
|
|
3414
|
+
------------------------------------------------------------------
|
|
3410
3415
|
|
|
3416
|
+
Request to get an individual workflow attribute override.
|
|
3417
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3411
3418
|
|
|
3412
|
-
.. _ref_flyteidl.admin.WorkflowCreateResponse:
|
|
3413
3419
|
|
|
3414
|
-
WorkflowCreateResponse
|
|
3415
|
-
------------------------------------------------------------------
|
|
3416
3420
|
|
|
3417
|
-
|
|
3421
|
+
.. csv-table:: WorkflowAttributesGetRequest type fields
|
|
3422
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3423
|
+
:widths: auto
|
|
3418
3424
|
|
|
3425
|
+
"project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
|
|
3426
|
+
"domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
|
|
3427
|
+
"workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
|
|
3428
|
+
"resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
|
|
3419
3429
|
|
|
3420
3430
|
|
|
3421
3431
|
|
|
@@ -3423,22 +3433,20 @@ Purposefully empty, may be populated in the future.
|
|
|
3423
3433
|
|
|
3424
3434
|
|
|
3425
3435
|
|
|
3426
|
-
.. _ref_flyteidl.admin.
|
|
3436
|
+
.. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
|
|
3427
3437
|
|
|
3428
|
-
|
|
3438
|
+
WorkflowAttributesGetResponse
|
|
3429
3439
|
------------------------------------------------------------------
|
|
3430
3440
|
|
|
3431
|
-
|
|
3432
|
-
See :ref:`ref_flyteidl.admin.Workflow` for more details
|
|
3441
|
+
Response to get an individual workflow attribute override.
|
|
3433
3442
|
|
|
3434
3443
|
|
|
3435
3444
|
|
|
3436
|
-
.. csv-table::
|
|
3445
|
+
.. csv-table:: WorkflowAttributesGetResponse type fields
|
|
3437
3446
|
:header: "Field", "Type", "Label", "Description"
|
|
3438
3447
|
:widths: auto
|
|
3439
3448
|
|
|
3440
|
-
"
|
|
3441
|
-
"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."
|
|
3449
|
+
"attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
|
|
3442
3450
|
|
|
3443
3451
|
|
|
3444
3452
|
|
|
@@ -3446,21 +3454,35 @@ See :ref:`ref_flyteidl.admin.Workflow` for more details
|
|
|
3446
3454
|
|
|
3447
3455
|
|
|
3448
3456
|
|
|
3449
|
-
.. _ref_flyteidl.admin.
|
|
3457
|
+
.. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
|
|
3450
3458
|
|
|
3451
|
-
|
|
3459
|
+
WorkflowAttributesUpdateRequest
|
|
3452
3460
|
------------------------------------------------------------------
|
|
3453
3461
|
|
|
3454
|
-
|
|
3462
|
+
Sets custom attributes for a project, domain and workflow combination.
|
|
3463
|
+
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3455
3464
|
|
|
3456
3465
|
|
|
3457
3466
|
|
|
3458
|
-
.. csv-table::
|
|
3467
|
+
.. csv-table:: WorkflowAttributesUpdateRequest type fields
|
|
3459
3468
|
:header: "Field", "Type", "Label", "Description"
|
|
3460
3469
|
:widths: auto
|
|
3461
3470
|
|
|
3462
|
-
"
|
|
3463
|
-
|
|
3471
|
+
"attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
|
|
3472
|
+
|
|
3473
|
+
|
|
3474
|
+
|
|
3475
|
+
|
|
3476
|
+
|
|
3477
|
+
|
|
3478
|
+
|
|
3479
|
+
.. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
|
|
3480
|
+
|
|
3481
|
+
WorkflowAttributesUpdateResponse
|
|
3482
|
+
------------------------------------------------------------------
|
|
3483
|
+
|
|
3484
|
+
Purposefully empty, may be populated in the future.
|
|
3485
|
+
|
|
3464
3486
|
|
|
3465
3487
|
|
|
3466
3488
|
|
|
@@ -3477,33 +3499,32 @@ Represents a structure that encapsulates the specification of the workflow.
|
|
|
3477
3499
|
|
|
3478
3500
|
|
|
3479
3501
|
|
|
3480
|
-
.. _ref_flyteidl/admin/
|
|
3502
|
+
.. _ref_flyteidl/admin/workflow.proto:
|
|
3481
3503
|
|
|
3482
|
-
flyteidl/admin/
|
|
3504
|
+
flyteidl/admin/workflow.proto
|
|
3483
3505
|
==================================================================
|
|
3484
3506
|
|
|
3485
3507
|
|
|
3486
3508
|
|
|
3487
3509
|
|
|
3488
3510
|
|
|
3489
|
-
.. _ref_flyteidl.admin.
|
|
3511
|
+
.. _ref_flyteidl.admin.Workflow:
|
|
3490
3512
|
|
|
3491
|
-
|
|
3513
|
+
Workflow
|
|
3492
3514
|
------------------------------------------------------------------
|
|
3493
3515
|
|
|
3494
|
-
|
|
3495
|
-
|
|
3516
|
+
Represents the workflow structure stored in the Admin
|
|
3517
|
+
A workflow is created by ordering tasks and associating outputs to inputs
|
|
3518
|
+
in order to produce a directed-acyclic execution graph.
|
|
3496
3519
|
|
|
3497
3520
|
|
|
3498
3521
|
|
|
3499
|
-
.. csv-table::
|
|
3522
|
+
.. csv-table:: Workflow type fields
|
|
3500
3523
|
:header: "Field", "Type", "Label", "Description"
|
|
3501
3524
|
:widths: auto
|
|
3502
3525
|
|
|
3503
|
-
"
|
|
3504
|
-
"
|
|
3505
|
-
"workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
|
|
3506
|
-
"matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
|
|
3526
|
+
"id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
|
|
3527
|
+
"closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
|
|
3507
3528
|
|
|
3508
3529
|
|
|
3509
3530
|
|
|
@@ -3511,24 +3532,21 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
3511
3532
|
|
|
3512
3533
|
|
|
3513
3534
|
|
|
3514
|
-
.. _ref_flyteidl.admin.
|
|
3535
|
+
.. _ref_flyteidl.admin.WorkflowClosure:
|
|
3515
3536
|
|
|
3516
|
-
|
|
3537
|
+
WorkflowClosure
|
|
3517
3538
|
------------------------------------------------------------------
|
|
3518
3539
|
|
|
3519
|
-
|
|
3520
|
-
For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
|
|
3540
|
+
A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
|
|
3521
3541
|
|
|
3522
3542
|
|
|
3523
3543
|
|
|
3524
|
-
.. csv-table::
|
|
3544
|
+
.. csv-table:: WorkflowClosure type fields
|
|
3525
3545
|
:header: "Field", "Type", "Label", "Description"
|
|
3526
3546
|
:widths: auto
|
|
3527
3547
|
|
|
3528
|
-
"
|
|
3529
|
-
"
|
|
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"
|
|
3548
|
+
"compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
|
|
3549
|
+
"created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
|
|
3532
3550
|
|
|
3533
3551
|
|
|
3534
3552
|
|
|
@@ -3536,9 +3554,32 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
3536
3554
|
|
|
3537
3555
|
|
|
3538
3556
|
|
|
3539
|
-
.. _ref_flyteidl.admin.
|
|
3557
|
+
.. _ref_flyteidl.admin.WorkflowCreateRequest:
|
|
3540
3558
|
|
|
3541
|
-
|
|
3559
|
+
WorkflowCreateRequest
|
|
3560
|
+
------------------------------------------------------------------
|
|
3561
|
+
|
|
3562
|
+
Represents a request structure to create a revision of a workflow.
|
|
3563
|
+
See :ref:`ref_flyteidl.admin.Workflow` for more details
|
|
3564
|
+
|
|
3565
|
+
|
|
3566
|
+
|
|
3567
|
+
.. csv-table:: WorkflowCreateRequest type fields
|
|
3568
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3569
|
+
:widths: auto
|
|
3570
|
+
|
|
3571
|
+
"id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
|
|
3572
|
+
"spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
|
|
3573
|
+
|
|
3574
|
+
|
|
3575
|
+
|
|
3576
|
+
|
|
3577
|
+
|
|
3578
|
+
|
|
3579
|
+
|
|
3580
|
+
.. _ref_flyteidl.admin.WorkflowCreateResponse:
|
|
3581
|
+
|
|
3582
|
+
WorkflowCreateResponse
|
|
3542
3583
|
------------------------------------------------------------------
|
|
3543
3584
|
|
|
3544
3585
|
Purposefully empty, may be populated in the future.
|
|
@@ -3550,24 +3591,22 @@ Purposefully empty, may be populated in the future.
|
|
|
3550
3591
|
|
|
3551
3592
|
|
|
3552
3593
|
|
|
3553
|
-
.. _ref_flyteidl.admin.
|
|
3594
|
+
.. _ref_flyteidl.admin.WorkflowList:
|
|
3554
3595
|
|
|
3555
|
-
|
|
3596
|
+
WorkflowList
|
|
3556
3597
|
------------------------------------------------------------------
|
|
3557
3598
|
|
|
3558
|
-
|
|
3559
|
-
|
|
3599
|
+
Represents a list of workflows returned from the admin.
|
|
3600
|
+
See :ref:`ref_flyteidl.admin.Workflow` for more details
|
|
3560
3601
|
|
|
3561
3602
|
|
|
3562
3603
|
|
|
3563
|
-
.. csv-table::
|
|
3604
|
+
.. csv-table:: WorkflowList type fields
|
|
3564
3605
|
:header: "Field", "Type", "Label", "Description"
|
|
3565
3606
|
:widths: auto
|
|
3566
3607
|
|
|
3567
|
-
"
|
|
3568
|
-
"
|
|
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"
|
|
3608
|
+
"workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
|
|
3609
|
+
"token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
|
|
3571
3610
|
|
|
3572
3611
|
|
|
3573
3612
|
|
|
@@ -3575,56 +3614,118 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
|
|
|
3575
3614
|
|
|
3576
3615
|
|
|
3577
3616
|
|
|
3578
|
-
.. _ref_flyteidl.admin.
|
|
3617
|
+
.. _ref_flyteidl.admin.WorkflowSpec:
|
|
3579
3618
|
|
|
3580
|
-
|
|
3619
|
+
WorkflowSpec
|
|
3581
3620
|
------------------------------------------------------------------
|
|
3582
3621
|
|
|
3583
|
-
|
|
3622
|
+
Represents a structure that encapsulates the specification of the workflow.
|
|
3584
3623
|
|
|
3585
3624
|
|
|
3586
3625
|
|
|
3587
|
-
.. csv-table::
|
|
3626
|
+
.. csv-table:: WorkflowSpec type fields
|
|
3588
3627
|
:header: "Field", "Type", "Label", "Description"
|
|
3589
3628
|
:widths: auto
|
|
3590
3629
|
|
|
3591
|
-
"
|
|
3630
|
+
"template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
|
|
3631
|
+
"sub_workflows", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "repeated", "Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out to Admin to see other registered workflows). In fact, subworkflows do not even need to be registered."
|
|
3592
3632
|
|
|
3593
3633
|
|
|
3594
3634
|
|
|
3595
3635
|
|
|
3596
3636
|
|
|
3637
|
+
<!-- end messages -->
|
|
3597
3638
|
|
|
3639
|
+
<!-- end enums -->
|
|
3598
3640
|
|
|
3599
|
-
|
|
3641
|
+
<!-- end HasExtensions -->
|
|
3600
3642
|
|
|
3601
|
-
|
|
3643
|
+
<!-- end services -->
|
|
3644
|
+
|
|
3645
|
+
|
|
3646
|
+
|
|
3647
|
+
|
|
3648
|
+
.. _ref_google/protobuf/duration.proto:
|
|
3649
|
+
|
|
3650
|
+
google/protobuf/duration.proto
|
|
3651
|
+
==================================================================
|
|
3652
|
+
|
|
3653
|
+
|
|
3654
|
+
|
|
3655
|
+
|
|
3656
|
+
|
|
3657
|
+
.. _ref_google.protobuf.Duration:
|
|
3658
|
+
|
|
3659
|
+
Duration
|
|
3602
3660
|
------------------------------------------------------------------
|
|
3603
3661
|
|
|
3604
|
-
|
|
3605
|
-
|
|
3662
|
+
A Duration represents a signed, fixed-length span of time represented
|
|
3663
|
+
as a count of seconds and fractions of seconds at nanosecond
|
|
3664
|
+
resolution. It is independent of any calendar and concepts like "day"
|
|
3665
|
+
or "month". It is related to Timestamp in that the difference between
|
|
3666
|
+
two Timestamp values is a Duration and it can be added or subtracted
|
|
3667
|
+
from a Timestamp. Range is approximately +-10,000 years.
|
|
3606
3668
|
|
|
3669
|
+
# Examples
|
|
3607
3670
|
|
|
3671
|
+
Example 1: Compute Duration from two Timestamps in pseudo code.
|
|
3608
3672
|
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
|
|
3673
|
+
Timestamp start = ...;
|
|
3674
|
+
Timestamp end = ...;
|
|
3675
|
+
Duration duration = ...;
|
|
3612
3676
|
|
|
3613
|
-
|
|
3677
|
+
duration.seconds = end.seconds - start.seconds;
|
|
3678
|
+
duration.nanos = end.nanos - start.nanos;
|
|
3614
3679
|
|
|
3680
|
+
if (duration.seconds < 0 && duration.nanos > 0) {
|
|
3681
|
+
duration.seconds += 1;
|
|
3682
|
+
duration.nanos -= 1000000000;
|
|
3683
|
+
} else if (duration.seconds > 0 && duration.nanos < 0) {
|
|
3684
|
+
duration.seconds -= 1;
|
|
3685
|
+
duration.nanos += 1000000000;
|
|
3686
|
+
}
|
|
3615
3687
|
|
|
3688
|
+
Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
|
3616
3689
|
|
|
3690
|
+
Timestamp start = ...;
|
|
3691
|
+
Duration duration = ...;
|
|
3692
|
+
Timestamp end = ...;
|
|
3617
3693
|
|
|
3694
|
+
end.seconds = start.seconds + duration.seconds;
|
|
3695
|
+
end.nanos = start.nanos + duration.nanos;
|
|
3618
3696
|
|
|
3697
|
+
if (end.nanos < 0) {
|
|
3698
|
+
end.seconds -= 1;
|
|
3699
|
+
end.nanos += 1000000000;
|
|
3700
|
+
} else if (end.nanos >= 1000000000) {
|
|
3701
|
+
end.seconds += 1;
|
|
3702
|
+
end.nanos -= 1000000000;
|
|
3703
|
+
}
|
|
3619
3704
|
|
|
3705
|
+
Example 3: Compute Duration from datetime.timedelta in Python.
|
|
3620
3706
|
|
|
3621
|
-
|
|
3707
|
+
td = datetime.timedelta(days=3, minutes=10)
|
|
3708
|
+
duration = Duration()
|
|
3709
|
+
duration.FromTimedelta(td)
|
|
3622
3710
|
|
|
3623
|
-
|
|
3624
|
-
------------------------------------------------------------------
|
|
3711
|
+
# JSON Mapping
|
|
3625
3712
|
|
|
3626
|
-
|
|
3713
|
+
In JSON format, the Duration type is encoded as a string rather than an
|
|
3714
|
+
object, where the string ends in the suffix "s" (indicating seconds) and
|
|
3715
|
+
is preceded by the number of seconds, with nanoseconds expressed as
|
|
3716
|
+
fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
|
3717
|
+
encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
|
3718
|
+
be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
|
3719
|
+
microsecond should be expressed in JSON format as "3.000001s".
|
|
3720
|
+
|
|
3721
|
+
|
|
3722
|
+
|
|
3723
|
+
.. csv-table:: Duration type fields
|
|
3724
|
+
:header: "Field", "Type", "Label", "Description"
|
|
3725
|
+
:widths: auto
|
|
3627
3726
|
|
|
3727
|
+
"seconds", ":ref:`ref_int64`", "", "Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years"
|
|
3728
|
+
"nanos", ":ref:`ref_int32`", "", "Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive."
|
|
3628
3729
|
|
|
3629
3730
|
|
|
3630
3731
|
|