@flyteorg/flyteidl 1.11.0-b1 → 1.11.1-b0

package/README.md

@@ -7,7 +7,7 @@ This is one of the core repositories of Flyte. It contains the Specification of
 
 * [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/en/latest/reference_flyteidl.html)
 
 ## Contributing to Flyteidl
 

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

@@ -17812,6 +17812,58 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
+        /** Properties of a ProjectGetRequest. */
+        interface IProjectGetRequest {
+
+            /** ProjectGetRequest id */
+            id?: (string|null);
+        }
+
+        /** Represents a ProjectGetRequest. */
+        class ProjectGetRequest implements IProjectGetRequest {
+
+            /**
+             * Constructs a new ProjectGetRequest.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: flyteidl.admin.IProjectGetRequest);
+
+            /** ProjectGetRequest id. */
+            public id: string;
+
+            /**
+             * Creates a new ProjectGetRequest instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns ProjectGetRequest instance
+             */
+            public static create(properties?: flyteidl.admin.IProjectGetRequest): flyteidl.admin.ProjectGetRequest;
+
+            /**
+             * Encodes the specified ProjectGetRequest message. Does not implicitly {@link flyteidl.admin.ProjectGetRequest.verify|verify} messages.
+             * @param message ProjectGetRequest message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: flyteidl.admin.IProjectGetRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes a ProjectGetRequest message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns ProjectGetRequest
+             * @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.ProjectGetRequest;
+
+            /**
+             * Verifies a ProjectGetRequest 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 ProjectAttributes. */
         interface IProjectAttributes {
 
@@ -21432,6 +21484,20 @@ export namespace flyteidl {
              */
             public updateProject(request: flyteidl.admin.IProject): Promise<flyteidl.admin.ProjectUpdateResponse>;
 
+            /**
+             * Calls GetProject.
+             * @param request ProjectGetRequest message or plain object
+             * @param callback Node-style callback called with the error, if any, and Project
+             */
+            public getProject(request: flyteidl.admin.IProjectGetRequest, callback: flyteidl.service.AdminService.GetProjectCallback): void;
+
+            /**
+             * Calls GetProject.
+             * @param request ProjectGetRequest message or plain object
+             * @returns Promise
+             */
+            public getProject(request: flyteidl.admin.IProjectGetRequest): Promise<flyteidl.admin.Project>;
+
             /**
              * Calls ListProjects.
              * @param request ProjectListRequest message or plain object
@@ -21981,6 +22047,13 @@ export namespace flyteidl {
              */
             type UpdateProjectCallback = (error: (Error|null), response?: flyteidl.admin.ProjectUpdateResponse) => void;
 
+            /**
+             * Callback as used by {@link flyteidl.service.AdminService#getProject}.
+             * @param error Error, if any
+             * @param [response] Project
+             */
+            type GetProjectCallback = (error: (Error|null), response?: flyteidl.admin.Project) => void;
+
             /**
              * Callback as used by {@link flyteidl.service.AdminService#listProjects}.
              * @param error Error, if any
@@ -22747,6 +22820,9 @@ export namespace flyteidl {
 
             /** CreateUploadLocationResponse expiresAt */
             expiresAt?: (google.protobuf.ITimestamp|null);
+
+            /** CreateUploadLocationResponse headers */
+            headers?: ({ [k: string]: string }|null);
         }
 
         /** Represents a CreateUploadLocationResponse. */
@@ -22767,6 +22843,9 @@ export namespace flyteidl {
             /** CreateUploadLocationResponse expiresAt. */
             public expiresAt?: (google.protobuf.ITimestamp|null);
 
+            /** CreateUploadLocationResponse headers. */
+            public headers: { [k: string]: string };
+
             /**
              * Creates a new CreateUploadLocationResponse instance using the specified properties.
              * @param [properties] Properties to set
@@ -22820,6 +22899,12 @@ export namespace flyteidl {
 
             /** CreateUploadLocationRequest filenameRoot */
             filenameRoot?: (string|null);
+
+            /** CreateUploadLocationRequest addContentMd5Metadata */
+            addContentMd5Metadata?: (boolean|null);
+
+            /** CreateUploadLocationRequest org */
+            org?: (string|null);
         }
 
         /** Represents a CreateUploadLocationRequest. */
@@ -22849,6 +22934,12 @@ export namespace flyteidl {
             /** CreateUploadLocationRequest filenameRoot. */
             public filenameRoot: string;
 
+            /** CreateUploadLocationRequest addContentMd5Metadata. */
+            public addContentMd5Metadata: boolean;
+
+            /** CreateUploadLocationRequest org. */
+            public org: string;
+
             /**
              * Creates a new CreateUploadLocationRequest instance using the specified properties.
              * @param [properties] Properties to set

package/gen/pb-js/flyteidl.js

@@ -43012,6 +43012,116 @@
                 return ProjectUpdateResponse;
             })();
     
+            admin.ProjectGetRequest = (function() {
+    
+                /**
+                 * Properties of a ProjectGetRequest.
+                 * @memberof flyteidl.admin
+                 * @interface IProjectGetRequest
+                 * @property {string|null} [id] ProjectGetRequest id
+                 */
+    
+                /**
+                 * Constructs a new ProjectGetRequest.
+                 * @memberof flyteidl.admin
+                 * @classdesc Represents a ProjectGetRequest.
+                 * @implements IProjectGetRequest
+                 * @constructor
+                 * @param {flyteidl.admin.IProjectGetRequest=} [properties] Properties to set
+                 */
+                function ProjectGetRequest(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]];
+                }
+    
+                /**
+                 * ProjectGetRequest id.
+                 * @member {string} id
+                 * @memberof flyteidl.admin.ProjectGetRequest
+                 * @instance
+                 */
+                ProjectGetRequest.prototype.id = "";
+    
+                /**
+                 * Creates a new ProjectGetRequest instance using the specified properties.
+                 * @function create
+                 * @memberof flyteidl.admin.ProjectGetRequest
+                 * @static
+                 * @param {flyteidl.admin.IProjectGetRequest=} [properties] Properties to set
+                 * @returns {flyteidl.admin.ProjectGetRequest} ProjectGetRequest instance
+                 */
+                ProjectGetRequest.create = function create(properties) {
+                    return new ProjectGetRequest(properties);
+                };
+    
+                /**
+                 * Encodes the specified ProjectGetRequest message. Does not implicitly {@link flyteidl.admin.ProjectGetRequest.verify|verify} messages.
+                 * @function encode
+                 * @memberof flyteidl.admin.ProjectGetRequest
+                 * @static
+                 * @param {flyteidl.admin.IProjectGetRequest} message ProjectGetRequest message or plain object to encode
+                 * @param {$protobuf.Writer} [writer] Writer to encode to
+                 * @returns {$protobuf.Writer} Writer
+                 */
+                ProjectGetRequest.encode = function encode(message, writer) {
+                    if (!writer)
+                        writer = $Writer.create();
+                    if (message.id != null && message.hasOwnProperty("id"))
+                        writer.uint32(/* id 1, wireType 2 =*/10).string(message.id);
+                    return writer;
+                };
+    
+                /**
+                 * Decodes a ProjectGetRequest message from the specified reader or buffer.
+                 * @function decode
+                 * @memberof flyteidl.admin.ProjectGetRequest
+                 * @static
+                 * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                 * @param {number} [length] Message length if known beforehand
+                 * @returns {flyteidl.admin.ProjectGetRequest} ProjectGetRequest
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                ProjectGetRequest.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.ProjectGetRequest();
+                    while (reader.pos < end) {
+                        var tag = reader.uint32();
+                        switch (tag >>> 3) {
+                        case 1:
+                            message.id = reader.string();
+                            break;
+                        default:
+                            reader.skipType(tag & 7);
+                            break;
+                        }
+                    }
+                    return message;
+                };
+    
+                /**
+                 * Verifies a ProjectGetRequest message.
+                 * @function verify
+                 * @memberof flyteidl.admin.ProjectGetRequest
+                 * @static
+                 * @param {Object.<string,*>} message Plain object to verify
+                 * @returns {string|null} `null` if valid, otherwise the reason why it is not
+                 */
+                ProjectGetRequest.verify = function verify(message) {
+                    if (typeof message !== "object" || message === null)
+                        return "object expected";
+                    if (message.id != null && message.hasOwnProperty("id"))
+                        if (!$util.isString(message.id))
+                            return "id: string expected";
+                    return null;
+                };
+    
+                return ProjectGetRequest;
+            })();
+    
             admin.ProjectAttributes = (function() {
     
                 /**
@@ -51364,6 +51474,39 @@
                  * @variation 2
                  */
     
+                /**
+                 * Callback as used by {@link flyteidl.service.AdminService#getProject}.
+                 * @memberof flyteidl.service.AdminService
+                 * @typedef GetProjectCallback
+                 * @type {function}
+                 * @param {Error|null} error Error, if any
+                 * @param {flyteidl.admin.Project} [response] Project
+                 */
+    
+                /**
+                 * Calls GetProject.
+                 * @function getProject
+                 * @memberof flyteidl.service.AdminService
+                 * @instance
+                 * @param {flyteidl.admin.IProjectGetRequest} request ProjectGetRequest message or plain object
+                 * @param {flyteidl.service.AdminService.GetProjectCallback} callback Node-style callback called with the error, if any, and Project
+                 * @returns {undefined}
+                 * @variation 1
+                 */
+                Object.defineProperty(AdminService.prototype.getProject = function getProject(request, callback) {
+                    return this.rpcCall(getProject, $root.flyteidl.admin.ProjectGetRequest, $root.flyteidl.admin.Project, request, callback);
+                }, "name", { value: "GetProject" });
+    
+                /**
+                 * Calls GetProject.
+                 * @function getProject
+                 * @memberof flyteidl.service.AdminService
+                 * @instance
+                 * @param {flyteidl.admin.IProjectGetRequest} request ProjectGetRequest message or plain object
+                 * @returns {Promise<flyteidl.admin.Project>} Promise
+                 * @variation 2
+                 */
+    
                 /**
                  * Callback as used by {@link flyteidl.service.AdminService#listProjects}.
                  * @memberof flyteidl.service.AdminService
@@ -53330,6 +53473,7 @@
                  * @property {string|null} [signedUrl] CreateUploadLocationResponse signedUrl
                  * @property {string|null} [nativeUrl] CreateUploadLocationResponse nativeUrl
                  * @property {google.protobuf.ITimestamp|null} [expiresAt] CreateUploadLocationResponse expiresAt
+                 * @property {Object.<string,string>|null} [headers] CreateUploadLocationResponse headers
                  */
     
                 /**
@@ -53341,6 +53485,7 @@
                  * @param {flyteidl.service.ICreateUploadLocationResponse=} [properties] Properties to set
                  */
                 function CreateUploadLocationResponse(properties) {
+                    this.headers = {};
                     if (properties)
                         for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
                             if (properties[keys[i]] != null)
@@ -53371,6 +53516,14 @@
                  */
                 CreateUploadLocationResponse.prototype.expiresAt = null;
     
+                /**
+                 * CreateUploadLocationResponse headers.
+                 * @member {Object.<string,string>} headers
+                 * @memberof flyteidl.service.CreateUploadLocationResponse
+                 * @instance
+                 */
+                CreateUploadLocationResponse.prototype.headers = $util.emptyObject;
+    
                 /**
                  * Creates a new CreateUploadLocationResponse instance using the specified properties.
                  * @function create
@@ -53401,6 +53554,9 @@
                         writer.uint32(/* id 2, wireType 2 =*/18).string(message.nativeUrl);
                     if (message.expiresAt != null && message.hasOwnProperty("expiresAt"))
                         $root.google.protobuf.Timestamp.encode(message.expiresAt, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
+                    if (message.headers != null && message.hasOwnProperty("headers"))
+                        for (var keys = Object.keys(message.headers), 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.headers[keys[i]]).ldelim();
                     return writer;
                 };
     
@@ -53418,7 +53574,7 @@
                 CreateUploadLocationResponse.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.service.CreateUploadLocationResponse();
+                    var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.service.CreateUploadLocationResponse(), key;
                     while (reader.pos < end) {
                         var tag = reader.uint32();
                         switch (tag >>> 3) {
@@ -53431,6 +53587,14 @@
                         case 3:
                             message.expiresAt = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
                             break;
+                        case 4:
+                            reader.skip().pos++;
+                            if (message.headers === $util.emptyObject)
+                                message.headers = {};
+                            key = reader.string();
+                            reader.pos++;
+                            message.headers[key] = reader.string();
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -53461,6 +53625,14 @@
                         if (error)
                             return "expiresAt." + error;
                     }
+                    if (message.headers != null && message.hasOwnProperty("headers")) {
+                        if (!$util.isObject(message.headers))
+                            return "headers: object expected";
+                        var key = Object.keys(message.headers);
+                        for (var i = 0; i < key.length; ++i)
+                            if (!$util.isString(message.headers[key[i]]))
+                                return "headers: string{k:string} expected";
+                    }
                     return null;
                 };
     
@@ -53479,6 +53651,8 @@
                  * @property {google.protobuf.IDuration|null} [expiresIn] CreateUploadLocationRequest expiresIn
                  * @property {Uint8Array|null} [contentMd5] CreateUploadLocationRequest contentMd5
                  * @property {string|null} [filenameRoot] CreateUploadLocationRequest filenameRoot
+                 * @property {boolean|null} [addContentMd5Metadata] CreateUploadLocationRequest addContentMd5Metadata
+                 * @property {string|null} [org] CreateUploadLocationRequest org
                  */
     
                 /**
@@ -53544,6 +53718,22 @@
                  */
                 CreateUploadLocationRequest.prototype.filenameRoot = "";
     
+                /**
+                 * CreateUploadLocationRequest addContentMd5Metadata.
+                 * @member {boolean} addContentMd5Metadata
+                 * @memberof flyteidl.service.CreateUploadLocationRequest
+                 * @instance
+                 */
+                CreateUploadLocationRequest.prototype.addContentMd5Metadata = false;
+    
+                /**
+                 * CreateUploadLocationRequest org.
+                 * @member {string} org
+                 * @memberof flyteidl.service.CreateUploadLocationRequest
+                 * @instance
+                 */
+                CreateUploadLocationRequest.prototype.org = "";
+    
                 /**
                  * Creates a new CreateUploadLocationRequest instance using the specified properties.
                  * @function create
@@ -53580,6 +53770,10 @@
                         writer.uint32(/* id 5, wireType 2 =*/42).bytes(message.contentMd5);
                     if (message.filenameRoot != null && message.hasOwnProperty("filenameRoot"))
                         writer.uint32(/* id 6, wireType 2 =*/50).string(message.filenameRoot);
+                    if (message.addContentMd5Metadata != null && message.hasOwnProperty("addContentMd5Metadata"))
+                        writer.uint32(/* id 7, wireType 0 =*/56).bool(message.addContentMd5Metadata);
+                    if (message.org != null && message.hasOwnProperty("org"))
+                        writer.uint32(/* id 8, wireType 2 =*/66).string(message.org);
                     return writer;
                 };
     
@@ -53619,6 +53813,12 @@
                         case 6:
                             message.filenameRoot = reader.string();
                             break;
+                        case 7:
+                            message.addContentMd5Metadata = reader.bool();
+                            break;
+                        case 8:
+                            message.org = reader.string();
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -53658,6 +53858,12 @@
                     if (message.filenameRoot != null && message.hasOwnProperty("filenameRoot"))
                         if (!$util.isString(message.filenameRoot))
                             return "filenameRoot: string expected";
+                    if (message.addContentMd5Metadata != null && message.hasOwnProperty("addContentMd5Metadata"))
+                        if (typeof message.addContentMd5Metadata !== "boolean")
+                            return "addContentMd5Metadata: boolean expected";
+                    if (message.org != null && message.hasOwnProperty("org"))
+                        if (!$util.isString(message.org))
+                            return "org: string expected";
                     return null;
                 };
     

package/package.json

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

package/protos/docs/core/core.rst

@@ -2206,7 +2206,7 @@ Sql represents a generic sql workload with a statement and dialect.
    :header: "Field", "Type", "Label", "Description"
    :widths: auto
 
-   "statement", ":ref:`ref_string`", "", "The actual query to run, the query can have templated parameters. We use Flyte's Golang templating format for Query templating. Refer to the templating documentation. https://docs.flyte.org/projects/cookbook/en/latest/auto/integrations/external_services/hive/hive.html#sphx-glr-auto-integrations-external-services-hive-hive-py For example, insert overwrite directory '{{ .rawOutputDataPrefix }}' stored as parquet select * from my_table where ds = '{{ .Inputs.ds }}'"
+   "statement", ":ref:`ref_string`", "", "The actual query to run, the query can have templated parameters. We use Flyte's Golang templating format for Query templating. For example, insert overwrite directory '{{ .rawOutputDataPrefix }}' stored as parquet select * from my_table where ds = '{{ .Inputs.ds }}'"
    "dialect", ":ref:`ref_flyteidl.core.Sql.Dialect`", "", ""
 
 

package/protos/flyteidl/admin/project.proto

@@ -99,3 +99,9 @@ message ProjectRegisterResponse {
 // Purposefully empty, may be updated in the future.
 message ProjectUpdateResponse {
 }
+
+message ProjectGetRequest {
+    // Indicates a unique project.
+    // +required
+    string id = 1;
+}

package/protos/flyteidl/core/tasks.proto

@@ -332,8 +332,6 @@ message K8sObjectMetadata {
 message Sql {
     // The actual query to run, the query can have templated parameters.
     // We use Flyte's Golang templating format for Query templating.
-    // Refer to the templating documentation.
-    // https://docs.flyte.org/projects/cookbook/en/latest/auto/integrations/external_services/hive/hive.html#sphx-glr-auto-integrations-external-services-hive-hive-py
     // For example,
     // insert overwrite directory '{{ .rawOutputDataPrefix }}' stored as parquet
     // select *

package/protos/flyteidl/service/admin.proto

@@ -395,6 +395,16 @@ service AdminService {
     };
   }
 
+  // Fetches a :ref:`ref_flyteidl.admin.Project`
+  rpc GetProject (flyteidl.admin.ProjectGetRequest) returns (flyteidl.admin.Project) {
+    option (google.api.http) = {
+      get: "/api/v1/projects/{id}"
+    };
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      description: "Fetch a registered project."
+    };
+  }
+
   // Fetches a list of :ref:`ref_flyteidl.admin.Project`
   rpc ListProjects (flyteidl.admin.ProjectListRequest) returns (flyteidl.admin.Projects) {
     option (google.api.http) = {

package/protos/flyteidl/service/dataproxy.proto

@@ -20,6 +20,9 @@ message CreateUploadLocationResponse {
 
   // ExpiresAt defines when will the signed URL expires.
   google.protobuf.Timestamp expires_at = 3;
+
+  // Data proxy generates these headers for client, and they have to add these headers to the request when uploading the file.
+  map<string, string> headers = 4;
 }
 
 // CreateUploadLocationRequest specified request for the CreateUploadLocation API.
@@ -55,6 +58,15 @@ message CreateUploadLocationRequest {
   // in data proxy config. This option is useful when uploading multiple files.
   // +optional
   string filename_root = 6;
+
+  // If true, the data proxy will add content_md5 to the metadata to the signed URL and
+  // it will force clients to add this metadata to the object.
+  // This make sure dataproxy is backward compatible with the old flytekit.
+  bool add_content_md5_metadata = 7;
+
+
+  // Optional, org key applied to the resource.
+  string org = 8;
 }
 
 // CreateDownloadLocationRequest specified request for the CreateDownloadLocation API.
@@ -67,7 +79,6 @@ message CreateDownloadLocationRequest {
   // exceeds the platform allowed max.
   // +optional. The default value comes from a global config.
   google.protobuf.Duration expires_in = 2;
-
 }
 
 message CreateDownloadLocationResponse {