@flyteorg/flyteidl 1.5.12 → 1.5.13

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

@@ -7585,6 +7585,88 @@ export namespace flyteidl {
             SUCCEEDED = 4
         }
 
+        /** Properties of a TaskExecutionMetadata. */
+        interface ITaskExecutionMetadata {
+
+            /** TaskExecutionMetadata taskExecutionId */
+            taskExecutionId?: (flyteidl.core.ITaskExecutionIdentifier|null);
+
+            /** TaskExecutionMetadata namespace */
+            namespace?: (string|null);
+
+            /** TaskExecutionMetadata labels */
+            labels?: ({ [k: string]: string }|null);
+
+            /** TaskExecutionMetadata annotations */
+            annotations?: ({ [k: string]: string }|null);
+
+            /** TaskExecutionMetadata k8sServiceAccount */
+            k8sServiceAccount?: (string|null);
+
+            /** TaskExecutionMetadata environmentVariables */
+            environmentVariables?: ({ [k: string]: string }|null);
+        }
+
+        /** Represents a TaskExecutionMetadata. */
+        class TaskExecutionMetadata implements ITaskExecutionMetadata {
+
+            /**
+             * Constructs a new TaskExecutionMetadata.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: flyteidl.admin.ITaskExecutionMetadata);
+
+            /** TaskExecutionMetadata taskExecutionId. */
+            public taskExecutionId?: (flyteidl.core.ITaskExecutionIdentifier|null);
+
+            /** TaskExecutionMetadata namespace. */
+            public namespace: string;
+
+            /** TaskExecutionMetadata labels. */
+            public labels: { [k: string]: string };
+
+            /** TaskExecutionMetadata annotations. */
+            public annotations: { [k: string]: string };
+
+            /** TaskExecutionMetadata k8sServiceAccount. */
+            public k8sServiceAccount: string;
+
+            /** TaskExecutionMetadata environmentVariables. */
+            public environmentVariables: { [k: string]: string };
+
+            /**
+             * Creates a new TaskExecutionMetadata instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns TaskExecutionMetadata instance
+             */
+            public static create(properties?: flyteidl.admin.ITaskExecutionMetadata): flyteidl.admin.TaskExecutionMetadata;
+
+            /**
+             * Encodes the specified TaskExecutionMetadata message. Does not implicitly {@link flyteidl.admin.TaskExecutionMetadata.verify|verify} messages.
+             * @param message TaskExecutionMetadata message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: flyteidl.admin.ITaskExecutionMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes a TaskExecutionMetadata message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns TaskExecutionMetadata
+             * @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.TaskExecutionMetadata;
+
+            /**
+             * Verifies a TaskExecutionMetadata 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 CreateTaskRequest. */
         interface ICreateTaskRequest {
 
@@ -7596,6 +7678,9 @@ export namespace flyteidl {
 
             /** CreateTaskRequest outputPrefix */
             outputPrefix?: (string|null);
+
+            /** CreateTaskRequest taskExecutionMetadata */
+            taskExecutionMetadata?: (flyteidl.admin.ITaskExecutionMetadata|null);
         }
 
         /** Represents a CreateTaskRequest. */
@@ -7616,6 +7701,9 @@ export namespace flyteidl {
             /** CreateTaskRequest outputPrefix. */
             public outputPrefix: string;
 
+            /** CreateTaskRequest taskExecutionMetadata. */
+            public taskExecutionMetadata?: (flyteidl.admin.ITaskExecutionMetadata|null);
+
             /**
              * Creates a new CreateTaskRequest instance using the specified properties.
              * @param [properties] Properties to set

package/gen/pb-js/flyteidl.js

@@ -18511,6 +18511,239 @@
                 return values;
             })();
     
+            admin.TaskExecutionMetadata = (function() {
+    
+                /**
+                 * Properties of a TaskExecutionMetadata.
+                 * @memberof flyteidl.admin
+                 * @interface ITaskExecutionMetadata
+                 * @property {flyteidl.core.ITaskExecutionIdentifier|null} [taskExecutionId] TaskExecutionMetadata taskExecutionId
+                 * @property {string|null} [namespace] TaskExecutionMetadata namespace
+                 * @property {Object.<string,string>|null} [labels] TaskExecutionMetadata labels
+                 * @property {Object.<string,string>|null} [annotations] TaskExecutionMetadata annotations
+                 * @property {string|null} [k8sServiceAccount] TaskExecutionMetadata k8sServiceAccount
+                 * @property {Object.<string,string>|null} [environmentVariables] TaskExecutionMetadata environmentVariables
+                 */
+    
+                /**
+                 * Constructs a new TaskExecutionMetadata.
+                 * @memberof flyteidl.admin
+                 * @classdesc Represents a TaskExecutionMetadata.
+                 * @implements ITaskExecutionMetadata
+                 * @constructor
+                 * @param {flyteidl.admin.ITaskExecutionMetadata=} [properties] Properties to set
+                 */
+                function TaskExecutionMetadata(properties) {
+                    this.labels = {};
+                    this.annotations = {};
+                    this.environmentVariables = {};
+                    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]];
+                }
+    
+                /**
+                 * TaskExecutionMetadata taskExecutionId.
+                 * @member {flyteidl.core.ITaskExecutionIdentifier|null|undefined} taskExecutionId
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @instance
+                 */
+                TaskExecutionMetadata.prototype.taskExecutionId = null;
+    
+                /**
+                 * TaskExecutionMetadata namespace.
+                 * @member {string} namespace
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @instance
+                 */
+                TaskExecutionMetadata.prototype.namespace = "";
+    
+                /**
+                 * TaskExecutionMetadata labels.
+                 * @member {Object.<string,string>} labels
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @instance
+                 */
+                TaskExecutionMetadata.prototype.labels = $util.emptyObject;
+    
+                /**
+                 * TaskExecutionMetadata annotations.
+                 * @member {Object.<string,string>} annotations
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @instance
+                 */
+                TaskExecutionMetadata.prototype.annotations = $util.emptyObject;
+    
+                /**
+                 * TaskExecutionMetadata k8sServiceAccount.
+                 * @member {string} k8sServiceAccount
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @instance
+                 */
+                TaskExecutionMetadata.prototype.k8sServiceAccount = "";
+    
+                /**
+                 * TaskExecutionMetadata environmentVariables.
+                 * @member {Object.<string,string>} environmentVariables
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @instance
+                 */
+                TaskExecutionMetadata.prototype.environmentVariables = $util.emptyObject;
+    
+                /**
+                 * Creates a new TaskExecutionMetadata instance using the specified properties.
+                 * @function create
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @static
+                 * @param {flyteidl.admin.ITaskExecutionMetadata=} [properties] Properties to set
+                 * @returns {flyteidl.admin.TaskExecutionMetadata} TaskExecutionMetadata instance
+                 */
+                TaskExecutionMetadata.create = function create(properties) {
+                    return new TaskExecutionMetadata(properties);
+                };
+    
+                /**
+                 * Encodes the specified TaskExecutionMetadata message. Does not implicitly {@link flyteidl.admin.TaskExecutionMetadata.verify|verify} messages.
+                 * @function encode
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @static
+                 * @param {flyteidl.admin.ITaskExecutionMetadata} message TaskExecutionMetadata message or plain object to encode
+                 * @param {$protobuf.Writer} [writer] Writer to encode to
+                 * @returns {$protobuf.Writer} Writer
+                 */
+                TaskExecutionMetadata.encode = function encode(message, writer) {
+                    if (!writer)
+                        writer = $Writer.create();
+                    if (message.taskExecutionId != null && message.hasOwnProperty("taskExecutionId"))
+                        $root.flyteidl.core.TaskExecutionIdentifier.encode(message.taskExecutionId, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
+                    if (message.namespace != null && message.hasOwnProperty("namespace"))
+                        writer.uint32(/* id 2, wireType 2 =*/18).string(message.namespace);
+                    if (message.labels != null && message.hasOwnProperty("labels"))
+                        for (var keys = Object.keys(message.labels), i = 0; i < keys.length; ++i)
+                            writer.uint32(/* id 3, wireType 2 =*/26).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.labels[keys[i]]).ldelim();
+                    if (message.annotations != null && message.hasOwnProperty("annotations"))
+                        for (var keys = Object.keys(message.annotations), i = 0; i < keys.length; ++i)
+                            writer.uint32(/* id 4, wireType 2 =*/34).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.annotations[keys[i]]).ldelim();
+                    if (message.k8sServiceAccount != null && message.hasOwnProperty("k8sServiceAccount"))
+                        writer.uint32(/* id 5, wireType 2 =*/42).string(message.k8sServiceAccount);
+                    if (message.environmentVariables != null && message.hasOwnProperty("environmentVariables"))
+                        for (var keys = Object.keys(message.environmentVariables), i = 0; i < keys.length; ++i)
+                            writer.uint32(/* id 6, wireType 2 =*/50).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.environmentVariables[keys[i]]).ldelim();
+                    return writer;
+                };
+    
+                /**
+                 * Decodes a TaskExecutionMetadata message from the specified reader or buffer.
+                 * @function decode
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @static
+                 * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                 * @param {number} [length] Message length if known beforehand
+                 * @returns {flyteidl.admin.TaskExecutionMetadata} TaskExecutionMetadata
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                TaskExecutionMetadata.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.TaskExecutionMetadata(), key;
+                    while (reader.pos < end) {
+                        var tag = reader.uint32();
+                        switch (tag >>> 3) {
+                        case 1:
+                            message.taskExecutionId = $root.flyteidl.core.TaskExecutionIdentifier.decode(reader, reader.uint32());
+                            break;
+                        case 2:
+                            message.namespace = reader.string();
+                            break;
+                        case 3:
+                            reader.skip().pos++;
+                            if (message.labels === $util.emptyObject)
+                                message.labels = {};
+                            key = reader.string();
+                            reader.pos++;
+                            message.labels[key] = reader.string();
+                            break;
+                        case 4:
+                            reader.skip().pos++;
+                            if (message.annotations === $util.emptyObject)
+                                message.annotations = {};
+                            key = reader.string();
+                            reader.pos++;
+                            message.annotations[key] = reader.string();
+                            break;
+                        case 5:
+                            message.k8sServiceAccount = reader.string();
+                            break;
+                        case 6:
+                            reader.skip().pos++;
+                            if (message.environmentVariables === $util.emptyObject)
+                                message.environmentVariables = {};
+                            key = reader.string();
+                            reader.pos++;
+                            message.environmentVariables[key] = reader.string();
+                            break;
+                        default:
+                            reader.skipType(tag & 7);
+                            break;
+                        }
+                    }
+                    return message;
+                };
+    
+                /**
+                 * Verifies a TaskExecutionMetadata message.
+                 * @function verify
+                 * @memberof flyteidl.admin.TaskExecutionMetadata
+                 * @static
+                 * @param {Object.<string,*>} message Plain object to verify
+                 * @returns {string|null} `null` if valid, otherwise the reason why it is not
+                 */
+                TaskExecutionMetadata.verify = function verify(message) {
+                    if (typeof message !== "object" || message === null)
+                        return "object expected";
+                    if (message.taskExecutionId != null && message.hasOwnProperty("taskExecutionId")) {
+                        var error = $root.flyteidl.core.TaskExecutionIdentifier.verify(message.taskExecutionId);
+                        if (error)
+                            return "taskExecutionId." + error;
+                    }
+                    if (message.namespace != null && message.hasOwnProperty("namespace"))
+                        if (!$util.isString(message.namespace))
+                            return "namespace: string expected";
+                    if (message.labels != null && message.hasOwnProperty("labels")) {
+                        if (!$util.isObject(message.labels))
+                            return "labels: object expected";
+                        var key = Object.keys(message.labels);
+                        for (var i = 0; i < key.length; ++i)
+                            if (!$util.isString(message.labels[key[i]]))
+                                return "labels: string{k:string} expected";
+                    }
+                    if (message.annotations != null && message.hasOwnProperty("annotations")) {
+                        if (!$util.isObject(message.annotations))
+                            return "annotations: object expected";
+                        var key = Object.keys(message.annotations);
+                        for (var i = 0; i < key.length; ++i)
+                            if (!$util.isString(message.annotations[key[i]]))
+                                return "annotations: string{k:string} expected";
+                    }
+                    if (message.k8sServiceAccount != null && message.hasOwnProperty("k8sServiceAccount"))
+                        if (!$util.isString(message.k8sServiceAccount))
+                            return "k8sServiceAccount: string expected";
+                    if (message.environmentVariables != null && message.hasOwnProperty("environmentVariables")) {
+                        if (!$util.isObject(message.environmentVariables))
+                            return "environmentVariables: object expected";
+                        var key = Object.keys(message.environmentVariables);
+                        for (var i = 0; i < key.length; ++i)
+                            if (!$util.isString(message.environmentVariables[key[i]]))
+                                return "environmentVariables: string{k:string} expected";
+                    }
+                    return null;
+                };
+    
+                return TaskExecutionMetadata;
+            })();
+    
             admin.CreateTaskRequest = (function() {
     
                 /**
@@ -18520,6 +18753,7 @@
                  * @property {flyteidl.core.ILiteralMap|null} [inputs] CreateTaskRequest inputs
                  * @property {flyteidl.core.ITaskTemplate|null} [template] CreateTaskRequest template
                  * @property {string|null} [outputPrefix] CreateTaskRequest outputPrefix
+                 * @property {flyteidl.admin.ITaskExecutionMetadata|null} [taskExecutionMetadata] CreateTaskRequest taskExecutionMetadata
                  */
     
                 /**
@@ -18561,6 +18795,14 @@
                  */
                 CreateTaskRequest.prototype.outputPrefix = "";
     
+                /**
+                 * CreateTaskRequest taskExecutionMetadata.
+                 * @member {flyteidl.admin.ITaskExecutionMetadata|null|undefined} taskExecutionMetadata
+                 * @memberof flyteidl.admin.CreateTaskRequest
+                 * @instance
+                 */
+                CreateTaskRequest.prototype.taskExecutionMetadata = null;
+    
                 /**
                  * Creates a new CreateTaskRequest instance using the specified properties.
                  * @function create
@@ -18591,6 +18833,8 @@
                         $root.flyteidl.core.TaskTemplate.encode(message.template, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
                     if (message.outputPrefix != null && message.hasOwnProperty("outputPrefix"))
                         writer.uint32(/* id 3, wireType 2 =*/26).string(message.outputPrefix);
+                    if (message.taskExecutionMetadata != null && message.hasOwnProperty("taskExecutionMetadata"))
+                        $root.flyteidl.admin.TaskExecutionMetadata.encode(message.taskExecutionMetadata, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim();
                     return writer;
                 };
     
@@ -18621,6 +18865,9 @@
                         case 3:
                             message.outputPrefix = reader.string();
                             break;
+                        case 4:
+                            message.taskExecutionMetadata = $root.flyteidl.admin.TaskExecutionMetadata.decode(reader, reader.uint32());
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -18653,6 +18900,11 @@
                     if (message.outputPrefix != null && message.hasOwnProperty("outputPrefix"))
                         if (!$util.isString(message.outputPrefix))
                             return "outputPrefix: string expected";
+                    if (message.taskExecutionMetadata != null && message.hasOwnProperty("taskExecutionMetadata")) {
+                        var error = $root.flyteidl.admin.TaskExecutionMetadata.verify(message.taskExecutionMetadata);
+                        if (error)
+                            return "taskExecutionMetadata." + error;
+                    }
                     return null;
                 };
     

package/package.json

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

package/protos/flyteidl/admin/agent.proto

@@ -6,6 +6,7 @@ option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
 import "flyteidl/core/literals.proto";
 import "flyteidl/core/tasks.proto";
 import "flyteidl/core/interface.proto";
+import "flyteidl/core/identifier.proto";
 
 // The state of the execution is used to control its visibility in the UI/CLI.
 enum State {
@@ -16,6 +17,22 @@ enum State {
   SUCCEEDED = 4;
 }
 
+// Represents a subset of runtime task execution metadata that are relevant to external plugins.
+message TaskExecutionMetadata {
+  // ID of the task execution
+  core.TaskExecutionIdentifier task_execution_id = 1;
+  // k8s namespace where the task is executed in
+  string namespace = 2;
+  // Labels attached to the task execution
+  map<string, string> labels = 3;
+  // Annotations attached to the task execution
+  map<string, string> annotations = 4;
+  // k8s service account associated with the task execution
+  string k8s_service_account = 5;
+  // Environment variables attached to the task execution
+  map<string, string> environment_variables = 6;
+}
+
 // Represents a request structure to create task.
 message CreateTaskRequest {
   // The inputs required to start the execution. All required inputs must be
@@ -26,6 +43,8 @@ message CreateTaskRequest {
   core.TaskTemplate template = 2;
   // Prefix for where task output data will be written. (e.g. s3://my-bucket/randomstring)
   string output_prefix = 3;
+  // subset of runtime task execution metadata.
+  TaskExecutionMetadata task_execution_metadata = 4;
 }
 
 // Represents a create response structure.