@flyteorg/flyteidl 0.24.10 → 0.24.13

package/README.md

@@ -1,31 +1,32 @@
-# Flyte IDL
+# 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).
 
-This is one of the core repositories of Flyte and contains the Specification of the Flyte Lanugage using protobuf messages, the Backend API specification in gRPC and Swagger REST. The repo contains 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 API's (the services grouped under Flyteadmin).
 
 [![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)
 
 * [flyte.org](https://flyte.org)
 * [Flyte Docs](http://docs.flyte.org)
-* [FlyteIDL API reference documentation](https://docs.flyte.org/projects/flyteidl/en/stable/index.html)
+* [Flyteidl API reference documentation](https://docs.flyte.org/projects/flyteidl/en/stable/index.html)
 
-## Contributing to FlyteIDL
+## Contributing to Flyteidl
 
-## Tooling for FlyteIDL
+## Tooling for Flyteidl
 
-1. Run ``make download_tooling`` to install generator dependencies
+1. Run ``make download_tooling`` to install generator dependencies.
 
 ```bash
    make download_tooling
 ```
 
-2. Make sure docker is installed locally.
-3. Once installed, run ``make generate`` to generate all the code and mock client for FlyteAdmin Service aswell as the docs for it.
+2. Ensure Docker is installed locally.
+3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
 
 ```bash
     make generate
 ```
 
-4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and then
+4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
 
 ```bash
    make doc-requirements.txt
@@ -33,8 +34,8 @@ This is one of the core repositories of Flyte and contains the Specification of
 
 ## Docs structure
 
-The index.rst files for protos are kept in parallel folder structure under the docs folder.
-All the proto definitions are within protos/flyteidl and there corresponding docs are kept in protos/docs
+The index.rst files for protos are arranged in parallel under the ``docs`` folder.
+All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
 
 ```
 docs
@@ -58,13 +59,13 @@ docs
 │   └── service.rst
 ```
 
-Each module in protos has same named module under the docs also.
-eg : protos/flyteidl/core has same named doc structure placing it index and other documentation files in protos/docs/core
+Each module in protos has a module in docs with the same name.
+For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
 
 
-## Docs Generation
+## Generating Documentation
 
-* If introducing a new module then follow the structure for core files in `generate_protos.sh` file which helps in generating the core documentation from its proto files.
+* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
 ```
      core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
      # Remove any currently generated file
@@ -72,7 +73,7 @@ eg : protos/flyteidl/core has same named doc structure placing it index and othe
      protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
 ```
 
-* ``make generate`` would have already generated the modified rst files.
+* ``make generate`` generates the modified rst files.
 
-* ``make html`` Generate the sphinx documentation from the docs folder to use the modified rst for docs.
+* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
 

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

@@ -7021,6 +7021,9 @@ export namespace flyteidl {
 
             /** ClusterAssignment affinity */
             affinity?: (flyteidl.admin.IAffinity|null);
+
+            /** ClusterAssignment toleration */
+            toleration?: (flyteidl.admin.IToleration|null);
         }
 
         /** Represents a ClusterAssignment. */
@@ -7035,6 +7038,9 @@ export namespace flyteidl {
             /** ClusterAssignment affinity. */
             public affinity?: (flyteidl.admin.IAffinity|null);
 
+            /** ClusterAssignment toleration. */
+            public toleration?: (flyteidl.admin.IToleration|null);
+
             /**
              * Creates a new ClusterAssignment instance using the specified properties.
              * @param [properties] Properties to set
@@ -7120,6 +7126,58 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
+        /** Properties of a Toleration. */
+        interface IToleration {
+
+            /** Toleration selectors */
+            selectors?: (flyteidl.admin.ISelector[]|null);
+        }
+
+        /** Represents a Toleration. */
+        class Toleration implements IToleration {
+
+            /**
+             * Constructs a new Toleration.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: flyteidl.admin.IToleration);
+
+            /** Toleration selectors. */
+            public selectors: flyteidl.admin.ISelector[];
+
+            /**
+             * Creates a new Toleration instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns Toleration instance
+             */
+            public static create(properties?: flyteidl.admin.IToleration): flyteidl.admin.Toleration;
+
+            /**
+             * Encodes the specified Toleration message. Does not implicitly {@link flyteidl.admin.Toleration.verify|verify} messages.
+             * @param message Toleration message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: flyteidl.admin.IToleration, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes a Toleration message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns Toleration
+             * @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.Toleration;
+
+            /**
+             * Verifies a Toleration 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 Selector. */
         interface ISelector {
 

package/gen/pb-js/flyteidl.js

@@ -17006,6 +17006,7 @@ export const flyteidl = $root.flyteidl = (() => {
              * @memberof flyteidl.admin
              * @interface IClusterAssignment
              * @property {flyteidl.admin.IAffinity|null} [affinity] ClusterAssignment affinity
+             * @property {flyteidl.admin.IToleration|null} [toleration] ClusterAssignment toleration
              */
 
             /**
@@ -17031,6 +17032,14 @@ export const flyteidl = $root.flyteidl = (() => {
              */
             ClusterAssignment.prototype.affinity = null;
 
+            /**
+             * ClusterAssignment toleration.
+             * @member {flyteidl.admin.IToleration|null|undefined} toleration
+             * @memberof flyteidl.admin.ClusterAssignment
+             * @instance
+             */
+            ClusterAssignment.prototype.toleration = null;
+
             /**
              * Creates a new ClusterAssignment instance using the specified properties.
              * @function create
@@ -17057,6 +17066,8 @@ export const flyteidl = $root.flyteidl = (() => {
                     writer = $Writer.create();
                 if (message.affinity != null && message.hasOwnProperty("affinity"))
                     $root.flyteidl.admin.Affinity.encode(message.affinity, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
+                if (message.toleration != null && message.hasOwnProperty("toleration"))
+                    $root.flyteidl.admin.Toleration.encode(message.toleration, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
                 return writer;
             };
 
@@ -17081,6 +17092,9 @@ export const flyteidl = $root.flyteidl = (() => {
                     case 1:
                         message.affinity = $root.flyteidl.admin.Affinity.decode(reader, reader.uint32());
                         break;
+                    case 2:
+                        message.toleration = $root.flyteidl.admin.Toleration.decode(reader, reader.uint32());
+                        break;
                     default:
                         reader.skipType(tag & 7);
                         break;
@@ -17105,6 +17119,11 @@ export const flyteidl = $root.flyteidl = (() => {
                     if (error)
                         return "affinity." + error;
                 }
+                if (message.toleration != null && message.hasOwnProperty("toleration")) {
+                    let error = $root.flyteidl.admin.Toleration.verify(message.toleration);
+                    if (error)
+                        return "toleration." + error;
+                }
                 return null;
             };
 
@@ -17231,6 +17250,126 @@ export const flyteidl = $root.flyteidl = (() => {
             return Affinity;
         })();
 
+        admin.Toleration = (function() {
+
+            /**
+             * Properties of a Toleration.
+             * @memberof flyteidl.admin
+             * @interface IToleration
+             * @property {Array.<flyteidl.admin.ISelector>|null} [selectors] Toleration selectors
+             */
+
+            /**
+             * Constructs a new Toleration.
+             * @memberof flyteidl.admin
+             * @classdesc Represents a Toleration.
+             * @implements IToleration
+             * @constructor
+             * @param {flyteidl.admin.IToleration=} [properties] Properties to set
+             */
+            function Toleration(properties) {
+                this.selectors = [];
+                if (properties)
+                    for (let keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                        if (properties[keys[i]] != null)
+                            this[keys[i]] = properties[keys[i]];
+            }
+
+            /**
+             * Toleration selectors.
+             * @member {Array.<flyteidl.admin.ISelector>} selectors
+             * @memberof flyteidl.admin.Toleration
+             * @instance
+             */
+            Toleration.prototype.selectors = $util.emptyArray;
+
+            /**
+             * Creates a new Toleration instance using the specified properties.
+             * @function create
+             * @memberof flyteidl.admin.Toleration
+             * @static
+             * @param {flyteidl.admin.IToleration=} [properties] Properties to set
+             * @returns {flyteidl.admin.Toleration} Toleration instance
+             */
+            Toleration.create = function create(properties) {
+                return new Toleration(properties);
+            };
+
+            /**
+             * Encodes the specified Toleration message. Does not implicitly {@link flyteidl.admin.Toleration.verify|verify} messages.
+             * @function encode
+             * @memberof flyteidl.admin.Toleration
+             * @static
+             * @param {flyteidl.admin.IToleration} message Toleration message or plain object to encode
+             * @param {$protobuf.Writer} [writer] Writer to encode to
+             * @returns {$protobuf.Writer} Writer
+             */
+            Toleration.encode = function encode(message, writer) {
+                if (!writer)
+                    writer = $Writer.create();
+                if (message.selectors != null && message.selectors.length)
+                    for (let i = 0; i < message.selectors.length; ++i)
+                        $root.flyteidl.admin.Selector.encode(message.selectors[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
+                return writer;
+            };
+
+            /**
+             * Decodes a Toleration message from the specified reader or buffer.
+             * @function decode
+             * @memberof flyteidl.admin.Toleration
+             * @static
+             * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+             * @param {number} [length] Message length if known beforehand
+             * @returns {flyteidl.admin.Toleration} Toleration
+             * @throws {Error} If the payload is not a reader or valid buffer
+             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+             */
+            Toleration.decode = function decode(reader, length) {
+                if (!(reader instanceof $Reader))
+                    reader = $Reader.create(reader);
+                let end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.Toleration();
+                while (reader.pos < end) {
+                    let tag = reader.uint32();
+                    switch (tag >>> 3) {
+                    case 1:
+                        if (!(message.selectors && message.selectors.length))
+                            message.selectors = [];
+                        message.selectors.push($root.flyteidl.admin.Selector.decode(reader, reader.uint32()));
+                        break;
+                    default:
+                        reader.skipType(tag & 7);
+                        break;
+                    }
+                }
+                return message;
+            };
+
+            /**
+             * Verifies a Toleration message.
+             * @function verify
+             * @memberof flyteidl.admin.Toleration
+             * @static
+             * @param {Object.<string,*>} message Plain object to verify
+             * @returns {string|null} `null` if valid, otherwise the reason why it is not
+             */
+            Toleration.verify = function verify(message) {
+                if (typeof message !== "object" || message === null)
+                    return "object expected";
+                if (message.selectors != null && message.hasOwnProperty("selectors")) {
+                    if (!Array.isArray(message.selectors))
+                        return "selectors: array expected";
+                    for (let i = 0; i < message.selectors.length; ++i) {
+                        let error = $root.flyteidl.admin.Selector.verify(message.selectors[i]);
+                        if (error)
+                            return "selectors." + error;
+                    }
+                }
+                return null;
+            };
+
+            return Toleration;
+        })();
+
         admin.Selector = (function() {
 
             /**

package/package.json

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