From 845a6f2fc2e000026d22cae20ca69c9a64eafb77 Mon Sep 17 00:00:00 2001 From: Prafulla Mahindrakar Date: Thu, 29 Aug 2024 17:52:40 -0700 Subject: [PATCH] Using new offloaded metadata literal message for literal offloading (#5705) --- flyteidl/gen/pb-es/flyteidl/core/literals_pb.ts | 5 +++-- flyteidl/gen/pb-go/flyteidl/core/literals.pb.go | 5 +++-- .../flyteidl/cacheservice/cacheservice.swagger.json | 6 +++--- .../flyteidl/datacatalog/datacatalog.swagger.json | 6 +++--- .../pb-go/gateway/flyteidl/service/admin.swagger.json | 6 +++--- .../pb-go/gateway/flyteidl/service/agent.swagger.json | 6 +++--- .../gateway/flyteidl/service/dataproxy.swagger.json | 6 +++--- .../service/external_plugin_service.swagger.json | 6 +++--- .../pb-go/gateway/flyteidl/service/signal.swagger.json | 6 +++--- flyteidl/gen/pb_rust/flyteidl.core.rs | 5 +++-- flyteidl/protos/flyteidl/core/literals.proto | 9 ++++----- 11 files changed, 34 insertions(+), 32 deletions(-) diff --git a/flyteidl/gen/pb-es/flyteidl/core/literals_pb.ts b/flyteidl/gen/pb-es/flyteidl/core/literals_pb.ts index 261b9332e53..95ebbd9de91 100644 --- a/flyteidl/gen/pb-es/flyteidl/core/literals_pb.ts +++ b/flyteidl/gen/pb-es/flyteidl/core/literals_pb.ts @@ -569,6 +569,7 @@ export class Literal extends Message { } | { /** * Offloaded literal metadata + * When you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata. * * @generated from field: flyteidl.core.LiteralOffloadedMetadata offloaded_metadata = 8; */ @@ -632,7 +633,7 @@ export class Literal extends Message { */ export class LiteralOffloadedMetadata extends Message { /** - * The location of the offloaded data. + * The location of the offloaded core.Literal. * * @generated from field: string uri = 1; */ @@ -646,7 +647,7 @@ export class LiteralOffloadedMetadata extends Message sizeBytes = protoInt64.zero; /** - * The literal type of the offloaded data. + * The inferred literal type of the offloaded data. * * @generated from field: flyteidl.core.LiteralType inferred_type = 3; */ diff --git a/flyteidl/gen/pb-go/flyteidl/core/literals.pb.go b/flyteidl/gen/pb-go/flyteidl/core/literals.pb.go index 1f54e269f11..3f6e2237498 100644 --- a/flyteidl/gen/pb-go/flyteidl/core/literals.pb.go +++ b/flyteidl/gen/pb-go/flyteidl/core/literals.pb.go @@ -890,6 +890,7 @@ type Literal_Map struct { type Literal_OffloadedMetadata struct { // Offloaded literal metadata + // When you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata. OffloadedMetadata *LiteralOffloadedMetadata `protobuf:"bytes,8,opt,name=offloaded_metadata,json=offloadedMetadata,proto3,oneof"` } @@ -907,11 +908,11 @@ type LiteralOffloadedMetadata struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // The location of the offloaded data. + // The location of the offloaded core.Literal. Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"` // The size of the offloaded data. SizeBytes uint64 `protobuf:"varint,2,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"` - // The literal type of the offloaded data. + // The inferred literal type of the offloaded data. InferredType *LiteralType `protobuf:"bytes,3,opt,name=inferred_type,json=inferredType,proto3" json:"inferred_type,omitempty"` } diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/cacheservice/cacheservice.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/cacheservice/cacheservice.swagger.json index e26d2e8aa80..c30c350754a 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/cacheservice/cacheservice.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/cacheservice/cacheservice.swagger.json @@ -219,7 +219,7 @@ }, "offloaded_metadata": { "$ref": "#/definitions/coreLiteralOffloadedMetadata", - "title": "Offloaded literal metadata" + "description": "Offloaded literal metadata\nWhen you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata." }, "hash": { "type": "string", @@ -265,7 +265,7 @@ "properties": { "uri": { "type": "string", - "description": "The location of the offloaded data." + "description": "The location of the offloaded core.Literal." }, "size_bytes": { "type": "string", @@ -274,7 +274,7 @@ }, "inferred_type": { "$ref": "#/definitions/coreLiteralType", - "description": "The literal type of the offloaded data." + "description": "The inferred literal type of the offloaded data." } }, "description": "A message that contains the metadata of the offloaded data." diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/datacatalog/datacatalog.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/datacatalog/datacatalog.swagger.json index 54f5bee0773..dbfcc5b85ef 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/datacatalog/datacatalog.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/datacatalog/datacatalog.swagger.json @@ -163,7 +163,7 @@ }, "offloaded_metadata": { "$ref": "#/definitions/coreLiteralOffloadedMetadata", - "title": "Offloaded literal metadata" + "description": "Offloaded literal metadata\nWhen you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata." }, "hash": { "type": "string", @@ -209,7 +209,7 @@ "properties": { "uri": { "type": "string", - "description": "The location of the offloaded data." + "description": "The location of the offloaded core.Literal." }, "size_bytes": { "type": "string", @@ -218,7 +218,7 @@ }, "inferred_type": { "$ref": "#/definitions/coreLiteralType", - "description": "The literal type of the offloaded data." + "description": "The inferred literal type of the offloaded data." } }, "description": "A message that contains the metadata of the offloaded data." diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json index b2e3e81c5d3..ef81380d1ea 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json @@ -7420,7 +7420,7 @@ }, "offloaded_metadata": { "$ref": "#/definitions/coreLiteralOffloadedMetadata", - "title": "Offloaded literal metadata" + "description": "Offloaded literal metadata\nWhen you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata." }, "hash": { "type": "string", @@ -7466,7 +7466,7 @@ "properties": { "uri": { "type": "string", - "description": "The location of the offloaded data." + "description": "The location of the offloaded core.Literal." }, "size_bytes": { "type": "string", @@ -7475,7 +7475,7 @@ }, "inferred_type": { "$ref": "#/definitions/coreLiteralType", - "description": "The literal type of the offloaded data." + "description": "The inferred literal type of the offloaded data." } }, "description": "A message that contains the metadata of the offloaded data." diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/service/agent.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/service/agent.swagger.json index 3a2ea82dc47..373b9c4c3d6 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/service/agent.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/service/agent.swagger.json @@ -1257,7 +1257,7 @@ }, "offloaded_metadata": { "$ref": "#/definitions/coreLiteralOffloadedMetadata", - "title": "Offloaded literal metadata" + "description": "Offloaded literal metadata\nWhen you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata." }, "hash": { "type": "string", @@ -1303,7 +1303,7 @@ "properties": { "uri": { "type": "string", - "description": "The location of the offloaded data." + "description": "The location of the offloaded core.Literal." }, "size_bytes": { "type": "string", @@ -1312,7 +1312,7 @@ }, "inferred_type": { "$ref": "#/definitions/coreLiteralType", - "description": "The literal type of the offloaded data." + "description": "The inferred literal type of the offloaded data." } }, "description": "A message that contains the metadata of the offloaded data." diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/service/dataproxy.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/service/dataproxy.swagger.json index 6a5a0c94e84..bff6ca737a3 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/service/dataproxy.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/service/dataproxy.swagger.json @@ -279,7 +279,7 @@ }, "offloaded_metadata": { "$ref": "#/definitions/coreLiteralOffloadedMetadata", - "title": "Offloaded literal metadata" + "description": "Offloaded literal metadata\nWhen you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata." }, "hash": { "type": "string", @@ -325,7 +325,7 @@ "properties": { "uri": { "type": "string", - "description": "The location of the offloaded data." + "description": "The location of the offloaded core.Literal." }, "size_bytes": { "type": "string", @@ -334,7 +334,7 @@ }, "inferred_type": { "$ref": "#/definitions/coreLiteralType", - "description": "The literal type of the offloaded data." + "description": "The inferred literal type of the offloaded data." } }, "description": "A message that contains the metadata of the offloaded data." diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/service/external_plugin_service.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/service/external_plugin_service.swagger.json index 5bfa2d50e4c..029c42ffd3e 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/service/external_plugin_service.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/service/external_plugin_service.swagger.json @@ -573,7 +573,7 @@ }, "offloaded_metadata": { "$ref": "#/definitions/coreLiteralOffloadedMetadata", - "title": "Offloaded literal metadata" + "description": "Offloaded literal metadata\nWhen you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata." }, "hash": { "type": "string", @@ -619,7 +619,7 @@ "properties": { "uri": { "type": "string", - "description": "The location of the offloaded data." + "description": "The location of the offloaded core.Literal." }, "size_bytes": { "type": "string", @@ -628,7 +628,7 @@ }, "inferred_type": { "$ref": "#/definitions/coreLiteralType", - "description": "The literal type of the offloaded data." + "description": "The inferred literal type of the offloaded data." } }, "description": "A message that contains the metadata of the offloaded data." diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/service/signal.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/service/signal.swagger.json index f1387060aeb..d325ed47640 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/service/signal.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/service/signal.swagger.json @@ -355,7 +355,7 @@ }, "offloaded_metadata": { "$ref": "#/definitions/coreLiteralOffloadedMetadata", - "title": "Offloaded literal metadata" + "description": "Offloaded literal metadata\nWhen you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata." }, "hash": { "type": "string", @@ -401,7 +401,7 @@ "properties": { "uri": { "type": "string", - "description": "The location of the offloaded data." + "description": "The location of the offloaded core.Literal." }, "size_bytes": { "type": "string", @@ -410,7 +410,7 @@ }, "inferred_type": { "$ref": "#/definitions/coreLiteralType", - "description": "The literal type of the offloaded data." + "description": "The inferred literal type of the offloaded data." } }, "description": "A message that contains the metadata of the offloaded data." diff --git a/flyteidl/gen/pb_rust/flyteidl.core.rs b/flyteidl/gen/pb_rust/flyteidl.core.rs index 2b7731d8001..441609be89b 100644 --- a/flyteidl/gen/pb_rust/flyteidl.core.rs +++ b/flyteidl/gen/pb_rust/flyteidl.core.rs @@ -507,6 +507,7 @@ pub mod literal { #[prost(message, tag="3")] Map(super::LiteralMap), /// Offloaded literal metadata + /// When you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata. #[prost(message, tag="8")] OffloadedMetadata(super::LiteralOffloadedMetadata), } @@ -515,13 +516,13 @@ pub mod literal { #[allow(clippy::derive_partial_eq_without_eq)] #[derive(Clone, PartialEq, ::prost::Message)] pub struct LiteralOffloadedMetadata { - /// The location of the offloaded data. + /// The location of the offloaded core.Literal. #[prost(string, tag="1")] pub uri: ::prost::alloc::string::String, /// The size of the offloaded data. #[prost(uint64, tag="2")] pub size_bytes: u64, - /// The literal type of the offloaded data. + /// The inferred literal type of the offloaded data. #[prost(message, optional, tag="3")] pub inferred_type: ::core::option::Option, } diff --git a/flyteidl/protos/flyteidl/core/literals.proto b/flyteidl/protos/flyteidl/core/literals.proto index 81f9edaa203..1eb004482cb 100644 --- a/flyteidl/protos/flyteidl/core/literals.proto +++ b/flyteidl/protos/flyteidl/core/literals.proto @@ -93,7 +93,7 @@ message Scalar { // A simple value. This supports any level of nesting (e.g. array of array of array of Blobs) as well as simple primitives. message Literal { - reserved 6,7; + reserved 6, 7; oneof value { // A simple value. Scalar scalar = 1; @@ -105,6 +105,7 @@ message Literal { LiteralMap map = 3; // Offloaded literal metadata + // When you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata. LiteralOffloadedMetadata offloaded_metadata = 8; } @@ -115,19 +116,17 @@ message Literal { // Additional metadata for literals. map metadata = 5; - - } // A message that contains the metadata of the offloaded data. message LiteralOffloadedMetadata { - // The location of the offloaded data. + // The location of the offloaded core.Literal. string uri = 1; // The size of the offloaded data. uint64 size_bytes = 2; - // The literal type of the offloaded data. + // The inferred literal type of the offloaded data. LiteralType inferred_type = 3; }