@flyteorg/flyteidl 0.21.11 → 0.21.12

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