@flyteorg/flyteidl 1.5.2 → 1.5.4

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

@@ -8782,6 +8782,58 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
+        /** Properties of an Envs. */
+        interface IEnvs {
+
+            /** Envs values */
+            values?: (flyteidl.core.IKeyValuePair[]|null);
+        }
+
+        /** Represents an Envs. */
+        class Envs implements IEnvs {
+
+            /**
+             * Constructs a new Envs.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: flyteidl.admin.IEnvs);
+
+            /** Envs values. */
+            public values: flyteidl.core.IKeyValuePair[];
+
+            /**
+             * Creates a new Envs instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns Envs instance
+             */
+            public static create(properties?: flyteidl.admin.IEnvs): flyteidl.admin.Envs;
+
+            /**
+             * Encodes the specified Envs message. Does not implicitly {@link flyteidl.admin.Envs.verify|verify} messages.
+             * @param message Envs message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: flyteidl.admin.IEnvs, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes an Envs message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns Envs
+             * @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.Envs;
+
+            /**
+             * Verifies an Envs 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 an AuthRole. */
         interface IAuthRole {
 
@@ -10716,6 +10768,9 @@ export namespace flyteidl {
 
             /** ExecutionSpec overwriteCache */
             overwriteCache?: (boolean|null);
+
+            /** ExecutionSpec envs */
+            envs?: (flyteidl.admin.IEnvs|null);
         }
 
         /** Represents an ExecutionSpec. */
@@ -10772,6 +10827,9 @@ export namespace flyteidl {
             /** ExecutionSpec overwriteCache. */
             public overwriteCache: boolean;
 
+            /** ExecutionSpec envs. */
+            public envs?: (flyteidl.admin.IEnvs|null);
+
             /** ExecutionSpec notificationOverrides. */
             public notificationOverrides?: ("notifications"|"disableAll");
 
@@ -11655,6 +11713,9 @@ export namespace flyteidl {
 
             /** LaunchPlanSpec overwriteCache */
             overwriteCache?: (boolean|null);
+
+            /** LaunchPlanSpec envs */
+            envs?: (flyteidl.admin.IEnvs|null);
         }
 
         /** Represents a LaunchPlanSpec. */
@@ -11711,6 +11772,9 @@ export namespace flyteidl {
             /** LaunchPlanSpec overwriteCache. */
             public overwriteCache: boolean;
 
+            /** LaunchPlanSpec envs. */
+            public envs?: (flyteidl.admin.IEnvs|null);
+
             /**
              * Creates a new LaunchPlanSpec instance using the specified properties.
              * @param [properties] Properties to set
@@ -12756,6 +12820,9 @@ export namespace flyteidl {
 
             /** WorkflowExecutionConfig overwriteCache */
             overwriteCache?: (boolean|null);
+
+            /** WorkflowExecutionConfig envs */
+            envs?: (flyteidl.admin.IEnvs|null);
         }
 
         /** Represents a WorkflowExecutionConfig. */
@@ -12788,6 +12855,9 @@ export namespace flyteidl {
             /** WorkflowExecutionConfig overwriteCache. */
             public overwriteCache: boolean;
 
+            /** WorkflowExecutionConfig envs. */
+            public envs?: (flyteidl.admin.IEnvs|null);
+
             /**
              * Creates a new WorkflowExecutionConfig instance using the specified properties.
              * @param [properties] Properties to set

package/gen/pb-js/flyteidl.js

@@ -21310,6 +21310,126 @@
                 return Annotations;
             })();
     
+            admin.Envs = (function() {
+    
+                /**
+                 * Properties of an Envs.
+                 * @memberof flyteidl.admin
+                 * @interface IEnvs
+                 * @property {Array.<flyteidl.core.IKeyValuePair>|null} [values] Envs values
+                 */
+    
+                /**
+                 * Constructs a new Envs.
+                 * @memberof flyteidl.admin
+                 * @classdesc Represents an Envs.
+                 * @implements IEnvs
+                 * @constructor
+                 * @param {flyteidl.admin.IEnvs=} [properties] Properties to set
+                 */
+                function Envs(properties) {
+                    this.values = [];
+                    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]];
+                }
+    
+                /**
+                 * Envs values.
+                 * @member {Array.<flyteidl.core.IKeyValuePair>} values
+                 * @memberof flyteidl.admin.Envs
+                 * @instance
+                 */
+                Envs.prototype.values = $util.emptyArray;
+    
+                /**
+                 * Creates a new Envs instance using the specified properties.
+                 * @function create
+                 * @memberof flyteidl.admin.Envs
+                 * @static
+                 * @param {flyteidl.admin.IEnvs=} [properties] Properties to set
+                 * @returns {flyteidl.admin.Envs} Envs instance
+                 */
+                Envs.create = function create(properties) {
+                    return new Envs(properties);
+                };
+    
+                /**
+                 * Encodes the specified Envs message. Does not implicitly {@link flyteidl.admin.Envs.verify|verify} messages.
+                 * @function encode
+                 * @memberof flyteidl.admin.Envs
+                 * @static
+                 * @param {flyteidl.admin.IEnvs} message Envs message or plain object to encode
+                 * @param {$protobuf.Writer} [writer] Writer to encode to
+                 * @returns {$protobuf.Writer} Writer
+                 */
+                Envs.encode = function encode(message, writer) {
+                    if (!writer)
+                        writer = $Writer.create();
+                    if (message.values != null && message.values.length)
+                        for (var i = 0; i < message.values.length; ++i)
+                            $root.flyteidl.core.KeyValuePair.encode(message.values[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
+                    return writer;
+                };
+    
+                /**
+                 * Decodes an Envs message from the specified reader or buffer.
+                 * @function decode
+                 * @memberof flyteidl.admin.Envs
+                 * @static
+                 * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                 * @param {number} [length] Message length if known beforehand
+                 * @returns {flyteidl.admin.Envs} Envs
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                Envs.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.Envs();
+                    while (reader.pos < end) {
+                        var tag = reader.uint32();
+                        switch (tag >>> 3) {
+                        case 1:
+                            if (!(message.values && message.values.length))
+                                message.values = [];
+                            message.values.push($root.flyteidl.core.KeyValuePair.decode(reader, reader.uint32()));
+                            break;
+                        default:
+                            reader.skipType(tag & 7);
+                            break;
+                        }
+                    }
+                    return message;
+                };
+    
+                /**
+                 * Verifies an Envs message.
+                 * @function verify
+                 * @memberof flyteidl.admin.Envs
+                 * @static
+                 * @param {Object.<string,*>} message Plain object to verify
+                 * @returns {string|null} `null` if valid, otherwise the reason why it is not
+                 */
+                Envs.verify = function verify(message) {
+                    if (typeof message !== "object" || message === null)
+                        return "object expected";
+                    if (message.values != null && message.hasOwnProperty("values")) {
+                        if (!Array.isArray(message.values))
+                            return "values: array expected";
+                        for (var i = 0; i < message.values.length; ++i) {
+                            var error = $root.flyteidl.core.KeyValuePair.verify(message.values[i]);
+                            if (error)
+                                return "values." + error;
+                        }
+                    }
+                    return null;
+                };
+    
+                return Envs;
+            })();
+    
             admin.AuthRole = (function() {
     
                 /**
@@ -25764,6 +25884,7 @@
                  * @property {flyteidl.admin.IClusterAssignment|null} [clusterAssignment] ExecutionSpec clusterAssignment
                  * @property {google.protobuf.IBoolValue|null} [interruptible] ExecutionSpec interruptible
                  * @property {boolean|null} [overwriteCache] ExecutionSpec overwriteCache
+                 * @property {flyteidl.admin.IEnvs|null} [envs] ExecutionSpec envs
                  */
     
                 /**
@@ -25901,6 +26022,14 @@
                  */
                 ExecutionSpec.prototype.overwriteCache = false;
     
+                /**
+                 * ExecutionSpec envs.
+                 * @member {flyteidl.admin.IEnvs|null|undefined} envs
+                 * @memberof flyteidl.admin.ExecutionSpec
+                 * @instance
+                 */
+                ExecutionSpec.prototype.envs = null;
+    
                 // OneOf field names bound to virtual getters and setters
                 var $oneOfFields;
     
@@ -25969,6 +26098,8 @@
                         $root.google.protobuf.BoolValue.encode(message.interruptible, writer.uint32(/* id 21, wireType 2 =*/170).fork()).ldelim();
                     if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
                         writer.uint32(/* id 22, wireType 0 =*/176).bool(message.overwriteCache);
+                    if (message.envs != null && message.hasOwnProperty("envs"))
+                        $root.flyteidl.admin.Envs.encode(message.envs, writer.uint32(/* id 23, wireType 2 =*/186).fork()).ldelim();
                     return writer;
                 };
     
@@ -26035,6 +26166,9 @@
                         case 22:
                             message.overwriteCache = reader.bool();
                             break;
+                        case 23:
+                            message.envs = $root.flyteidl.admin.Envs.decode(reader, reader.uint32());
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -26131,6 +26265,11 @@
                     if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
                         if (typeof message.overwriteCache !== "boolean")
                             return "overwriteCache: boolean expected";
+                    if (message.envs != null && message.hasOwnProperty("envs")) {
+                        var error = $root.flyteidl.admin.Envs.verify(message.envs);
+                        if (error)
+                            return "envs." + error;
+                    }
                     return null;
                 };
     
@@ -27946,6 +28085,7 @@
                  * @property {number|null} [maxParallelism] LaunchPlanSpec maxParallelism
                  * @property {google.protobuf.IBoolValue|null} [interruptible] LaunchPlanSpec interruptible
                  * @property {boolean|null} [overwriteCache] LaunchPlanSpec overwriteCache
+                 * @property {flyteidl.admin.IEnvs|null} [envs] LaunchPlanSpec envs
                  */
     
                 /**
@@ -28083,6 +28223,14 @@
                  */
                 LaunchPlanSpec.prototype.overwriteCache = false;
     
+                /**
+                 * LaunchPlanSpec envs.
+                 * @member {flyteidl.admin.IEnvs|null|undefined} envs
+                 * @memberof flyteidl.admin.LaunchPlanSpec
+                 * @instance
+                 */
+                LaunchPlanSpec.prototype.envs = null;
+    
                 /**
                  * Creates a new LaunchPlanSpec instance using the specified properties.
                  * @function create
@@ -28137,6 +28285,8 @@
                         $root.google.protobuf.BoolValue.encode(message.interruptible, writer.uint32(/* id 19, wireType 2 =*/154).fork()).ldelim();
                     if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
                         writer.uint32(/* id 20, wireType 0 =*/160).bool(message.overwriteCache);
+                    if (message.envs != null && message.hasOwnProperty("envs"))
+                        $root.flyteidl.admin.Envs.encode(message.envs, writer.uint32(/* id 21, wireType 2 =*/170).fork()).ldelim();
                     return writer;
                 };
     
@@ -28203,6 +28353,9 @@
                         case 20:
                             message.overwriteCache = reader.bool();
                             break;
+                        case 21:
+                            message.envs = $root.flyteidl.admin.Envs.decode(reader, reader.uint32());
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -28291,6 +28444,11 @@
                     if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
                         if (typeof message.overwriteCache !== "boolean")
                             return "overwriteCache: boolean expected";
+                    if (message.envs != null && message.hasOwnProperty("envs")) {
+                        var error = $root.flyteidl.admin.Envs.verify(message.envs);
+                        if (error)
+                            return "envs." + error;
+                    }
                     return null;
                 };
     
@@ -30603,6 +30761,7 @@
                  * @property {flyteidl.admin.IAnnotations|null} [annotations] WorkflowExecutionConfig annotations
                  * @property {google.protobuf.IBoolValue|null} [interruptible] WorkflowExecutionConfig interruptible
                  * @property {boolean|null} [overwriteCache] WorkflowExecutionConfig overwriteCache
+                 * @property {flyteidl.admin.IEnvs|null} [envs] WorkflowExecutionConfig envs
                  */
     
                 /**
@@ -30676,6 +30835,14 @@
                  */
                 WorkflowExecutionConfig.prototype.overwriteCache = false;
     
+                /**
+                 * WorkflowExecutionConfig envs.
+                 * @member {flyteidl.admin.IEnvs|null|undefined} envs
+                 * @memberof flyteidl.admin.WorkflowExecutionConfig
+                 * @instance
+                 */
+                WorkflowExecutionConfig.prototype.envs = null;
+    
                 /**
                  * Creates a new WorkflowExecutionConfig instance using the specified properties.
                  * @function create
@@ -30714,6 +30881,8 @@
                         $root.google.protobuf.BoolValue.encode(message.interruptible, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
                     if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
                         writer.uint32(/* id 7, wireType 0 =*/56).bool(message.overwriteCache);
+                    if (message.envs != null && message.hasOwnProperty("envs"))
+                        $root.flyteidl.admin.Envs.encode(message.envs, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim();
                     return writer;
                 };
     
@@ -30756,6 +30925,9 @@
                         case 7:
                             message.overwriteCache = reader.bool();
                             break;
+                        case 8:
+                            message.envs = $root.flyteidl.admin.Envs.decode(reader, reader.uint32());
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -30806,6 +30978,11 @@
                     if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
                         if (typeof message.overwriteCache !== "boolean")
                             return "overwriteCache: boolean expected";
+                    if (message.envs != null && message.hasOwnProperty("envs")) {
+                        var error = $root.flyteidl.admin.Envs.verify(message.envs);
+                        if (error)
+                            return "envs." + error;
+                    }
                     return null;
                 };
     

package/package.json

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

package/protos/flyteidl/admin/common.proto

@@ -5,6 +5,7 @@ option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
 
 import "flyteidl/core/execution.proto";
 import "flyteidl/core/identifier.proto";
+import "flyteidl/core/literals.proto";
 import "google/protobuf/timestamp.proto";
 
 // Encapsulation of fields that identifies a Flyte resource.
@@ -280,6 +281,14 @@ message Annotations {
     map<string, string> values = 1;
 }
 
+// Environment variable values to be applied to an execution resource.
+// In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined
+// to specify how to merge environment variables defined at registration and execution time.
+message Envs {
+    // Map of custom environment variables to be applied to the execution resource.
+    repeated flyteidl.core.KeyValuePair values = 1;
+}
+
 // Defines permissions associated with executions created by this launch plan spec.
 // Use either of these roles when they have permissions required by your workflow execution.
 // Deprecated.

package/protos/flyteidl/admin/execution.proto

@@ -310,6 +310,9 @@ message ExecutionSpec {
     // If enabled, all calculations are performed even if cached results would be available, overwriting the stored
     // data once execution finishes successfully.
     bool overwrite_cache = 22;
+
+    // Environment variables to be set for the execution.
+    Envs envs = 23;
 }
 
 // Request to terminate an in-progress execution.  This action is irreversible.

package/protos/flyteidl/admin/launch_plan.proto

@@ -130,6 +130,9 @@ message LaunchPlanSpec {
     // If enabled, all calculations are performed even if cached results would be available, overwriting the stored
     // data once execution finishes successfully.
     bool overwrite_cache = 20;
+
+    // Environment variables to be set for the execution.
+    Envs envs = 21;
 }
 
 // Values computed by the flyte platform after launch plan registration.

package/protos/flyteidl/admin/matchable_resource.proto

@@ -128,6 +128,9 @@ message WorkflowExecutionConfig {
   // If enabled, all calculations are performed even if cached results would be available, overwriting the stored
   // data once execution finishes successfully.
   bool overwrite_cache = 7;
+
+  // Environment variables to be set for the execution.
+  Envs envs = 8;
 }
 
 // Generic container for encapsulating all types of the above attributes messages.