@flyteorg/flyteidl 0.21.10 → 0.21.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2260,31 +2260,32 @@ Note: This is internal to Admin and doesn't need to be exposed to other componen
2260
2260
 
2261
2261
 
2262
2262
 
2263
- .. _ref_flyteidl/admin/project.proto:
2263
+ .. _ref_flyteidl/admin/project_domain_attributes.proto:
2264
2264
 
2265
- flyteidl/admin/project.proto
2265
+ flyteidl/admin/project_domain_attributes.proto
2266
2266
  ==================================================================
2267
2267
 
2268
2268
 
2269
2269
 
2270
2270
 
2271
2271
 
2272
- .. _ref_flyteidl.admin.Domain:
2272
+ .. _ref_flyteidl.admin.ProjectDomainAttributes:
2273
2273
 
2274
- Domain
2274
+ ProjectDomainAttributes
2275
2275
  ------------------------------------------------------------------
2276
2276
 
2277
- Namespace within a project commonly used to differentiate between different service instances.
2278
- e.g. "production", "development", etc.
2277
+ Defines a set of custom matching attributes which defines resource defaults for a project and domain.
2278
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2279
2279
 
2280
2280
 
2281
2281
 
2282
- .. csv-table:: Domain type fields
2282
+ .. csv-table:: ProjectDomainAttributes type fields
2283
2283
  :header: "Field", "Type", "Label", "Description"
2284
2284
  :widths: auto
2285
2285
 
2286
- "id", ":ref:`ref_string`", "", "Globally unique domain name."
2287
- "name", ":ref:`ref_string`", "", "Display name."
2286
+ "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
2287
+ "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
2288
+ "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
2288
2289
 
2289
2290
 
2290
2291
 
@@ -2292,25 +2293,23 @@ e.g. "production", "development", etc.
2292
2293
 
2293
2294
 
2294
2295
 
2295
- .. _ref_flyteidl.admin.Project:
2296
+ .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
2296
2297
 
2297
- Project
2298
+ ProjectDomainAttributesDeleteRequest
2298
2299
  ------------------------------------------------------------------
2299
2300
 
2300
- Top-level namespace used to classify different entities like workflows and executions.
2301
+ Request to delete a set matchable project domain attribute override.
2302
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2301
2303
 
2302
2304
 
2303
2305
 
2304
- .. csv-table:: Project type fields
2306
+ .. csv-table:: ProjectDomainAttributesDeleteRequest type fields
2305
2307
  :header: "Field", "Type", "Label", "Description"
2306
2308
  :widths: auto
2307
2309
 
2308
- "id", ":ref:`ref_string`", "", "Globally unique project name."
2309
- "name", ":ref:`ref_string`", "", "Display name."
2310
- "domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
2311
- "description", ":ref:`ref_string`", "", ""
2312
- "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
2313
- "state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
2310
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2311
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2312
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
2314
2313
 
2315
2314
 
2316
2315
 
@@ -2318,24 +2317,13 @@ Top-level namespace used to classify different entities like workflows and execu
2318
2317
 
2319
2318
 
2320
2319
 
2321
- .. _ref_flyteidl.admin.ProjectListRequest:
2320
+ .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
2322
2321
 
2323
- ProjectListRequest
2322
+ ProjectDomainAttributesDeleteResponse
2324
2323
  ------------------------------------------------------------------
2325
2324
 
2326
- Request to retrieve a list of projects matching specified filters.
2327
- See :ref:`ref_flyteidl.admin.Project` for more details
2328
-
2329
-
2330
-
2331
- .. csv-table:: ProjectListRequest type fields
2332
- :header: "Field", "Type", "Label", "Description"
2333
- :widths: auto
2325
+ Purposefully empty, may be populated in the future.
2334
2326
 
2335
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
2336
- "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"
2337
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2338
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
2339
2327
 
2340
2328
 
2341
2329
 
@@ -2343,21 +2331,23 @@ See :ref:`ref_flyteidl.admin.Project` for more details
2343
2331
 
2344
2332
 
2345
2333
 
2346
- .. _ref_flyteidl.admin.ProjectRegisterRequest:
2334
+ .. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
2347
2335
 
2348
- ProjectRegisterRequest
2336
+ ProjectDomainAttributesGetRequest
2349
2337
  ------------------------------------------------------------------
2350
2338
 
2351
- Adds a new user-project within the Flyte deployment.
2352
- See :ref:`ref_flyteidl.admin.Project` for more details
2339
+ Request to get an individual project domain attribute override.
2340
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2353
2341
 
2354
2342
 
2355
2343
 
2356
- .. csv-table:: ProjectRegisterRequest type fields
2344
+ .. csv-table:: ProjectDomainAttributesGetRequest type fields
2357
2345
  :header: "Field", "Type", "Label", "Description"
2358
2346
  :widths: auto
2359
2347
 
2360
- "project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
2348
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2349
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2350
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
2361
2351
 
2362
2352
 
2363
2353
 
@@ -2365,27 +2355,21 @@ See :ref:`ref_flyteidl.admin.Project` for more details
2365
2355
 
2366
2356
 
2367
2357
 
2368
- .. _ref_flyteidl.admin.ProjectRegisterResponse:
2358
+ .. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
2369
2359
 
2370
- ProjectRegisterResponse
2360
+ ProjectDomainAttributesGetResponse
2371
2361
  ------------------------------------------------------------------
2372
2362
 
2373
- Purposefully empty, may be updated in the future.
2374
-
2375
-
2376
-
2377
-
2378
-
2379
-
2380
-
2363
+ Response to get an individual project domain attribute override.
2364
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2381
2365
 
2382
- .. _ref_flyteidl.admin.ProjectUpdateResponse:
2383
2366
 
2384
- ProjectUpdateResponse
2385
- ------------------------------------------------------------------
2386
2367
 
2387
- Purposefully empty, may be updated in the future.
2368
+ .. csv-table:: ProjectDomainAttributesGetResponse type fields
2369
+ :header: "Field", "Type", "Label", "Description"
2370
+ :widths: auto
2388
2371
 
2372
+ "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
2389
2373
 
2390
2374
 
2391
2375
 
@@ -2393,45 +2377,41 @@ Purposefully empty, may be updated in the future.
2393
2377
 
2394
2378
 
2395
2379
 
2396
- .. _ref_flyteidl.admin.Projects:
2380
+ .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
2397
2381
 
2398
- Projects
2382
+ ProjectDomainAttributesUpdateRequest
2399
2383
  ------------------------------------------------------------------
2400
2384
 
2401
- Represents a list of projects.
2402
- See :ref:`ref_flyteidl.admin.Project` for more details
2385
+ Sets custom attributes for a project-domain combination.
2386
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2403
2387
 
2404
2388
 
2405
2389
 
2406
- .. csv-table:: Projects type fields
2390
+ .. csv-table:: ProjectDomainAttributesUpdateRequest type fields
2407
2391
  :header: "Field", "Type", "Label", "Description"
2408
2392
  :widths: auto
2409
2393
 
2410
- "projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
2411
- "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."
2412
-
2394
+ "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
2413
2395
 
2414
2396
 
2415
2397
 
2416
2398
 
2417
- <!-- end messages -->
2418
2399
 
2419
2400
 
2420
2401
 
2421
- .. _ref_flyteidl.admin.Project.ProjectState:
2402
+ .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
2422
2403
 
2423
- Project.ProjectState
2404
+ ProjectDomainAttributesUpdateResponse
2424
2405
  ------------------------------------------------------------------
2425
2406
 
2426
- The state of the project is used to control its visibility in the UI and validity.
2407
+ Purposefully empty, may be populated in the future.
2408
+
2427
2409
 
2428
- .. csv-table:: Enum Project.ProjectState values
2429
- :header: "Name", "Number", "Description"
2430
- :widths: auto
2431
2410
 
2432
- "ACTIVE", "0", "By default, all projects are considered active."
2433
- "ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
2434
- "SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
2411
+
2412
+
2413
+
2414
+ <!-- end messages -->
2435
2415
 
2436
2416
  <!-- end enums -->
2437
2417
 
@@ -2442,32 +2422,31 @@ The state of the project is used to control its visibility in the UI and validit
2442
2422
 
2443
2423
 
2444
2424
 
2445
- .. _ref_flyteidl/admin/project_domain_attributes.proto:
2425
+ .. _ref_flyteidl/admin/project.proto:
2446
2426
 
2447
- flyteidl/admin/project_domain_attributes.proto
2427
+ flyteidl/admin/project.proto
2448
2428
  ==================================================================
2449
2429
 
2450
2430
 
2451
2431
 
2452
2432
 
2453
2433
 
2454
- .. _ref_flyteidl.admin.ProjectDomainAttributes:
2434
+ .. _ref_flyteidl.admin.Domain:
2455
2435
 
2456
- ProjectDomainAttributes
2436
+ Domain
2457
2437
  ------------------------------------------------------------------
2458
2438
 
2459
- Defines a set of custom matching attributes which defines resource defaults for a project and domain.
2460
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2439
+ Namespace within a project commonly used to differentiate between different service instances.
2440
+ e.g. "production", "development", etc.
2461
2441
 
2462
2442
 
2463
2443
 
2464
- .. csv-table:: ProjectDomainAttributes type fields
2444
+ .. csv-table:: Domain type fields
2465
2445
  :header: "Field", "Type", "Label", "Description"
2466
2446
  :widths: auto
2467
2447
 
2468
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
2469
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
2470
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
2448
+ "id", ":ref:`ref_string`", "", "Globally unique domain name."
2449
+ "name", ":ref:`ref_string`", "", "Display name."
2471
2450
 
2472
2451
 
2473
2452
 
@@ -2475,23 +2454,25 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
2475
2454
 
2476
2455
 
2477
2456
 
2478
- .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
2457
+ .. _ref_flyteidl.admin.Project:
2479
2458
 
2480
- ProjectDomainAttributesDeleteRequest
2459
+ Project
2481
2460
  ------------------------------------------------------------------
2482
2461
 
2483
- Request to delete a set matchable project domain attribute override.
2484
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2462
+ Top-level namespace used to classify different entities like workflows and executions.
2485
2463
 
2486
2464
 
2487
2465
 
2488
- .. csv-table:: ProjectDomainAttributesDeleteRequest type fields
2466
+ .. csv-table:: Project type fields
2489
2467
  :header: "Field", "Type", "Label", "Description"
2490
2468
  :widths: auto
2491
2469
 
2492
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2493
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2494
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
2470
+ "id", ":ref:`ref_string`", "", "Globally unique project name."
2471
+ "name", ":ref:`ref_string`", "", "Display name."
2472
+ "domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
2473
+ "description", ":ref:`ref_string`", "", ""
2474
+ "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
2475
+ "state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
2495
2476
 
2496
2477
 
2497
2478
 
@@ -2499,37 +2480,46 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
2499
2480
 
2500
2481
 
2501
2482
 
2502
- .. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
2483
+ .. _ref_flyteidl.admin.ProjectListRequest:
2503
2484
 
2504
- ProjectDomainAttributesDeleteResponse
2485
+ ProjectListRequest
2505
2486
  ------------------------------------------------------------------
2506
2487
 
2507
- Purposefully empty, may be populated in the future.
2488
+ Request to retrieve a list of projects matching specified filters.
2489
+ See :ref:`ref_flyteidl.admin.Project` for more details
2508
2490
 
2509
2491
 
2510
2492
 
2493
+ .. csv-table:: ProjectListRequest type fields
2494
+ :header: "Field", "Type", "Label", "Description"
2495
+ :widths: auto
2511
2496
 
2497
+ "limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
2498
+ "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"
2499
+ "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2500
+ "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
2512
2501
 
2513
2502
 
2514
2503
 
2515
2504
 
2516
- .. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
2517
2505
 
2518
- ProjectDomainAttributesGetRequest
2506
+
2507
+
2508
+ .. _ref_flyteidl.admin.ProjectRegisterRequest:
2509
+
2510
+ ProjectRegisterRequest
2519
2511
  ------------------------------------------------------------------
2520
2512
 
2521
- Request to get an individual project domain attribute override.
2522
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2513
+ Adds a new user-project within the Flyte deployment.
2514
+ See :ref:`ref_flyteidl.admin.Project` for more details
2523
2515
 
2524
2516
 
2525
2517
 
2526
- .. csv-table:: ProjectDomainAttributesGetRequest type fields
2518
+ .. csv-table:: ProjectRegisterRequest type fields
2527
2519
  :header: "Field", "Type", "Label", "Description"
2528
2520
  :widths: auto
2529
2521
 
2530
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
2531
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
2532
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
2522
+ "project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
2533
2523
 
2534
2524
 
2535
2525
 
@@ -2537,63 +2527,73 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
2537
2527
 
2538
2528
 
2539
2529
 
2540
- .. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
2530
+ .. _ref_flyteidl.admin.ProjectRegisterResponse:
2541
2531
 
2542
- ProjectDomainAttributesGetResponse
2532
+ ProjectRegisterResponse
2543
2533
  ------------------------------------------------------------------
2544
2534
 
2545
- Response to get an individual project domain attribute override.
2546
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2535
+ Purposefully empty, may be updated in the future.
2547
2536
 
2548
2537
 
2549
2538
 
2550
- .. csv-table:: ProjectDomainAttributesGetResponse type fields
2551
- :header: "Field", "Type", "Label", "Description"
2552
- :widths: auto
2553
2539
 
2554
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
2555
2540
 
2556
2541
 
2557
2542
 
2558
2543
 
2544
+ .. _ref_flyteidl.admin.ProjectUpdateResponse:
2559
2545
 
2546
+ ProjectUpdateResponse
2547
+ ------------------------------------------------------------------
2560
2548
 
2549
+ Purposefully empty, may be updated in the future.
2561
2550
 
2562
- .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
2563
2551
 
2564
- ProjectDomainAttributesUpdateRequest
2565
- ------------------------------------------------------------------
2566
2552
 
2567
- Sets custom attributes for a project-domain combination.
2568
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
2569
2553
 
2570
2554
 
2571
2555
 
2572
- .. csv-table:: ProjectDomainAttributesUpdateRequest type fields
2573
- :header: "Field", "Type", "Label", "Description"
2574
- :widths: auto
2575
2556
 
2576
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
2577
2557
 
2558
+ .. _ref_flyteidl.admin.Projects:
2578
2559
 
2560
+ Projects
2561
+ ------------------------------------------------------------------
2579
2562
 
2563
+ Represents a list of projects.
2564
+ See :ref:`ref_flyteidl.admin.Project` for more details
2580
2565
 
2581
2566
 
2582
2567
 
2568
+ .. csv-table:: Projects type fields
2569
+ :header: "Field", "Type", "Label", "Description"
2570
+ :widths: auto
2583
2571
 
2584
- .. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
2572
+ "projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
2573
+ "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."
2585
2574
 
2586
- ProjectDomainAttributesUpdateResponse
2587
- ------------------------------------------------------------------
2588
2575
 
2589
- Purposefully empty, may be populated in the future.
2590
2576
 
2591
2577
 
2592
2578
 
2579
+ <!-- end messages -->
2593
2580
 
2594
2581
 
2595
2582
 
2596
- <!-- end messages -->
2583
+ .. _ref_flyteidl.admin.Project.ProjectState:
2584
+
2585
+ Project.ProjectState
2586
+ ------------------------------------------------------------------
2587
+
2588
+ The state of the project is used to control its visibility in the UI and validity.
2589
+
2590
+ .. csv-table:: Enum Project.ProjectState values
2591
+ :header: "Name", "Number", "Description"
2592
+ :widths: auto
2593
+
2594
+ "ACTIVE", "0", "By default, all projects are considered active."
2595
+ "ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
2596
+ "SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
2597
2597
 
2598
2598
  <!-- end enums -->
2599
2599
 
@@ -2707,32 +2707,34 @@ Represents a frequency at which to run a schedule.
2707
2707
 
2708
2708
 
2709
2709
 
2710
- .. _ref_flyteidl/admin/task.proto:
2710
+ .. _ref_flyteidl/admin/task_execution.proto:
2711
2711
 
2712
- flyteidl/admin/task.proto
2712
+ flyteidl/admin/task_execution.proto
2713
2713
  ==================================================================
2714
2714
 
2715
2715
 
2716
2716
 
2717
2717
 
2718
2718
 
2719
- .. _ref_flyteidl.admin.Task:
2719
+ .. _ref_flyteidl.admin.TaskExecution:
2720
2720
 
2721
- Task
2721
+ TaskExecution
2722
2722
  ------------------------------------------------------------------
2723
2723
 
2724
- Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
2725
- arranged to process workflow inputs and produce a deterministic set of outputs.
2726
- Tasks can come in many varieties tuned for specialized behavior.
2724
+ Encapsulates all details for a single task execution entity.
2725
+ A task execution represents an instantiated task, including all inputs and additional
2726
+ metadata as well as computed results included state, outputs, and duration-based attributes.
2727
2727
 
2728
2728
 
2729
2729
 
2730
- .. csv-table:: Task type fields
2730
+ .. csv-table:: TaskExecution type fields
2731
2731
  :header: "Field", "Type", "Label", "Description"
2732
2732
  :widths: auto
2733
2733
 
2734
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
2735
- "closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
2734
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
2735
+ "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
2736
+ "closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
2737
+ "is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
2736
2738
 
2737
2739
 
2738
2740
 
@@ -2740,22 +2742,32 @@ Tasks can come in many varieties tuned for specialized behavior.
2740
2742
 
2741
2743
 
2742
2744
 
2743
- .. _ref_flyteidl.admin.TaskClosure:
2745
+ .. _ref_flyteidl.admin.TaskExecutionClosure:
2744
2746
 
2745
- TaskClosure
2747
+ TaskExecutionClosure
2746
2748
  ------------------------------------------------------------------
2747
2749
 
2748
- Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
2749
- and task metadata.
2750
+ Container for task execution details and results.
2750
2751
 
2751
2752
 
2752
2753
 
2753
- .. csv-table:: TaskClosure type fields
2754
+ .. csv-table:: TaskExecutionClosure type fields
2754
2755
  :header: "Field", "Type", "Label", "Description"
2755
2756
  :widths: auto
2756
2757
 
2757
- "compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
2758
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
2758
+ "output_uri", ":ref:`ref_string`", "", "Path to remote data store where output blob is stored if the execution succeeded (and produced outputs)."
2759
+ "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
2760
+ "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Raw output data produced by this task execution."
2761
+ "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
2762
+ "logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
2763
+ "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
2764
+ "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
2765
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
2766
+ "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
2767
+ "custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
2768
+ "reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
2769
+ "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
2770
+ "metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
2759
2771
 
2760
2772
 
2761
2773
 
@@ -2763,22 +2775,21 @@ and task metadata.
2763
2775
 
2764
2776
 
2765
2777
 
2766
- .. _ref_flyteidl.admin.TaskCreateRequest:
2778
+ .. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
2767
2779
 
2768
- TaskCreateRequest
2780
+ TaskExecutionGetDataRequest
2769
2781
  ------------------------------------------------------------------
2770
2782
 
2771
- Represents a request structure to create a revision of a task.
2772
- See :ref:`ref_flyteidl.admin.Task` for more details
2783
+ Request structure to fetch inputs and output for a task execution.
2784
+ By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
2773
2785
 
2774
2786
 
2775
2787
 
2776
- .. csv-table:: TaskCreateRequest type fields
2788
+ .. csv-table:: TaskExecutionGetDataRequest type fields
2777
2789
  :header: "Field", "Type", "Label", "Description"
2778
2790
  :widths: auto
2779
2791
 
2780
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
2781
- "spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
2792
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
2782
2793
 
2783
2794
 
2784
2795
 
@@ -2786,38 +2797,45 @@ See :ref:`ref_flyteidl.admin.Task` for more details
2786
2797
 
2787
2798
 
2788
2799
 
2789
- .. _ref_flyteidl.admin.TaskCreateResponse:
2800
+ .. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
2790
2801
 
2791
- TaskCreateResponse
2802
+ TaskExecutionGetDataResponse
2792
2803
  ------------------------------------------------------------------
2793
2804
 
2794
- Represents a response structure if task creation succeeds.
2805
+ Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
2795
2806
 
2796
- Purposefully empty, may be populated in the future.
2797
2807
 
2798
2808
 
2809
+ .. csv-table:: TaskExecutionGetDataResponse type fields
2810
+ :header: "Field", "Type", "Label", "Description"
2811
+ :widths: auto
2799
2812
 
2813
+ "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
2814
+ "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
2815
+ "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
2816
+ "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
2800
2817
 
2801
2818
 
2802
2819
 
2803
2820
 
2804
2821
 
2805
- .. _ref_flyteidl.admin.TaskList:
2806
2822
 
2807
- TaskList
2823
+
2824
+ .. _ref_flyteidl.admin.TaskExecutionGetRequest:
2825
+
2826
+ TaskExecutionGetRequest
2808
2827
  ------------------------------------------------------------------
2809
2828
 
2810
- Represents a list of tasks returned from the admin.
2811
- See :ref:`ref_flyteidl.admin.Task` for more details
2829
+ A message used to fetch a single task execution entity.
2830
+ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
2812
2831
 
2813
2832
 
2814
2833
 
2815
- .. csv-table:: TaskList type fields
2834
+ .. csv-table:: TaskExecutionGetRequest type fields
2816
2835
  :header: "Field", "Type", "Label", "Description"
2817
2836
  :widths: auto
2818
2837
 
2819
- "tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
2820
- "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."
2838
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
2821
2839
 
2822
2840
 
2823
2841
 
@@ -2825,97 +2843,90 @@ See :ref:`ref_flyteidl.admin.Task` for more details
2825
2843
 
2826
2844
 
2827
2845
 
2828
- .. _ref_flyteidl.admin.TaskSpec:
2846
+ .. _ref_flyteidl.admin.TaskExecutionList:
2829
2847
 
2830
- TaskSpec
2848
+ TaskExecutionList
2831
2849
  ------------------------------------------------------------------
2832
2850
 
2833
- Represents a structure that encapsulates the user-configured specification of the task.
2851
+ Response structure for a query to list of task execution entities.
2852
+ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
2834
2853
 
2835
2854
 
2836
2855
 
2837
- .. csv-table:: TaskSpec type fields
2856
+ .. csv-table:: TaskExecutionList type fields
2838
2857
  :header: "Field", "Type", "Label", "Description"
2839
2858
  :widths: auto
2840
2859
 
2841
- "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
2860
+ "task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
2861
+ "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."
2842
2862
 
2843
2863
 
2844
2864
 
2845
2865
 
2846
2866
 
2847
- <!-- end messages -->
2848
2867
 
2849
- <!-- end enums -->
2850
2868
 
2851
- <!-- end HasExtensions -->
2869
+ .. _ref_flyteidl.admin.TaskExecutionListRequest:
2852
2870
 
2853
- <!-- end services -->
2871
+ TaskExecutionListRequest
2872
+ ------------------------------------------------------------------
2854
2873
 
2874
+ Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
2875
+ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
2855
2876
 
2856
2877
 
2857
2878
 
2858
- .. _ref_flyteidl/admin/task_execution.proto:
2879
+ .. csv-table:: TaskExecutionListRequest type fields
2880
+ :header: "Field", "Type", "Label", "Description"
2881
+ :widths: auto
2859
2882
 
2860
- flyteidl/admin/task_execution.proto
2861
- ==================================================================
2883
+ "node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
2884
+ "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
2885
+ "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"
2886
+ "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
2887
+ "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
2862
2888
 
2863
2889
 
2864
2890
 
2865
2891
 
2866
2892
 
2867
- .. _ref_flyteidl.admin.TaskExecution:
2893
+ <!-- end messages -->
2868
2894
 
2869
- TaskExecution
2870
- ------------------------------------------------------------------
2895
+ <!-- end enums -->
2871
2896
 
2872
- Encapsulates all details for a single task execution entity.
2873
- A task execution represents an instantiated task, including all inputs and additional
2874
- metadata as well as computed results included state, outputs, and duration-based attributes.
2897
+ <!-- end HasExtensions -->
2875
2898
 
2899
+ <!-- end services -->
2876
2900
 
2877
2901
 
2878
- .. csv-table:: TaskExecution type fields
2879
- :header: "Field", "Type", "Label", "Description"
2880
- :widths: auto
2881
2902
 
2882
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
2883
- "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
2884
- "closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
2885
- "is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
2886
2903
 
2904
+ .. _ref_flyteidl/admin/task.proto:
2887
2905
 
2906
+ flyteidl/admin/task.proto
2907
+ ==================================================================
2888
2908
 
2889
2909
 
2890
2910
 
2891
2911
 
2892
2912
 
2893
- .. _ref_flyteidl.admin.TaskExecutionClosure:
2913
+ .. _ref_flyteidl.admin.Task:
2894
2914
 
2895
- TaskExecutionClosure
2915
+ Task
2896
2916
  ------------------------------------------------------------------
2897
2917
 
2898
- Container for task execution details and results.
2918
+ Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
2919
+ arranged to process workflow inputs and produce a deterministic set of outputs.
2920
+ Tasks can come in many varieties tuned for specialized behavior.
2899
2921
 
2900
2922
 
2901
2923
 
2902
- .. csv-table:: TaskExecutionClosure type fields
2924
+ .. csv-table:: Task type fields
2903
2925
  :header: "Field", "Type", "Label", "Description"
2904
2926
  :widths: auto
2905
2927
 
2906
- "output_uri", ":ref:`ref_string`", "", "Path to remote data store where output blob is stored if the execution succeeded (and produced outputs)."
2907
- "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
2908
- "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Raw output data produced by this task execution."
2909
- "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
2910
- "logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
2911
- "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
2912
- "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
2913
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
2914
- "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
2915
- "custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
2916
- "reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
2917
- "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
2918
- "metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
2928
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
2929
+ "closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
2919
2930
 
2920
2931
 
2921
2932
 
@@ -2923,21 +2934,22 @@ Container for task execution details and results.
2923
2934
 
2924
2935
 
2925
2936
 
2926
- .. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
2937
+ .. _ref_flyteidl.admin.TaskClosure:
2927
2938
 
2928
- TaskExecutionGetDataRequest
2939
+ TaskClosure
2929
2940
  ------------------------------------------------------------------
2930
2941
 
2931
- Request structure to fetch inputs and output for a task execution.
2932
- By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
2942
+ Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
2943
+ and task metadata.
2933
2944
 
2934
2945
 
2935
2946
 
2936
- .. csv-table:: TaskExecutionGetDataRequest type fields
2947
+ .. csv-table:: TaskClosure type fields
2937
2948
  :header: "Field", "Type", "Label", "Description"
2938
2949
  :widths: auto
2939
2950
 
2940
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
2951
+ "compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
2952
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
2941
2953
 
2942
2954
 
2943
2955
 
@@ -2945,23 +2957,22 @@ By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExec
2945
2957
 
2946
2958
 
2947
2959
 
2948
- .. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
2960
+ .. _ref_flyteidl.admin.TaskCreateRequest:
2949
2961
 
2950
- TaskExecutionGetDataResponse
2962
+ TaskCreateRequest
2951
2963
  ------------------------------------------------------------------
2952
2964
 
2953
- Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
2965
+ Represents a request structure to create a revision of a task.
2966
+ See :ref:`ref_flyteidl.admin.Task` for more details
2954
2967
 
2955
2968
 
2956
2969
 
2957
- .. csv-table:: TaskExecutionGetDataResponse type fields
2970
+ .. csv-table:: TaskCreateRequest type fields
2958
2971
  :header: "Field", "Type", "Label", "Description"
2959
2972
  :widths: auto
2960
2973
 
2961
- "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
2962
- "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
2963
- "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
2964
- "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
2974
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
2975
+ "spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
2965
2976
 
2966
2977
 
2967
2978
 
@@ -2969,21 +2980,15 @@ Response structure for TaskExecutionGetDataRequest which contains inputs and out
2969
2980
 
2970
2981
 
2971
2982
 
2972
- .. _ref_flyteidl.admin.TaskExecutionGetRequest:
2983
+ .. _ref_flyteidl.admin.TaskCreateResponse:
2973
2984
 
2974
- TaskExecutionGetRequest
2985
+ TaskCreateResponse
2975
2986
  ------------------------------------------------------------------
2976
2987
 
2977
- A message used to fetch a single task execution entity.
2978
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
2979
-
2980
-
2988
+ Represents a response structure if task creation succeeds.
2981
2989
 
2982
- .. csv-table:: TaskExecutionGetRequest type fields
2983
- :header: "Field", "Type", "Label", "Description"
2984
- :widths: auto
2990
+ Purposefully empty, may be populated in the future.
2985
2991
 
2986
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
2987
2992
 
2988
2993
 
2989
2994
 
@@ -2991,21 +2996,21 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
2991
2996
 
2992
2997
 
2993
2998
 
2994
- .. _ref_flyteidl.admin.TaskExecutionList:
2999
+ .. _ref_flyteidl.admin.TaskList:
2995
3000
 
2996
- TaskExecutionList
3001
+ TaskList
2997
3002
  ------------------------------------------------------------------
2998
3003
 
2999
- Response structure for a query to list of task execution entities.
3000
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3004
+ Represents a list of tasks returned from the admin.
3005
+ See :ref:`ref_flyteidl.admin.Task` for more details
3001
3006
 
3002
3007
 
3003
3008
 
3004
- .. csv-table:: TaskExecutionList type fields
3009
+ .. csv-table:: TaskList type fields
3005
3010
  :header: "Field", "Type", "Label", "Description"
3006
3011
  :widths: auto
3007
3012
 
3008
- "task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
3013
+ "tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
3009
3014
  "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."
3010
3015
 
3011
3016
 
@@ -3014,25 +3019,20 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3014
3019
 
3015
3020
 
3016
3021
 
3017
- .. _ref_flyteidl.admin.TaskExecutionListRequest:
3022
+ .. _ref_flyteidl.admin.TaskSpec:
3018
3023
 
3019
- TaskExecutionListRequest
3024
+ TaskSpec
3020
3025
  ------------------------------------------------------------------
3021
3026
 
3022
- Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
3023
- See :ref:`ref_flyteidl.admin.TaskExecution` for more details
3027
+ Represents a structure that encapsulates the user-configured specification of the task.
3024
3028
 
3025
3029
 
3026
3030
 
3027
- .. csv-table:: TaskExecutionListRequest type fields
3031
+ .. csv-table:: TaskSpec type fields
3028
3032
  :header: "Field", "Type", "Label", "Description"
3029
3033
  :widths: auto
3030
3034
 
3031
- "node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
3032
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
3033
- "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"
3034
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional"
3035
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
3035
+ "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
3036
3036
 
3037
3037
 
3038
3038
 
@@ -3125,32 +3125,33 @@ Provides Version information for a component
3125
3125
 
3126
3126
 
3127
3127
 
3128
- .. _ref_flyteidl/admin/workflow.proto:
3128
+ .. _ref_flyteidl/admin/workflow_attributes.proto:
3129
3129
 
3130
- flyteidl/admin/workflow.proto
3130
+ flyteidl/admin/workflow_attributes.proto
3131
3131
  ==================================================================
3132
3132
 
3133
3133
 
3134
3134
 
3135
3135
 
3136
3136
 
3137
- .. _ref_flyteidl.admin.Workflow:
3137
+ .. _ref_flyteidl.admin.WorkflowAttributes:
3138
3138
 
3139
- Workflow
3139
+ WorkflowAttributes
3140
3140
  ------------------------------------------------------------------
3141
3141
 
3142
- Represents the workflow structure stored in the Admin
3143
- A workflow is created by ordering tasks and associating outputs to inputs
3144
- in order to produce a directed-acyclic execution graph.
3142
+ Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
3143
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3145
3144
 
3146
3145
 
3147
3146
 
3148
- .. csv-table:: Workflow type fields
3147
+ .. csv-table:: WorkflowAttributes type fields
3149
3148
  :header: "Field", "Type", "Label", "Description"
3150
3149
  :widths: auto
3151
3150
 
3152
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
3153
- "closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
3151
+ "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
3152
+ "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
3153
+ "workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
3154
+ "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
3154
3155
 
3155
3156
 
3156
3157
 
@@ -3158,21 +3159,24 @@ in order to produce a directed-acyclic execution graph.
3158
3159
 
3159
3160
 
3160
3161
 
3161
- .. _ref_flyteidl.admin.WorkflowClosure:
3162
+ .. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
3162
3163
 
3163
- WorkflowClosure
3164
+ WorkflowAttributesDeleteRequest
3164
3165
  ------------------------------------------------------------------
3165
3166
 
3166
- A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
3167
+ Request to delete a set matchable workflow attribute override.
3168
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3167
3169
 
3168
3170
 
3169
3171
 
3170
- .. csv-table:: WorkflowClosure type fields
3172
+ .. csv-table:: WorkflowAttributesDeleteRequest type fields
3171
3173
  :header: "Field", "Type", "Label", "Description"
3172
3174
  :widths: auto
3173
3175
 
3174
- "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
3175
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
3176
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3177
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3178
+ "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3179
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
3176
3180
 
3177
3181
 
3178
3182
 
@@ -3180,36 +3184,38 @@ A container holding the compiled workflow produced from the WorkflowSpec and add
3180
3184
 
3181
3185
 
3182
3186
 
3183
- .. _ref_flyteidl.admin.WorkflowCreateRequest:
3187
+ .. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
3184
3188
 
3185
- WorkflowCreateRequest
3189
+ WorkflowAttributesDeleteResponse
3186
3190
  ------------------------------------------------------------------
3187
3191
 
3188
- Represents a request structure to create a revision of a workflow.
3189
- See :ref:`ref_flyteidl.admin.Workflow` for more details
3192
+ Purposefully empty, may be populated in the future.
3190
3193
 
3191
3194
 
3192
3195
 
3193
- .. csv-table:: WorkflowCreateRequest type fields
3194
- :header: "Field", "Type", "Label", "Description"
3195
- :widths: auto
3196
3196
 
3197
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
3198
- "spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
3199
3197
 
3200
3198
 
3201
3199
 
3202
3200
 
3201
+ .. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
3203
3202
 
3203
+ WorkflowAttributesGetRequest
3204
+ ------------------------------------------------------------------
3204
3205
 
3206
+ Request to get an individual workflow attribute override.
3207
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3205
3208
 
3206
- .. _ref_flyteidl.admin.WorkflowCreateResponse:
3207
3209
 
3208
- WorkflowCreateResponse
3209
- ------------------------------------------------------------------
3210
3210
 
3211
- Purposefully empty, may be populated in the future.
3211
+ .. csv-table:: WorkflowAttributesGetRequest type fields
3212
+ :header: "Field", "Type", "Label", "Description"
3213
+ :widths: auto
3212
3214
 
3215
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3216
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3217
+ "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3218
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
3213
3219
 
3214
3220
 
3215
3221
 
@@ -3217,22 +3223,20 @@ Purposefully empty, may be populated in the future.
3217
3223
 
3218
3224
 
3219
3225
 
3220
- .. _ref_flyteidl.admin.WorkflowList:
3226
+ .. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
3221
3227
 
3222
- WorkflowList
3228
+ WorkflowAttributesGetResponse
3223
3229
  ------------------------------------------------------------------
3224
3230
 
3225
- Represents a list of workflows returned from the admin.
3226
- See :ref:`ref_flyteidl.admin.Workflow` for more details
3231
+ Response to get an individual workflow attribute override.
3227
3232
 
3228
3233
 
3229
3234
 
3230
- .. csv-table:: WorkflowList type fields
3235
+ .. csv-table:: WorkflowAttributesGetResponse type fields
3231
3236
  :header: "Field", "Type", "Label", "Description"
3232
3237
  :widths: auto
3233
3238
 
3234
- "workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
3235
- "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."
3239
+ "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3236
3240
 
3237
3241
 
3238
3242
 
@@ -3240,21 +3244,35 @@ See :ref:`ref_flyteidl.admin.Workflow` for more details
3240
3244
 
3241
3245
 
3242
3246
 
3243
- .. _ref_flyteidl.admin.WorkflowSpec:
3247
+ .. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
3244
3248
 
3245
- WorkflowSpec
3249
+ WorkflowAttributesUpdateRequest
3246
3250
  ------------------------------------------------------------------
3247
3251
 
3248
- Represents a structure that encapsulates the specification of the workflow.
3252
+ Sets custom attributes for a project, domain and workflow combination.
3253
+ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3249
3254
 
3250
3255
 
3251
3256
 
3252
- .. csv-table:: WorkflowSpec type fields
3257
+ .. csv-table:: WorkflowAttributesUpdateRequest type fields
3253
3258
  :header: "Field", "Type", "Label", "Description"
3254
3259
  :widths: auto
3255
3260
 
3256
- "template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
3257
- "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."
3261
+ "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3262
+
3263
+
3264
+
3265
+
3266
+
3267
+
3268
+
3269
+ .. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
3270
+
3271
+ WorkflowAttributesUpdateResponse
3272
+ ------------------------------------------------------------------
3273
+
3274
+ Purposefully empty, may be populated in the future.
3275
+
3258
3276
 
3259
3277
 
3260
3278
 
@@ -3271,33 +3289,32 @@ Represents a structure that encapsulates the specification of the workflow.
3271
3289
 
3272
3290
 
3273
3291
 
3274
- .. _ref_flyteidl/admin/workflow_attributes.proto:
3292
+ .. _ref_flyteidl/admin/workflow.proto:
3275
3293
 
3276
- flyteidl/admin/workflow_attributes.proto
3294
+ flyteidl/admin/workflow.proto
3277
3295
  ==================================================================
3278
3296
 
3279
3297
 
3280
3298
 
3281
3299
 
3282
3300
 
3283
- .. _ref_flyteidl.admin.WorkflowAttributes:
3301
+ .. _ref_flyteidl.admin.Workflow:
3284
3302
 
3285
- WorkflowAttributes
3303
+ Workflow
3286
3304
  ------------------------------------------------------------------
3287
3305
 
3288
- Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
3289
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3306
+ Represents the workflow structure stored in the Admin
3307
+ A workflow is created by ordering tasks and associating outputs to inputs
3308
+ in order to produce a directed-acyclic execution graph.
3290
3309
 
3291
3310
 
3292
3311
 
3293
- .. csv-table:: WorkflowAttributes type fields
3312
+ .. csv-table:: Workflow type fields
3294
3313
  :header: "Field", "Type", "Label", "Description"
3295
3314
  :widths: auto
3296
3315
 
3297
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
3298
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
3299
- "workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
3300
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
3316
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
3317
+ "closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
3301
3318
 
3302
3319
 
3303
3320
 
@@ -3305,24 +3322,21 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
3305
3322
 
3306
3323
 
3307
3324
 
3308
- .. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
3325
+ .. _ref_flyteidl.admin.WorkflowClosure:
3309
3326
 
3310
- WorkflowAttributesDeleteRequest
3327
+ WorkflowClosure
3311
3328
  ------------------------------------------------------------------
3312
3329
 
3313
- Request to delete a set matchable workflow attribute override.
3314
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3330
+ A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
3315
3331
 
3316
3332
 
3317
3333
 
3318
- .. csv-table:: WorkflowAttributesDeleteRequest type fields
3334
+ .. csv-table:: WorkflowClosure type fields
3319
3335
  :header: "Field", "Type", "Label", "Description"
3320
3336
  :widths: auto
3321
3337
 
3322
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3323
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3324
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3325
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
3338
+ "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
3339
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
3326
3340
 
3327
3341
 
3328
3342
 
@@ -3330,38 +3344,36 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
3330
3344
 
3331
3345
 
3332
3346
 
3333
- .. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
3347
+ .. _ref_flyteidl.admin.WorkflowCreateRequest:
3334
3348
 
3335
- WorkflowAttributesDeleteResponse
3349
+ WorkflowCreateRequest
3336
3350
  ------------------------------------------------------------------
3337
3351
 
3338
- Purposefully empty, may be populated in the future.
3352
+ Represents a request structure to create a revision of a workflow.
3353
+ See :ref:`ref_flyteidl.admin.Workflow` for more details
3339
3354
 
3340
3355
 
3341
3356
 
3357
+ .. csv-table:: WorkflowCreateRequest type fields
3358
+ :header: "Field", "Type", "Label", "Description"
3359
+ :widths: auto
3342
3360
 
3361
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
3362
+ "spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
3343
3363
 
3344
3364
 
3345
3365
 
3346
3366
 
3347
- .. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
3348
3367
 
3349
- WorkflowAttributesGetRequest
3350
- ------------------------------------------------------------------
3351
3368
 
3352
- Request to get an individual workflow attribute override.
3353
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3354
3369
 
3370
+ .. _ref_flyteidl.admin.WorkflowCreateResponse:
3355
3371
 
3372
+ WorkflowCreateResponse
3373
+ ------------------------------------------------------------------
3356
3374
 
3357
- .. csv-table:: WorkflowAttributesGetRequest type fields
3358
- :header: "Field", "Type", "Label", "Description"
3359
- :widths: auto
3375
+ Purposefully empty, may be populated in the future.
3360
3376
 
3361
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
3362
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
3363
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
3364
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
3365
3377
 
3366
3378
 
3367
3379
 
@@ -3369,20 +3381,22 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
3369
3381
 
3370
3382
 
3371
3383
 
3372
- .. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
3384
+ .. _ref_flyteidl.admin.WorkflowList:
3373
3385
 
3374
- WorkflowAttributesGetResponse
3386
+ WorkflowList
3375
3387
  ------------------------------------------------------------------
3376
3388
 
3377
- Response to get an individual workflow attribute override.
3389
+ Represents a list of workflows returned from the admin.
3390
+ See :ref:`ref_flyteidl.admin.Workflow` for more details
3378
3391
 
3379
3392
 
3380
3393
 
3381
- .. csv-table:: WorkflowAttributesGetResponse type fields
3394
+ .. csv-table:: WorkflowList type fields
3382
3395
  :header: "Field", "Type", "Label", "Description"
3383
3396
  :widths: auto
3384
3397
 
3385
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3398
+ "workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
3399
+ "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."
3386
3400
 
3387
3401
 
3388
3402
 
@@ -3390,35 +3404,21 @@ Response to get an individual workflow attribute override.
3390
3404
 
3391
3405
 
3392
3406
 
3393
- .. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
3407
+ .. _ref_flyteidl.admin.WorkflowSpec:
3394
3408
 
3395
- WorkflowAttributesUpdateRequest
3409
+ WorkflowSpec
3396
3410
  ------------------------------------------------------------------
3397
3411
 
3398
- Sets custom attributes for a project, domain and workflow combination.
3399
- For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
3412
+ Represents a structure that encapsulates the specification of the workflow.
3400
3413
 
3401
3414
 
3402
3415
 
3403
- .. csv-table:: WorkflowAttributesUpdateRequest type fields
3416
+ .. csv-table:: WorkflowSpec type fields
3404
3417
  :header: "Field", "Type", "Label", "Description"
3405
3418
  :widths: auto
3406
3419
 
3407
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
3408
-
3409
-
3410
-
3411
-
3412
-
3413
-
3414
-
3415
- .. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
3416
-
3417
- WorkflowAttributesUpdateResponse
3418
- ------------------------------------------------------------------
3419
-
3420
- Purposefully empty, may be populated in the future.
3421
-
3420
+ "template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
3421
+ "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."
3422
3422
 
3423
3423
 
3424
3424