@flyteorg/flyteidl 1.3.12 → 1.3.13

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

@@ -15907,6 +15907,9 @@ export namespace flyteidl {
 
             /** TaskExecutionClosure eventVersion */
             eventVersion?: (number|null);
+
+            /** TaskExecutionClosure reasons */
+            reasons?: (flyteidl.admin.IReason[]|null);
         }
 
         /** Represents a TaskExecutionClosure. */
@@ -15960,6 +15963,9 @@ export namespace flyteidl {
             /** TaskExecutionClosure eventVersion. */
             public eventVersion: number;
 
+            /** TaskExecutionClosure reasons. */
+            public reasons: flyteidl.admin.IReason[];
+
             /** TaskExecutionClosure outputResult. */
             public outputResult?: ("outputUri"|"error"|"outputData");
 
@@ -15996,6 +16002,64 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
+        /** Properties of a Reason. */
+        interface IReason {
+
+            /** Reason occurredAt */
+            occurredAt?: (google.protobuf.ITimestamp|null);
+
+            /** Reason message */
+            message?: (string|null);
+        }
+
+        /** Represents a Reason. */
+        class Reason implements IReason {
+
+            /**
+             * Constructs a new Reason.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: flyteidl.admin.IReason);
+
+            /** Reason occurredAt. */
+            public occurredAt?: (google.protobuf.ITimestamp|null);
+
+            /** Reason message. */
+            public message: string;
+
+            /**
+             * Creates a new Reason instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns Reason instance
+             */
+            public static create(properties?: flyteidl.admin.IReason): flyteidl.admin.Reason;
+
+            /**
+             * Encodes the specified Reason message. Does not implicitly {@link flyteidl.admin.Reason.verify|verify} messages.
+             * @param message Reason message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: flyteidl.admin.IReason, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes a Reason message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns Reason
+             * @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.admin.Reason;
+
+            /**
+             * Verifies a Reason 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 TaskExecutionGetDataRequest. */
         interface ITaskExecutionGetDataRequest {
 

package/gen/pb-js/flyteidl.js

@@ -37889,6 +37889,7 @@
                  * @property {string|null} [taskType] TaskExecutionClosure taskType
                  * @property {flyteidl.event.ITaskExecutionMetadata|null} [metadata] TaskExecutionClosure metadata
                  * @property {number|null} [eventVersion] TaskExecutionClosure eventVersion
+                 * @property {Array.<flyteidl.admin.IReason>|null} [reasons] TaskExecutionClosure reasons
                  */
     
                 /**
@@ -37901,6 +37902,7 @@
                  */
                 function TaskExecutionClosure(properties) {
                     this.logs = [];
+                    this.reasons = [];
                     if (properties)
                         for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
                             if (properties[keys[i]] != null)
@@ -38019,6 +38021,14 @@
                  */
                 TaskExecutionClosure.prototype.eventVersion = 0;
     
+                /**
+                 * TaskExecutionClosure reasons.
+                 * @member {Array.<flyteidl.admin.IReason>} reasons
+                 * @memberof flyteidl.admin.TaskExecutionClosure
+                 * @instance
+                 */
+                TaskExecutionClosure.prototype.reasons = $util.emptyArray;
+    
                 // OneOf field names bound to virtual getters and setters
                 var $oneOfFields;
     
@@ -38086,6 +38096,9 @@
                         $root.flyteidl.event.TaskExecutionMetadata.encode(message.metadata, writer.uint32(/* id 16, wireType 2 =*/130).fork()).ldelim();
                     if (message.eventVersion != null && message.hasOwnProperty("eventVersion"))
                         writer.uint32(/* id 17, wireType 0 =*/136).int32(message.eventVersion);
+                    if (message.reasons != null && message.reasons.length)
+                        for (var i = 0; i < message.reasons.length; ++i)
+                            $root.flyteidl.admin.Reason.encode(message.reasons[i], writer.uint32(/* id 18, wireType 2 =*/146).fork()).ldelim();
                     return writer;
                 };
     
@@ -38151,6 +38164,11 @@
                         case 17:
                             message.eventVersion = reader.int32();
                             break;
+                        case 18:
+                            if (!(message.reasons && message.reasons.length))
+                                message.reasons = [];
+                            message.reasons.push($root.flyteidl.admin.Reason.decode(reader, reader.uint32()));
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -38258,12 +38276,150 @@
                     if (message.eventVersion != null && message.hasOwnProperty("eventVersion"))
                         if (!$util.isInteger(message.eventVersion))
                             return "eventVersion: integer 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.admin.Reason.verify(message.reasons[i]);
+                            if (error)
+                                return "reasons." + error;
+                        }
+                    }
                     return null;
                 };
     
                 return TaskExecutionClosure;
             })();
     
+            admin.Reason = (function() {
+    
+                /**
+                 * Properties of a Reason.
+                 * @memberof flyteidl.admin
+                 * @interface IReason
+                 * @property {google.protobuf.ITimestamp|null} [occurredAt] Reason occurredAt
+                 * @property {string|null} [message] Reason message
+                 */
+    
+                /**
+                 * Constructs a new Reason.
+                 * @memberof flyteidl.admin
+                 * @classdesc Represents a Reason.
+                 * @implements IReason
+                 * @constructor
+                 * @param {flyteidl.admin.IReason=} [properties] Properties to set
+                 */
+                function Reason(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]];
+                }
+    
+                /**
+                 * Reason occurredAt.
+                 * @member {google.protobuf.ITimestamp|null|undefined} occurredAt
+                 * @memberof flyteidl.admin.Reason
+                 * @instance
+                 */
+                Reason.prototype.occurredAt = null;
+    
+                /**
+                 * Reason message.
+                 * @member {string} message
+                 * @memberof flyteidl.admin.Reason
+                 * @instance
+                 */
+                Reason.prototype.message = "";
+    
+                /**
+                 * Creates a new Reason instance using the specified properties.
+                 * @function create
+                 * @memberof flyteidl.admin.Reason
+                 * @static
+                 * @param {flyteidl.admin.IReason=} [properties] Properties to set
+                 * @returns {flyteidl.admin.Reason} Reason instance
+                 */
+                Reason.create = function create(properties) {
+                    return new Reason(properties);
+                };
+    
+                /**
+                 * Encodes the specified Reason message. Does not implicitly {@link flyteidl.admin.Reason.verify|verify} messages.
+                 * @function encode
+                 * @memberof flyteidl.admin.Reason
+                 * @static
+                 * @param {flyteidl.admin.IReason} message Reason message or plain object to encode
+                 * @param {$protobuf.Writer} [writer] Writer to encode to
+                 * @returns {$protobuf.Writer} Writer
+                 */
+                Reason.encode = function encode(message, writer) {
+                    if (!writer)
+                        writer = $Writer.create();
+                    if (message.occurredAt != null && message.hasOwnProperty("occurredAt"))
+                        $root.google.protobuf.Timestamp.encode(message.occurredAt, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
+                    if (message.message != null && message.hasOwnProperty("message"))
+                        writer.uint32(/* id 2, wireType 2 =*/18).string(message.message);
+                    return writer;
+                };
+    
+                /**
+                 * Decodes a Reason message from the specified reader or buffer.
+                 * @function decode
+                 * @memberof flyteidl.admin.Reason
+                 * @static
+                 * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                 * @param {number} [length] Message length if known beforehand
+                 * @returns {flyteidl.admin.Reason} Reason
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                Reason.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.admin.Reason();
+                    while (reader.pos < end) {
+                        var tag = reader.uint32();
+                        switch (tag >>> 3) {
+                        case 1:
+                            message.occurredAt = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
+                            break;
+                        case 2:
+                            message.message = reader.string();
+                            break;
+                        default:
+                            reader.skipType(tag & 7);
+                            break;
+                        }
+                    }
+                    return message;
+                };
+    
+                /**
+                 * Verifies a Reason message.
+                 * @function verify
+                 * @memberof flyteidl.admin.Reason
+                 * @static
+                 * @param {Object.<string,*>} message Plain object to verify
+                 * @returns {string|null} `null` if valid, otherwise the reason why it is not
+                 */
+                Reason.verify = function verify(message) {
+                    if (typeof message !== "object" || message === null)
+                        return "object expected";
+                    if (message.occurredAt != null && message.hasOwnProperty("occurredAt")) {
+                        var error = $root.google.protobuf.Timestamp.verify(message.occurredAt);
+                        if (error)
+                            return "occurredAt." + error;
+                    }
+                    if (message.message != null && message.hasOwnProperty("message"))
+                        if (!$util.isString(message.message))
+                            return "message: string expected";
+                    return null;
+                };
+    
+                return Reason;
+            })();
+    
             admin.TaskExecutionGetDataRequest = (function() {
     
                 /**

package/package.json

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

package/protos/flyteidl/admin/task_execution.proto

@@ -123,6 +123,19 @@ message TaskExecutionClosure {
     // TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog
     // in this message.
     int32 event_version = 17;
+
+    // A time-series of the phase transition or update explanations. This, when compared to storing a singular reason
+    // as previously done, is much more valuable in visualizing and understanding historical evaluations.
+    repeated Reason reasons = 18;
+}
+
+// Reason is a single message annotated with a timestamp to indicate the instant the reason occurred.
+message Reason {
+    // occurred_at is the timestamp indicating the instant that this reason happened.
+    google.protobuf.Timestamp occurred_at = 1;
+
+    // message is the explanation for the most recent phase transition or status update.
+    string message = 2;
 }
 
 // Request structure to fetch inputs and output for a task execution.