@flyteorg/flyteidl 1.5.20 → 1.5.22

package/README.md

@@ -1,3 +1,6 @@
+| 🗑  As of Oct-23 we moved the development of this component to the [monorepo](https://github.com/flyteorg/flyte). 🗑  |
+| - |
+
 # Flyteidl
 
 This is one of the core repositories of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).

package/gen/pb-js/flyteidl.d.ts

@@ -7254,6 +7254,64 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
+        /** Properties of an EventReason. */
+        interface IEventReason {
+
+            /** EventReason reason */
+            reason?: (string|null);
+
+            /** EventReason occurredAt */
+            occurredAt?: (google.protobuf.ITimestamp|null);
+        }
+
+        /** Represents an EventReason. */
+        class EventReason implements IEventReason {
+
+            /**
+             * Constructs a new EventReason.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: flyteidl.event.IEventReason);
+
+            /** EventReason reason. */
+            public reason: string;
+
+            /** EventReason occurredAt. */
+            public occurredAt?: (google.protobuf.ITimestamp|null);
+
+            /**
+             * Creates a new EventReason instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns EventReason instance
+             */
+            public static create(properties?: flyteidl.event.IEventReason): flyteidl.event.EventReason;
+
+            /**
+             * Encodes the specified EventReason message. Does not implicitly {@link flyteidl.event.EventReason.verify|verify} messages.
+             * @param message EventReason message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: flyteidl.event.IEventReason, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes an EventReason message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns EventReason
+             * @throws {Error} If the payload is not a reader or valid buffer
+             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+             */
+            public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.event.EventReason;
+
+            /**
+             * Verifies an EventReason message.
+             * @param message Plain object to verify
+             * @returns `null` if valid, otherwise the reason why it is not
+             */
+            public static verify(message: { [k: string]: any }): (string|null);
+        }
+
         /** Properties of a TaskExecutionEvent. */
         interface ITaskExecutionEvent {
 
@@ -7302,6 +7360,9 @@ export namespace flyteidl {
             /** TaskExecutionEvent reason */
             reason?: (string|null);
 
+            /** TaskExecutionEvent reasons */
+            reasons?: (flyteidl.event.IEventReason[]|null);
+
             /** TaskExecutionEvent taskType */
             taskType?: (string|null);
 
@@ -7369,6 +7430,9 @@ export namespace flyteidl {
             /** TaskExecutionEvent reason. */
             public reason: string;
 
+            /** TaskExecutionEvent reasons. */
+            public reasons: flyteidl.event.IEventReason[];
+
             /** TaskExecutionEvent taskType. */
             public taskType: string;
 

package/gen/pb-js/flyteidl.js

@@ -17608,6 +17608,135 @@
                 return ParentNodeExecutionMetadata;
             })();
     
+            event.EventReason = (function() {
+    
+                /**
+                 * Properties of an EventReason.
+                 * @memberof flyteidl.event
+                 * @interface IEventReason
+                 * @property {string|null} [reason] EventReason reason
+                 * @property {google.protobuf.ITimestamp|null} [occurredAt] EventReason occurredAt
+                 */
+    
+                /**
+                 * Constructs a new EventReason.
+                 * @memberof flyteidl.event
+                 * @classdesc Represents an EventReason.
+                 * @implements IEventReason
+                 * @constructor
+                 * @param {flyteidl.event.IEventReason=} [properties] Properties to set
+                 */
+                function EventReason(properties) {
+                    if (properties)
+                        for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                            if (properties[keys[i]] != null)
+                                this[keys[i]] = properties[keys[i]];
+                }
+    
+                /**
+                 * EventReason reason.
+                 * @member {string} reason
+                 * @memberof flyteidl.event.EventReason
+                 * @instance
+                 */
+                EventReason.prototype.reason = "";
+    
+                /**
+                 * EventReason occurredAt.
+                 * @member {google.protobuf.ITimestamp|null|undefined} occurredAt
+                 * @memberof flyteidl.event.EventReason
+                 * @instance
+                 */
+                EventReason.prototype.occurredAt = null;
+    
+                /**
+                 * Creates a new EventReason instance using the specified properties.
+                 * @function create
+                 * @memberof flyteidl.event.EventReason
+                 * @static
+                 * @param {flyteidl.event.IEventReason=} [properties] Properties to set
+                 * @returns {flyteidl.event.EventReason} EventReason instance
+                 */
+                EventReason.create = function create(properties) {
+                    return new EventReason(properties);
+                };
+    
+                /**
+                 * Encodes the specified EventReason message. Does not implicitly {@link flyteidl.event.EventReason.verify|verify} messages.
+                 * @function encode
+                 * @memberof flyteidl.event.EventReason
+                 * @static
+                 * @param {flyteidl.event.IEventReason} message EventReason message or plain object to encode
+                 * @param {$protobuf.Writer} [writer] Writer to encode to
+                 * @returns {$protobuf.Writer} Writer
+                 */
+                EventReason.encode = function encode(message, writer) {
+                    if (!writer)
+                        writer = $Writer.create();
+                    if (message.reason != null && message.hasOwnProperty("reason"))
+                        writer.uint32(/* id 1, wireType 2 =*/10).string(message.reason);
+                    if (message.occurredAt != null && message.hasOwnProperty("occurredAt"))
+                        $root.google.protobuf.Timestamp.encode(message.occurredAt, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
+                    return writer;
+                };
+    
+                /**
+                 * Decodes an EventReason message from the specified reader or buffer.
+                 * @function decode
+                 * @memberof flyteidl.event.EventReason
+                 * @static
+                 * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                 * @param {number} [length] Message length if known beforehand
+                 * @returns {flyteidl.event.EventReason} EventReason
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                EventReason.decode = function decode(reader, length) {
+                    if (!(reader instanceof $Reader))
+                        reader = $Reader.create(reader);
+                    var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.event.EventReason();
+                    while (reader.pos < end) {
+                        var tag = reader.uint32();
+                        switch (tag >>> 3) {
+                        case 1:
+                            message.reason = reader.string();
+                            break;
+                        case 2:
+                            message.occurredAt = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
+                            break;
+                        default:
+                            reader.skipType(tag & 7);
+                            break;
+                        }
+                    }
+                    return message;
+                };
+    
+                /**
+                 * Verifies an EventReason message.
+                 * @function verify
+                 * @memberof flyteidl.event.EventReason
+                 * @static
+                 * @param {Object.<string,*>} message Plain object to verify
+                 * @returns {string|null} `null` if valid, otherwise the reason why it is not
+                 */
+                EventReason.verify = function verify(message) {
+                    if (typeof message !== "object" || message === null)
+                        return "object expected";
+                    if (message.reason != null && message.hasOwnProperty("reason"))
+                        if (!$util.isString(message.reason))
+                            return "reason: string expected";
+                    if (message.occurredAt != null && message.hasOwnProperty("occurredAt")) {
+                        var error = $root.google.protobuf.Timestamp.verify(message.occurredAt);
+                        if (error)
+                            return "occurredAt." + error;
+                    }
+                    return null;
+                };
+    
+                return EventReason;
+            })();
+    
             event.TaskExecutionEvent = (function() {
     
                 /**
@@ -17629,6 +17758,7 @@
                  * @property {google.protobuf.IStruct|null} [customInfo] TaskExecutionEvent customInfo
                  * @property {number|null} [phaseVersion] TaskExecutionEvent phaseVersion
                  * @property {string|null} [reason] TaskExecutionEvent reason
+                 * @property {Array.<flyteidl.event.IEventReason>|null} [reasons] TaskExecutionEvent reasons
                  * @property {string|null} [taskType] TaskExecutionEvent taskType
                  * @property {flyteidl.event.ITaskExecutionMetadata|null} [metadata] TaskExecutionEvent metadata
                  * @property {number|null} [eventVersion] TaskExecutionEvent eventVersion
@@ -17645,6 +17775,7 @@
                  */
                 function TaskExecutionEvent(properties) {
                     this.logs = [];
+                    this.reasons = [];
                     if (properties)
                         for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
                             if (properties[keys[i]] != null)
@@ -17771,6 +17902,14 @@
                  */
                 TaskExecutionEvent.prototype.reason = "";
     
+                /**
+                 * TaskExecutionEvent reasons.
+                 * @member {Array.<flyteidl.event.IEventReason>} reasons
+                 * @memberof flyteidl.event.TaskExecutionEvent
+                 * @instance
+                 */
+                TaskExecutionEvent.prototype.reasons = $util.emptyArray;
+    
                 /**
                  * TaskExecutionEvent taskType.
                  * @member {string} taskType
@@ -17891,6 +18030,9 @@
                         $root.flyteidl.core.LiteralMap.encode(message.inputData, writer.uint32(/* id 19, wireType 2 =*/154).fork()).ldelim();
                     if (message.reportedAt != null && message.hasOwnProperty("reportedAt"))
                         $root.google.protobuf.Timestamp.encode(message.reportedAt, writer.uint32(/* id 20, wireType 2 =*/162).fork()).ldelim();
+                    if (message.reasons != null && message.reasons.length)
+                        for (var i = 0; i < message.reasons.length; ++i)
+                            $root.flyteidl.event.EventReason.encode(message.reasons[i], writer.uint32(/* id 21, wireType 2 =*/170).fork()).ldelim();
                     return writer;
                 };
     
@@ -17959,6 +18101,11 @@
                         case 13:
                             message.reason = reader.string();
                             break;
+                        case 21:
+                            if (!(message.reasons && message.reasons.length))
+                                message.reasons = [];
+                            message.reasons.push($root.flyteidl.event.EventReason.decode(reader, reader.uint32()));
+                            break;
                         case 14:
                             message.taskType = reader.string();
                             break;
@@ -18086,6 +18233,15 @@
                     if (message.reason != null && message.hasOwnProperty("reason"))
                         if (!$util.isString(message.reason))
                             return "reason: string expected";
+                    if (message.reasons != null && message.hasOwnProperty("reasons")) {
+                        if (!Array.isArray(message.reasons))
+                            return "reasons: array expected";
+                        for (var i = 0; i < message.reasons.length; ++i) {
+                            var error = $root.flyteidl.event.EventReason.verify(message.reasons[i]);
+                            if (error)
+                                return "reasons." + error;
+                        }
+                    }
                     if (message.taskType != null && message.hasOwnProperty("taskType"))
                         if (!$util.isString(message.taskType))
                             return "taskType: string expected";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/flyteidl",
-  "version": "1.5.20",
+  "version": "1.5.22",
   "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
   "repository": {
     "type": "git",

package/protos/flyteidl/event/event.proto

@@ -154,6 +154,14 @@ message ParentNodeExecutionMetadata {
     string node_id = 1;
 }
 
+message EventReason {
+    // An explanation for this event
+    string reason = 1;
+
+    // The time this reason occurred
+    google.protobuf.Timestamp occurred_at = 2;
+}
+
 // Plugin specific execution event information. For tasks like Python, Hive, Spark, DynamicJob.
 message TaskExecutionEvent {
     // ID of the task. In combination with the retryAttempt this will indicate
@@ -180,7 +188,6 @@ message TaskExecutionEvent {
     // by the executor of the task.
     google.protobuf.Timestamp occurred_at = 7;
 
-
     oneof input_value {
       // URI of the input file, it encodes all the information
       // including Cloud source provider. ie., s3://...
@@ -211,8 +218,11 @@ message TaskExecutionEvent {
     uint32 phase_version = 12;
 
     // An optional explanation for the phase transition.
-    string reason = 13;
+    // Deprecated: Use reasons instead.
+    string reason = 13 [deprecated = true];
 
+    // An optional list of explanations for the phase transition.
+    repeated EventReason reasons = 21;
 
     // A predefined yet extensible Task type identifier. If the task definition is already registered in flyte admin
     // this type will be identical, but not all task executions necessarily use pre-registered definitions and this