@flyteorg/flyteidl 0.24.6 → 0.24.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/gen/pb-js/flyteidl.d.ts +30 -0
- package/gen/pb-js/flyteidl.js +104 -0
- package/package.json +1 -1
- package/protos/docs/admin/admin.rst +101 -0
- package/protos/docs/datacatalog/datacatalog.rst +367 -0
- package/protos/docs/event/event.rst +372 -0
- package/protos/flyteidl/event/event.proto +14 -0
- package/protos/docs/plugins/plugins.rst +0 -549
- package/protos/docs/service/service.rst +0 -353
|
@@ -53,6 +53,8 @@ This message contains metadata about external resources produced or used by a sp
|
|
|
53
53
|
"index", ":ref:`ref_uint32`", "", "A unique index for the external resource with respect to all external resources for this task. Although the identifier may change between task reporting events or retries, this will remain the same to enable aggregating information from multiple reports."
|
|
54
54
|
"retry_attempt", ":ref:`ref_uint32`", "", "Retry attempt number for this external resource, ie., 2 for the second attempt"
|
|
55
55
|
"phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "Phase associated with the external resource"
|
|
56
|
+
"cache_status", ":ref:`ref_flyteidl.core.CatalogCacheStatus`", "", "Captures the status of caching for this external resource execution."
|
|
57
|
+
"logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "log information for the external resource execution"
|
|
56
58
|
|
|
57
59
|
|
|
58
60
|
|
|
@@ -88,6 +90,9 @@ NodeExecutionEvent
|
|
|
88
90
|
"retry_group", ":ref:`ref_string`", "", "Retry group to indicate grouping of nodes by retries"
|
|
89
91
|
"spec_node_id", ":ref:`ref_string`", "", "Identifier of the node in the original workflow/graph This maps to value of WorkflowTemplate.nodes[X].id"
|
|
90
92
|
"node_name", ":ref:`ref_string`", "", "Friendly readable name for the node"
|
|
93
|
+
"event_version", ":ref:`ref_int32`", "", ""
|
|
94
|
+
"is_parent", ":ref:`ref_bool`", "", "Whether this node launched a subworkflow."
|
|
95
|
+
"is_dynamic", ":ref:`ref_bool`", "", "Whether this node yielded a dynamic workflow."
|
|
91
96
|
|
|
92
97
|
|
|
93
98
|
|
|
@@ -319,3 +324,370 @@ Includes the broad category of machine used for this specific task execution.
|
|
|
319
324
|
<!-- end services -->
|
|
320
325
|
|
|
321
326
|
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
.. _ref_google/protobuf/timestamp.proto:
|
|
330
|
+
|
|
331
|
+
google/protobuf/timestamp.proto
|
|
332
|
+
==================================================================
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
.. _ref_google.protobuf.Timestamp:
|
|
339
|
+
|
|
340
|
+
Timestamp
|
|
341
|
+
------------------------------------------------------------------
|
|
342
|
+
|
|
343
|
+
A Timestamp represents a point in time independent of any time zone or local
|
|
344
|
+
calendar, encoded as a count of seconds and fractions of seconds at
|
|
345
|
+
nanosecond resolution. The count is relative to an epoch at UTC midnight on
|
|
346
|
+
January 1, 1970, in the proleptic Gregorian calendar which extends the
|
|
347
|
+
Gregorian calendar backwards to year one.
|
|
348
|
+
|
|
349
|
+
All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
|
|
350
|
+
second table is needed for interpretation, using a [24-hour linear
|
|
351
|
+
smear](https://developers.google.com/time/smear).
|
|
352
|
+
|
|
353
|
+
The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
|
|
354
|
+
restricting to that range, we ensure that we can convert to and from [RFC
|
|
355
|
+
3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
|
|
356
|
+
|
|
357
|
+
# Examples
|
|
358
|
+
|
|
359
|
+
Example 1: Compute Timestamp from POSIX `time()`.
|
|
360
|
+
|
|
361
|
+
Timestamp timestamp;
|
|
362
|
+
timestamp.set_seconds(time(NULL));
|
|
363
|
+
timestamp.set_nanos(0);
|
|
364
|
+
|
|
365
|
+
Example 2: Compute Timestamp from POSIX `gettimeofday()`.
|
|
366
|
+
|
|
367
|
+
struct timeval tv;
|
|
368
|
+
gettimeofday(&tv, NULL);
|
|
369
|
+
|
|
370
|
+
Timestamp timestamp;
|
|
371
|
+
timestamp.set_seconds(tv.tv_sec);
|
|
372
|
+
timestamp.set_nanos(tv.tv_usec * 1000);
|
|
373
|
+
|
|
374
|
+
Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
|
|
375
|
+
|
|
376
|
+
FILETIME ft;
|
|
377
|
+
GetSystemTimeAsFileTime(&ft);
|
|
378
|
+
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
|
|
379
|
+
|
|
380
|
+
// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
|
|
381
|
+
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
|
|
382
|
+
Timestamp timestamp;
|
|
383
|
+
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
|
|
384
|
+
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
|
|
385
|
+
|
|
386
|
+
Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
|
|
387
|
+
|
|
388
|
+
long millis = System.currentTimeMillis();
|
|
389
|
+
|
|
390
|
+
Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
|
|
391
|
+
.setNanos((int) ((millis % 1000) * 1000000)).build();
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
Example 5: Compute Timestamp from Java `Instant.now()`.
|
|
395
|
+
|
|
396
|
+
Instant now = Instant.now();
|
|
397
|
+
|
|
398
|
+
Timestamp timestamp =
|
|
399
|
+
Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
|
400
|
+
.setNanos(now.getNano()).build();
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
Example 6: Compute Timestamp from current time in Python.
|
|
404
|
+
|
|
405
|
+
timestamp = Timestamp()
|
|
406
|
+
timestamp.GetCurrentTime()
|
|
407
|
+
|
|
408
|
+
# JSON Mapping
|
|
409
|
+
|
|
410
|
+
In JSON format, the Timestamp type is encoded as a string in the
|
|
411
|
+
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
|
|
412
|
+
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
|
|
413
|
+
where {year} is always expressed using four digits while {month}, {day},
|
|
414
|
+
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
|
|
415
|
+
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
|
|
416
|
+
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
|
|
417
|
+
is required. A proto3 JSON serializer should always use UTC (as indicated by
|
|
418
|
+
"Z") when printing the Timestamp type and a proto3 JSON parser should be
|
|
419
|
+
able to accept both UTC and other timezones (as indicated by an offset).
|
|
420
|
+
|
|
421
|
+
For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
|
|
422
|
+
01:30 UTC on January 15, 2017.
|
|
423
|
+
|
|
424
|
+
In JavaScript, one can convert a Date object to this format using the
|
|
425
|
+
standard
|
|
426
|
+
[toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
|
|
427
|
+
method. In Python, a standard `datetime.datetime` object can be converted
|
|
428
|
+
to this format using
|
|
429
|
+
[`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
|
|
430
|
+
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
|
|
431
|
+
the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
|
432
|
+
http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
|
|
433
|
+
) to obtain a formatter capable of generating timestamps in this format.
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
.. csv-table:: Timestamp type fields
|
|
438
|
+
:header: "Field", "Type", "Label", "Description"
|
|
439
|
+
:widths: auto
|
|
440
|
+
|
|
441
|
+
"seconds", ":ref:`ref_int64`", "", "Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive."
|
|
442
|
+
"nanos", ":ref:`ref_int32`", "", "Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive."
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<!-- end messages -->
|
|
449
|
+
|
|
450
|
+
<!-- end enums -->
|
|
451
|
+
|
|
452
|
+
<!-- end HasExtensions -->
|
|
453
|
+
|
|
454
|
+
<!-- end services -->
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
.. _ref_google/protobuf/duration.proto:
|
|
460
|
+
|
|
461
|
+
google/protobuf/duration.proto
|
|
462
|
+
==================================================================
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
.. _ref_google.protobuf.Duration:
|
|
469
|
+
|
|
470
|
+
Duration
|
|
471
|
+
------------------------------------------------------------------
|
|
472
|
+
|
|
473
|
+
A Duration represents a signed, fixed-length span of time represented
|
|
474
|
+
as a count of seconds and fractions of seconds at nanosecond
|
|
475
|
+
resolution. It is independent of any calendar and concepts like "day"
|
|
476
|
+
or "month". It is related to Timestamp in that the difference between
|
|
477
|
+
two Timestamp values is a Duration and it can be added or subtracted
|
|
478
|
+
from a Timestamp. Range is approximately +-10,000 years.
|
|
479
|
+
|
|
480
|
+
# Examples
|
|
481
|
+
|
|
482
|
+
Example 1: Compute Duration from two Timestamps in pseudo code.
|
|
483
|
+
|
|
484
|
+
Timestamp start = ...;
|
|
485
|
+
Timestamp end = ...;
|
|
486
|
+
Duration duration = ...;
|
|
487
|
+
|
|
488
|
+
duration.seconds = end.seconds - start.seconds;
|
|
489
|
+
duration.nanos = end.nanos - start.nanos;
|
|
490
|
+
|
|
491
|
+
if (duration.seconds < 0 && duration.nanos > 0) {
|
|
492
|
+
duration.seconds += 1;
|
|
493
|
+
duration.nanos -= 1000000000;
|
|
494
|
+
} else if (duration.seconds > 0 && duration.nanos < 0) {
|
|
495
|
+
duration.seconds -= 1;
|
|
496
|
+
duration.nanos += 1000000000;
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
|
500
|
+
|
|
501
|
+
Timestamp start = ...;
|
|
502
|
+
Duration duration = ...;
|
|
503
|
+
Timestamp end = ...;
|
|
504
|
+
|
|
505
|
+
end.seconds = start.seconds + duration.seconds;
|
|
506
|
+
end.nanos = start.nanos + duration.nanos;
|
|
507
|
+
|
|
508
|
+
if (end.nanos < 0) {
|
|
509
|
+
end.seconds -= 1;
|
|
510
|
+
end.nanos += 1000000000;
|
|
511
|
+
} else if (end.nanos >= 1000000000) {
|
|
512
|
+
end.seconds += 1;
|
|
513
|
+
end.nanos -= 1000000000;
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
Example 3: Compute Duration from datetime.timedelta in Python.
|
|
517
|
+
|
|
518
|
+
td = datetime.timedelta(days=3, minutes=10)
|
|
519
|
+
duration = Duration()
|
|
520
|
+
duration.FromTimedelta(td)
|
|
521
|
+
|
|
522
|
+
# JSON Mapping
|
|
523
|
+
|
|
524
|
+
In JSON format, the Duration type is encoded as a string rather than an
|
|
525
|
+
object, where the string ends in the suffix "s" (indicating seconds) and
|
|
526
|
+
is preceded by the number of seconds, with nanoseconds expressed as
|
|
527
|
+
fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
|
528
|
+
encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
|
529
|
+
be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
|
530
|
+
microsecond should be expressed in JSON format as "3.000001s".
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
.. csv-table:: Duration type fields
|
|
535
|
+
:header: "Field", "Type", "Label", "Description"
|
|
536
|
+
:widths: auto
|
|
537
|
+
|
|
538
|
+
"seconds", ":ref:`ref_int64`", "", "Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years"
|
|
539
|
+
"nanos", ":ref:`ref_int32`", "", "Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive."
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<!-- end messages -->
|
|
546
|
+
|
|
547
|
+
<!-- end enums -->
|
|
548
|
+
|
|
549
|
+
<!-- end HasExtensions -->
|
|
550
|
+
|
|
551
|
+
<!-- end services -->
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
.. _ref_google/protobuf/struct.proto:
|
|
557
|
+
|
|
558
|
+
google/protobuf/struct.proto
|
|
559
|
+
==================================================================
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
.. _ref_google.protobuf.ListValue:
|
|
566
|
+
|
|
567
|
+
ListValue
|
|
568
|
+
------------------------------------------------------------------
|
|
569
|
+
|
|
570
|
+
`ListValue` is a wrapper around a repeated field of values.
|
|
571
|
+
|
|
572
|
+
The JSON representation for `ListValue` is JSON array.
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
.. csv-table:: ListValue type fields
|
|
577
|
+
:header: "Field", "Type", "Label", "Description"
|
|
578
|
+
:widths: auto
|
|
579
|
+
|
|
580
|
+
"values", ":ref:`ref_google.protobuf.Value`", "repeated", "Repeated field of dynamically typed values."
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
.. _ref_google.protobuf.Struct:
|
|
589
|
+
|
|
590
|
+
Struct
|
|
591
|
+
------------------------------------------------------------------
|
|
592
|
+
|
|
593
|
+
`Struct` represents a structured data value, consisting of fields
|
|
594
|
+
which map to dynamically typed values. In some languages, `Struct`
|
|
595
|
+
might be supported by a native representation. For example, in
|
|
596
|
+
scripting languages like JS a struct is represented as an
|
|
597
|
+
object. The details of that representation are described together
|
|
598
|
+
with the proto support for the language.
|
|
599
|
+
|
|
600
|
+
The JSON representation for `Struct` is JSON object.
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
.. csv-table:: Struct type fields
|
|
605
|
+
:header: "Field", "Type", "Label", "Description"
|
|
606
|
+
:widths: auto
|
|
607
|
+
|
|
608
|
+
"fields", ":ref:`ref_google.protobuf.Struct.FieldsEntry`", "repeated", "Unordered map of dynamically typed values."
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
.. _ref_google.protobuf.Struct.FieldsEntry:
|
|
617
|
+
|
|
618
|
+
Struct.FieldsEntry
|
|
619
|
+
------------------------------------------------------------------
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
.. csv-table:: Struct.FieldsEntry type fields
|
|
626
|
+
:header: "Field", "Type", "Label", "Description"
|
|
627
|
+
:widths: auto
|
|
628
|
+
|
|
629
|
+
"key", ":ref:`ref_string`", "", ""
|
|
630
|
+
"value", ":ref:`ref_google.protobuf.Value`", "", ""
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
.. _ref_google.protobuf.Value:
|
|
639
|
+
|
|
640
|
+
Value
|
|
641
|
+
------------------------------------------------------------------
|
|
642
|
+
|
|
643
|
+
`Value` represents a dynamically typed value which can be either
|
|
644
|
+
null, a number, a string, a boolean, a recursive struct value, or a
|
|
645
|
+
list of values. A producer of value is expected to set one of these
|
|
646
|
+
variants. Absence of any variant indicates an error.
|
|
647
|
+
|
|
648
|
+
The JSON representation for `Value` is JSON value.
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
.. csv-table:: Value type fields
|
|
653
|
+
:header: "Field", "Type", "Label", "Description"
|
|
654
|
+
:widths: auto
|
|
655
|
+
|
|
656
|
+
"null_value", ":ref:`ref_google.protobuf.NullValue`", "", "Represents a null value."
|
|
657
|
+
"number_value", ":ref:`ref_double`", "", "Represents a double value."
|
|
658
|
+
"string_value", ":ref:`ref_string`", "", "Represents a string value."
|
|
659
|
+
"bool_value", ":ref:`ref_bool`", "", "Represents a boolean value."
|
|
660
|
+
"struct_value", ":ref:`ref_google.protobuf.Struct`", "", "Represents a structured value."
|
|
661
|
+
"list_value", ":ref:`ref_google.protobuf.ListValue`", "", "Represents a repeated `Value`."
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<!-- end messages -->
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
.. _ref_google.protobuf.NullValue:
|
|
672
|
+
|
|
673
|
+
NullValue
|
|
674
|
+
------------------------------------------------------------------
|
|
675
|
+
|
|
676
|
+
`NullValue` is a singleton enumeration to represent the null value for the
|
|
677
|
+
`Value` type union.
|
|
678
|
+
|
|
679
|
+
The JSON representation for `NullValue` is JSON `null`.
|
|
680
|
+
|
|
681
|
+
.. csv-table:: Enum NullValue values
|
|
682
|
+
:header: "Name", "Number", "Description"
|
|
683
|
+
:widths: auto
|
|
684
|
+
|
|
685
|
+
"NULL_VALUE", "0", "Null value."
|
|
686
|
+
|
|
687
|
+
<!-- end enums -->
|
|
688
|
+
|
|
689
|
+
<!-- end HasExtensions -->
|
|
690
|
+
|
|
691
|
+
<!-- end services -->
|
|
692
|
+
|
|
693
|
+
|
|
@@ -87,6 +87,14 @@ message NodeExecutionEvent {
|
|
|
87
87
|
|
|
88
88
|
// Friendly readable name for the node
|
|
89
89
|
string node_name = 13;
|
|
90
|
+
|
|
91
|
+
int32 event_version = 16;
|
|
92
|
+
|
|
93
|
+
// Whether this node launched a subworkflow.
|
|
94
|
+
bool is_parent = 17;
|
|
95
|
+
|
|
96
|
+
// Whether this node yielded a dynamic workflow.
|
|
97
|
+
bool is_dynamic = 18;
|
|
90
98
|
}
|
|
91
99
|
|
|
92
100
|
// For Workflow Nodes we need to send information about the workflow that's launched
|
|
@@ -204,6 +212,12 @@ message ExternalResourceInfo {
|
|
|
204
212
|
|
|
205
213
|
// Phase associated with the external resource
|
|
206
214
|
core.TaskExecution.Phase phase = 4;
|
|
215
|
+
|
|
216
|
+
// Captures the status of caching for this external resource execution.
|
|
217
|
+
core.CatalogCacheStatus cache_status = 5;
|
|
218
|
+
|
|
219
|
+
// log information for the external resource execution
|
|
220
|
+
repeated core.TaskLog logs = 6;
|
|
207
221
|
}
|
|
208
222
|
|
|
209
223
|
|